StretchTransform Class Reference

#include <StretchTransform.h>

Inheritance diagram for StretchTransform:

Collaboration diagram for StretchTransform:

Public Member Functions
	StretchTransform ()
void	setMapping (Mapping &map)
StretchedSquare &	getStretchedSquare ()
void	reinitialize ()
	StretchTransform (const StretchTransform &, const CopyType copyType=DEEP)
	~StretchTransform ()
StretchTransform &	operator= (const StretchTransform &X)
virtual int	get (const GenericDataBase &dir, const aString &name)
virtual int	put (GenericDataBase &dir, const aString &name) const
Mapping *	make (const aString &mappingClassName)
aString	getClassName () const
int	update (MappingInformation &mapInfo)
int	update (MappingInformation &mapInfo, const aString &command, DialogData *interface=NULL)
int	applyStretching (int stretchingType[3], IntegerArray *ipar, RealArray *rpar)
int	updateStretchingParameters (aString &answer, IntegerArray *ipar, RealArray *rpar, int stretchingType[3], int numberOfMultigridLevels, real stretchResolutionFactor, DialogData *stretchParametersDialog[3], DialogData &dialog, MappingInformation &mapInfo)
int	buildStretchingParametersDialog (DialogData &dialog, const StretchMapping::StretchingType stretchType, const int direction)
int	resizeParameterArrays (int stretchID, IntegerArray &ipar, RealArray &rpar)
Public Member Functions inherited from ComposeMapping
	ComposeMapping ()
	ComposeMapping (Mapping &mapa, Mapping &mapb)
void	setMappings (Mapping &mapa, Mapping &mapb)
	ComposeMapping (const ComposeMapping &, const CopyType copyType=DEEP)
	~ComposeMapping ()
ComposeMapping &	operator= (const ComposeMapping &X)
const realArray &	getGrid (MappingParameters &params=Overture::nullMappingParameters(), bool includeGhost=false)
virtual void	useRobustInverse (const bool trueOrFalse=TRUE)
void	map (const realArray &r, realArray &x, realArray &xr=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
void	inverseMap (const realArray &x, realArray &r, realArray &rx=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
void	basicInverse (const realArray &x, realArray &r, realArray &rx=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
void	mapS (const RealArray &r, RealArray &x, RealArray &xr=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
void	inverseMapS (const RealArray &x, RealArray &r, RealArray &rx=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
void	basicInverseS (const RealArray &x, RealArray &r, RealArray &rx=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
int	useDefaultMappingInverse (bool trueOrFalse=TRUE)
virtual real	sizeOf (FILE *file=NULL) const
Public Member Functions inherited from Mapping
	Mapping (int domainDimension=3, int rangeDimension=3, mappingSpace domainSpace=parameterSpace, mappingSpace rangeSpace=cartesianSpace, coordinateSystem domainCoordinateSystem=cartesian, coordinateSystem rangeCoordinateSystem=cartesian)
	Mapping (const Mapping &, const CopyType copyType=DEEP)
Mapping &	operator= (const Mapping &X)
virtual	~Mapping ()
void	reference (const Mapping &map)
void	breakReference ()
virtual void	mapC (const realArray &r, const realArray &x, const realArray &xr=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	inverseMapC (const realArray &x, const realArray &r, const realArray &rx=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	mapGrid (const realArray &r, realArray &x, realArray &xr=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual int	intersects (Mapping &map2, const int &side1=-1, const int &axis1=-1, const int &side2=-1, const int &axis2=-1, const real &tol=0.) const
virtual void	inverseMapGrid (const realArray &x, realArray &r, realArray &rx=Overture::nullRealDistributedArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	mapCS (const RealArray &r, const RealArray &x, const RealArray &xr=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	inverseMapCS (const RealArray &x, const RealArray &r, const RealArray &rx=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	mapGridS (const RealArray &r, RealArray &x, RealArray &xr=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual void	inverseMapGridS (const RealArray &x, RealArray &r, RealArray &rx=Overture::nullRealArray(), MappingParameters &params=Overture::nullMappingParameters())
virtual int	projectS (RealArray &x, MappingProjectionParameters &mpParams)
virtual bool	updateWithCommand (MappingInformation &mapInfo, const aString &command)
virtual int	interactiveUpdate (GenericGraphicsInterface &gi)
virtual int	project (realArray &x, MappingProjectionParameters &mpParams)
virtual void	display (const aString &label=blankString) const
int	checkMapping ()
void	reinitialize ()
int	determineResolution (int numberOfGridPoints[], bool collapsedEdge[2][3], real averageArclength[], real elementDensityTolerance=.05)
void	secondOrderDerivative (const Index &I, const realArray &r, realArray &xrr, const int axis, const int &rAxis)
int	findNearestGridPoint (RealArray &x, RealArray &r, RealArray &dista, RealArray &xa)
	Find the nearest grid point to each of a given set of points x(i,.)
real	getArcLength ()
basicInverseOptions	getBasicInverseOption () const
int	getBoundaryCondition (const int side, const int axis) const
virtual RealArray	getBoundingBox (const int &side=-1, const int &axis=-1) const
virtual int	getBoundingBox (const IntegerArray &indexRange, const IntegerArray &gridIndexRange, RealArray &xBounds, bool local=false) const
virtual int	getBoundingBox (const RealArray &rBounds, RealArray &xBounds) const
const BoundingBox &	getBoundingBoxTree (const int &side, const int &axis) const
int	getCoordinateEvaluationType (const coordinateSystem type) const
Bound	getDomainBound (const int side, const int axis) const
int	getDomainDimension () const
coordinateSystem	getDomainCoordinateSystem () const
Bound	getDomainCoordinateSystemBound (const int side, const int axis) const
mappingSpace	getDomainSpace () const
int	getGridDimensions (const int axis) const
virtual const RealArray &	getGridSerial (MappingParameters &params=Overture::nullMappingParameters(), bool includeGhost=false)
int	getID () const
int	getInvertible () const
periodicType	getIsPeriodic (const int axis) const
mappingCoordinateSystem	getMappingCoordinateSystem () const
aString	getName (const mappingItemName item) const
int	getGridIndexRange (int side, int axis)
int	getNumberOfGhostPoints (int side, int axis)
real	getParameter (const MappingParameters::realParameter &param) const
int	getParameter (const MappingParameters::intParameter &param) const
real	getPeriodVector (const int axis, const int direction) const
Bound	getRangeBound (const int side, const int axis) const
coordinateSystem	getRangeCoordinateSystem () const
Bound	getRangeCoordinateSystemBound (const int side, const int axis) const
int	getRangeDimension () const
mappingSpace	getRangeSpace () const
int	getShare (const int side, const int axis) const
real	getSignForJacobian () const
topologyEnum	getTopology (const int side, const int axis) const
coordinateSingularity	getTypeOfCoordinateSingularity (const int side, const int axis) const
bool	gridIsValid () const
int	hasACoordinateSingularity () const
intArray &	topologyMask ()
void	setArcLength (real length)
virtual void	setBasicInverseOption (const basicInverseOptions option)
virtual void	setBoundaryCondition (const int side, const int axis, const int bc)
virtual void	setCoordinateEvaluationType (const coordinateSystem type, const int trueOrFalse)
virtual void	setDomainBound (const int side, const int axis, const Bound domainBound)
virtual void	setDomainCoordinateSystem (const coordinateSystem domainCoordinateSystem)
virtual void	setDomainCoordinateSystemBound (const int side, const int axis, const Bound domainCoordinateSystemBound)
virtual void	setDomainDimension (const int domainDimension)
virtual void	setDomainSpace (const mappingSpace domainSpace)
virtual void	setGrid (realArray &grid, IntegerArray &gridIndexRange)
virtual void	setGridDimensions (const int axis, const int dim)
virtual void	setInvertible (const int invertible)
void	setID ()
virtual void	setIsPeriodic (const int axis, const periodicType isPeriodic)
virtual void	setMappingCoordinateSystem (const mappingCoordinateSystem mappingCoordinateSystem0)
virtual void	setName (const mappingItemName item, const aString &name)
void	setGridIndexRange (int side, int axis, int num)
void	setNumberOfGhostPoints (int side, int axis, int numGhost)
virtual void	setParameter (const MappingParameters::realParameter &param, const real &value)
virtual void	setParameter (const MappingParameters::intParameter &param, const int &value)
void	setPartition (Partitioning_Type &partition)
virtual void	setPeriodVector (const int axis, const int direction, const real periodVectorComponent)
virtual void	setRangeBound (const int side, const int axis, const Bound rangeBound)
virtual void	setRangeCoordinateSystem (const coordinateSystem rangeCoordinateSystem)
virtual void	setRangeCoordinateSystemBound (const int side, const int axis, const Bound rangeCoordinateSystemBound)
virtual void	setRangeDimension (const int rangeDimension)
virtual void	setRangeSpace (const mappingSpace rangeSpace)
virtual void	setShare (const int side, const int axis, const int share)
void	setSignForJacobian (const real signForJac)
virtual void	setTopology (const int side, const int axis, const topologyEnum topo)
virtual void	setTypeOfCoordinateSingularity (const int side, const int axis, const coordinateSingularity)
bool	usesDistributedInverse () const
bool	usesDistributedMap () const
bool	usingRobustInverse () const
	Return true if the robust inverse is used.
virtual int	outside (const realArray &x)
virtual int	setNumberOfGhostLines (IndexRangeType &numberOfGhostLinesNew)
void	setNumberOfDistributedGhostLines (int numGhost)
void	periodicShift (realArray &r, const Index &I)
Index	getIndex (const realArray &r, realArray &x, const realArray &xr, int &base, int &bound, int &computeMap, int &computeMapDerivative)
Public Member Functions inherited from ReferenceCounting
	ReferenceCounting ()
	ReferenceCounting (const ReferenceCounting &x, const CopyType ct=DEEP)
virtual	~ReferenceCounting ()
Integer	incrementReferenceCount ()
Integer	decrementReferenceCount ()
Integer	getReferenceCount () const
Logical	uncountedReferencesMayExist ()
Integer	getGlobalID () const
void	setGlobalID (int id)
virtual void	consistencyCheck () const

Protected Member Functions
int	setMappingProperties ()

Additional Inherited Members
Public Types inherited from Mapping
enum	mappingSpace { parameterSpace, cartesianSpace }
enum	coordinateSystem {   cartesian, spherical, cylindrical, polar,   toroidal, numberOfCoordinateSystems }
enum	coordinateSingularity { noCoordinateSingularity, polarSingularity }
enum	mappingCoordinateSystem { rectangular, conformal, orthogonal, general }
enum	periodicType { notPeriodic, derivativePeriodic, functionPeriodic }
enum	topologyEnum { topologyIsNotPeriodic =0, topologyIsPeriodic, topologyIsPartiallyPeriodic }
enum	mappingItemName {   mappingName, domainName, rangeName, domainAxis1Name,   domainAxis2Name, domainAxis3Name, rangeAxis1Name, rangeAxis2Name,   rangeAxis3Name, numberOfMappingItemNames }
enum	basicInverseOptions { canDoNothing, canDetermineOutside, canInvert, canInvertWithGoodGuess }
typedef ArraySimpleFixed< int, 2, 3, 1, 1 >	IndexRangeType
Static Public Member Functions inherited from Mapping
static void	openDebugFiles ()
static void	closeDebugFiles ()
static real	epsilon ()
static void	setMinimumNumberOfDistributedGhostLines (int numGhost)
static int	getGridMinAndMax (const realArray &u, const Range &R1, const Range &R2, const Range &R3, real uMin[3], real uMax[3], bool local=false)
static Mapping *	makeMapping (const aString &mappingClassName)
static MappingLinkedList &	staticMapList ()
Public Attributes inherited from ComposeMapping
MappingRC	map1
MappingRC	map2
Static Public Attributes inherited from Mapping
static int	useInitialGuessForInverse =TRUE
static int	debug =0
static FILE *	debugFile =NULL
static FILE *	pDebugFile =NULL
static const real	bogus =10.
Protected Attributes inherited from ComposeMapping
bool	useDefaultInverse
Static Protected Attributes inherited from Mapping
static int	defaultNumberOfGhostPoints =0
static int	minimumNumberOfDistributedGhostLines =1

Constructor & Destructor Documentation

StretchTransform::StretchTransform

(

)

References axis1, axis2, Mapping::domainDimension, Mapping::getDomainDimension(), Mapping::getRangeDimension(), Mapping::mappingHasChanged(), Mapping::mappingName, NULL, Mapping::rangeDimension, Mapping::setGridDimensions(), and Mapping::setName().

Referenced by make().

StretchTransform::StretchTransform	(	const StretchTransform &	map,
		const CopyType	copyType = DEEP
	)

References DEEP, and ComposeMapping::map().

StretchTransform::~StretchTransform

(

)

References Mapping::debug.

Member Function Documentation

int StretchTransform::applyStretching	(	int	stretchingType[3],
		IntegerArray *	ipar,
		RealArray *	rpar
	)

References assert, c, Mapping::domainDimension, StretchMapping::exponential, StretchMapping::exponentialBlend, StretchMapping::exponentialToLinear, StretchMapping::hyperbolicTangent, StretchMapping::inverseHyperbolicTangent, StretchMapping::linearSpacing, StretchMapping::noStretching, NULL, printF(), StretchMapping::setExponentialParameters(), StretchMapping::setExponentialToLinearParameters(), StretchMapping::setHyperbolicTangentParameters(), StretchMapping::setIntervalParameters(), StretchMapping::setLayerParameters(), StretchMapping::setLinearSpacingParameters(), StretchMapping::setNumberOfIntervals(), StretchMapping::setNumberOfLayers(), StretchMapping::setStretchingType(), and StretchedSquare::stretchFunction().

Referenced by update(), and updateStretchingParameters().

int StretchTransform::buildStretchingParametersDialog	(	DialogData &	dialog,
		const StretchMapping::StretchingType	stretchType,
		const int	direction
	)

References DialogData::addInfoLabel(), DialogData::addOptionMenu(), GUIState::addPrefix(), assert, aString, c, StretchMapping::exponential, StretchMapping::exponentialBlend, StretchMapping::exponentialToLinear, StretchMapping::hyperbolicTangent, StretchMapping::inverseHyperbolicTangent, printF(), DialogData::setPushButtons(), DialogData::setTextBoxes(), and sPrintF().

Referenced by update().

int StretchTransform::get ( const GenericDataBase &  dir, const aString &  name  )

virtual

Reimplemented from ComposeMapping.

References Mapping::debug, GenericDataBase::find(), ComposeMapping::get(), GenericDataBase::get(), Mapping::getName(), ComposeMapping::map1, Mapping::mappingHasChanged(), Mapping::mappingName, MappingRC::mapPointer, printF(), Mapping::usesDistributedInverse(), Mapping::usesDistributedMap(), and GenericDataBase::virtualConstructor().

aString StretchTransform::getClassName ( void  ) const

inlinevirtual

Reimplemented from ComposeMapping.

Referenced by operator=().

StretchedSquare & StretchTransform::getStretchedSquare

(

)

References NULL.

Referenced by GridStretcher::applyStretching(), OffsetShell::buildOffsetMappings(), and GridStretcher::update().

Mapping * StretchTransform::make ( const aString &  mappingClassName )

virtual

Reimplemented from ComposeMapping.

References StretchTransform().

StretchTransform & StretchTransform::operator=

(

const StretchTransform &

X

)

References getClassName(), ComposeMapping::map1, MappingRC::mapPointer, and ComposeMapping::operator=().

int StretchTransform::put ( GenericDataBase &  dir, const aString &  name  ) const

virtual

Reimplemented from ComposeMapping.

References GenericDataBase::create(), Mapping::debug, Mapping::getName(), Mapping::mappingName, printF(), ComposeMapping::put(), GenericDataBase::put(), Mapping::usesDistributedInverse(), Mapping::usesDistributedMap(), and GenericDataBase::virtualConstructor().

void StretchTransform::reinitialize

(

)

References Mapping::mappingHasChanged().

Referenced by OffsetShell::buildOffsetMappings().

int StretchTransform::resizeParameterArrays	(	int	stretchID,
		IntegerArray &	ipar,
		RealArray &	rpar
	)

References printF().

Referenced by updateStretchingParameters().

void StretchTransform::setMapping

(

Mapping &

map

)

References ReferenceCounting::decrementReferenceCount(), Mapping::getDomainDimension(), Mapping::getIsPeriodic(), ReferenceCounting::incrementReferenceCount(), Mapping::mappingHasChanged(), NULL, Mapping::setDomainDimension(), Mapping::setIsPeriodic(), setMappingProperties(), ComposeMapping::setMappings(), and Mapping::setRangeDimension().

Referenced by MappingBuilder::buildBoxGrid(), OffsetShell::buildOffsetMappings(), main(), update(), and GridStretcher::update().

int StretchTransform::setMappingProperties ( )

protected

References aString, Mapping::domainDimension, End, MappingRC::getName(), Mapping::getName(), MappingRC::getTypeOfCoordinateSingularity(), ComposeMapping::map2, Mapping::mappingName, Mapping::setName(), Mapping::setTypeOfCoordinateSingularity(), and Start.

Referenced by setMapping().

int StretchTransform::update ( MappingInformation &  mapInfo )

virtual

Reimplemented from ComposeMapping.

References NULL, and nullString.

Referenced by OffsetShell::buildOffsetMappings(), and main().

int StretchTransform::update	(	MappingInformation &	mapInfo,
		const aString &	command,
		DialogData *	interface = NULL
	)

References DialogData::addInfoLabel(), DialogData::addOptionMenu(), GUIState::addPrefix(), GenericGraphicsInterface::appendToTheDefaultPrompt(), applyStretching(), assert, aString, axis1, Mapping::buildMappingParametersDialog(), GUIState::buildPopup(), buildStretchingParametersDialog(), c, DialogData::closeDialog(), GraphicsParameters::colourByBoundaryCondition, GraphicsParameters::colourByShare, MappingInformation::command, MappingInformation::commandOption, direction(), Mapping::display(), Mapping::domainAxis1Name, Mapping::domainDimension, GenericGraphicsInterface::erase(), StretchMapping::exponential, StretchMapping::exponentialBlend, StretchMapping::exponentialToLinear, fabs(), FALSE, GenericGraphicsInterface::getAnswer(), GenericGraphicsInterface::getCurrentWindow(), GUIState::getDialogSibling(), Mapping::getGrid(), Mapping::getGridDimensions(), Mapping::getIsPeriodic(), ListOfMappingRC::getLength(), Mapping::getMappingParametersOption(), GenericGraphicsInterface::getMenuItem(), MappingRC::getName(), Mapping::getName(), GenericGraphicsInterface::getNewLabelList(), DialogData::getOptionMenu(), DialogData::getTextValue(), DialogData::getToggleValue(), GI_BOUNDARY_COLOUR_OPTION, GI_LABEL_GRIDS_AND_BOUNDARIES, GI_MAPPING_COLOUR, GI_PLOT_GRID_POINTS_ON_CURVES, GI_PLOT_NON_PHYSICAL_BOUNDARIES, GI_PLOT_THE_OBJECT_AND_EXIT, GI_TOP_LABEL, MappingInformation::graphXInterface, DialogData::hideSibling(), StretchMapping::hyperbolicTangent, if(), MappingInformation::interactive, StretchMapping::inverseHyperbolicTangent, GenericGraphicsInterface::isGraphicsWindowOpen(), GenericGraphicsInterface::label(), StretchMapping::map(), ComposeMapping::map2, Mapping::mappingHasChanged(), MappingInformation::mappingList, Mapping::mappingName, max(), StretchMapping::noStretching, SelectionInfo::nSelect, NULL, nullString, GenericGraphicsInterface::outputString(), PlotIt::plot(), GenericGraphicsInterface::popGUI(), printF(), GenericGraphicsInterface::pushGUI(), r, R, Mapping::rangeAxis1Name, GenericGraphicsInterface::readingFromCommandFile(), MappingInformation::readOneCommand, REAL_MIN, GenericGraphicsInterface::savePickCommands(), GraphicsParameters::set(), GenericGraphicsInterface::setAxesLabels(), OptionMenu::setCurrentChoice(), DataPointMapping::setDataPoints(), DialogData::setExitCommand(), Mapping::setGridDimensions(), DialogData::setInfoLabel(), StretchMapping::setIsPeriodic(), Mapping::setIsPeriodic(), setMapping(), Mapping::setName(), DialogData::setOptionMenuColumns(), DialogData::setPushButtons(), StretchMapping::setStretchingType(), DialogData::setTextBoxes(), DialogData::setTextLabel(), DialogData::setToggleButtons(), DialogData::setWindowTitle(), DialogData::showSibling(), sPrintF(), sScanF(), GenericGraphicsInterface::stopReadingCommandFile(), StretchedSquare::stretchFunction(), GenericGraphicsInterface::unAppendTheDefaultPrompt(), StretchedSquare::update(), MappingRC::update(), Mapping::update(), updateStretchingParameters(), Mapping::updateWithCommand(), x, and xr.

int StretchTransform::updateStretchingParameters	(	aString &	answer,
		IntegerArray *	ipar,
		RealArray *	rpar,
		int	stretchingType[3],
		int	numberOfMultigridLevels,
		real	stretchResolutionFactor,
		DialogData *	stretchParametersDialog[3],
		DialogData &	dialog,
		MappingInformation &	mapInfo
	)

References ALPHA, applyStretching(), assert, aString, c, direction(), dx, EVAL_STRETCH, StretchMapping::exponential, StretchMapping::exponentialToLinear, Mapping::getGridDimensions(), MappingRC::getIsPeriodic(), MappingRC::getMapping(), DialogData::getOptionMenu(), DialogData::getTextValue(), MappingInformation::graphXInterface, StretchMapping::hyperbolicTangent, StretchMapping::inverseHyperbolicTangent, log(), ComposeMapping::map2, Mapping::mappingHasChanged(), max(), nr, NULL, pow(), printF(), ra, resizeParameterArrays(), OptionMenu::setCurrentChoice(), Mapping::setGridDimensions(), DialogData::setInfoLabel(), StretchMapping::setNumberOfLayers(), DialogData::setTextLabel(), SPRIME, sPrintF(), sScanF(), GenericGraphicsInterface::stopReadingCommandFile(), and StretchedSquare::stretchFunction().

Referenced by update().

---

The documentation for this class was generated from the following files:

• StretchTransform.h
• StretchTransform.C
• stretchUpdate.C