#include <StretchMapping.h>

Inheritance diagram for StretchMapping:

Collaboration diagram for StretchMapping:

Public Types
enum	StretchingType { inverseHyperbolicTangent =0, hyperbolicTangent, exponential, exponentialBlend, exponentialToLinear, noStretching, linearSpacing, numberOfStretchingTypes }

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

Public Member Functions
	StretchMapping (const StretchingType &stretchingType=noStretching)

	StretchMapping (const int numberOfLayers, const int numberOfIntervals=0)

	StretchMapping (const StretchMapping &, const CopyType copyType=DEEP)

	~StretchMapping ()

StretchMapping &	operator= (const StretchMapping &X)

int	setStretchingType (const StretchingType &stretchingType)

int	setNumberOfLayers (const int numberOfLayers)

int	setNumberOfIntervals (const int numberOfIntervals)

int	setLayerParameters (const int index, const real a, const real b, const real c)

int	setIntervalParameters (const int index, const real d, const real e, const real f)

int	setIsNormalized (const bool &trueOrFalse=TRUE)

int	setEndPoints (const real rmin, const real rmax)

int	setScaleParameters (const real origin, const real scale)

int	setNumberOfSplinePoints (const int numberOfSplinePoints)

int	setIsPeriodic (const int trueOrFalse)

virtual void	setIsPeriodic (const int axis, const periodicType isPeriodic)

int	setHyperbolicTangentParameters (const real &a0, const real &ar, const real &a1, const real &b1, const real &c1)

int	setExponentialParameters (const real &a0, const real &ar, const real &a1, const real &b1, const real &c1)

int	setExponentialToLinearParameters (const real &a, const real &b, const real &c)

int	setLinearSpacingParameters (const real &a0, const real &a1)

int	initialize ()

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

void	display (const aString &label=blankString) const

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	update (MappingInformation &mapInfo)

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 real	sizeOf (FILE *file=NULL) const

virtual bool	updateWithCommand (MappingInformation &mapInfo, const aString &command)

virtual int	interactiveUpdate (GenericGraphicsInterface &gi)

virtual int	project (realArray &x, MappingProjectionParameters &mpParams)

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 &	getGrid (MappingParameters &params=Overture::nullMappingParameters(), bool includeGhost=false)

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	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

virtual void	useRobustInverse (const bool trueOrFalse=TRUE)

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
void	setup ()

Protected Member Functions inherited from Mapping
int	buildMappingParametersDialog (DialogData &dialog)

int	getMappingParametersOption (const aString &answer, DialogData &dialog, GenericGraphicsInterface &gi)
	: Look for a change to one of the mapping parameters.

int	updateMappingParametersDialog (DialogData &dialog)

void	initializePartition ()

int	mappingHasChanged ()

void	setGridIsValid ()

void	setDefaultMappingBounds (const mappingSpace ms, Bound mappingBound[3][2])

void	setDefaultCoordinateSystemBounds (const coordinateSystem cs, Bound csBound[3][2])

int	validSide (const int side) const

int	validAxis (const int axis) const

void	mappingError (const aString &subName, const int side, const int axis) const

Protected Attributes
aString	className

IntegerArray	iw

int	numberOfLayers

int	numberOfIntervals

int	numberOfSplinePoints

int	unInitialized

RealArray	rw

int	iopt

int	ierr

real	ra

real	rb

real	r0

real	r1

RealArray	abc

RealArray	def

StretchingType	stretchingType

bool	normalized

real	origin

real	scale

real	a0

real	ar

real	a1

real	b1

real	c1

real	a0Normalized

real	arNormalized

real	a1Normalized

Protected Attributes inherited from Mapping
int	dataBaseID

aString	className

int	domainDimension

int	rangeDimension

int	bc [2][3]

int	share [2][3]

periodicType	isPeriodic [3]

real	periodVector [3][3]

int	invertible

basicInverseOptions	basicInverseOption

int	periodicityOfSpace

coordinateSingularity	typeOfCoordinateSingularity [2][3]

int	coordinateEvaluationType [numberOfCoordinateSystems]

IndexRangeType	gridIndexRange

IndexRangeType	numberOfGhostPoints

realArray	grid

bool	inverseIsDistributed

bool	mapIsDistributed

int	numberOfDistributedGhostLines

bool	partitionInitialized

Partitioning_Type	partition

mappingSpace	domainSpace

mappingSpace	rangeSpace

coordinateSystem	domainCoordinateSystem

coordinateSystem	rangeCoordinateSystem

mappingCoordinateSystem	mappingCoordinateSystem0

Bound	domainBound [3][2]

Bound	rangeBound [3][2]

Bound	domainCoordinateSystemBound [3][2]

Bound	rangeCoordinateSystemBound [3][2]

topologyEnum	topology [3][2]

intArray *	topologyMaskPointer

real	arcLength

bool	remakeGrid

bool	remakeGridSerial

Additional Inherited Members
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 Mapping
int	computeMap

int	computeMapDerivative

int	base

int	bound

real	signForJacobian

ApproximateGlobalInverse *	approximateGlobalInverse

ExactLocalInverse *	exactLocalInverse

DistributedInverse *	distributedInverse

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.

Static Protected Attributes inherited from Mapping
static int	defaultNumberOfGhostPoints =0

static int	minimumNumberOfDistributedGhostLines =1

Member Enumeration Documentation

enum StretchMapping::StretchingType

Enumerator
inverseHyperbolicTangent
hyperbolicTangent
exponential
exponentialBlend
exponentialToLinear
noStretching
linearSpacing
numberOfStretchingTypes

Constructor & Destructor Documentation

StretchMapping::StretchMapping ( const StretchingType & stretchingType = noStretching )

References inverseHyperbolicTangent, Mapping::inverseIsDistributed, numberOfIntervals, numberOfLayers, setup(), and stretchingType.

Referenced by make().

StretchMapping::StretchMapping	(	const int	numberOfLayers,
		const int	numberOfIntervals = `0`
	)

References inverseHyperbolicTangent, Mapping::inverseIsDistributed, numberOfIntervals, numberOfLayers, setup(), and stretchingType.

StretchMapping::StretchMapping	(	const StretchMapping &	map,
		const CopyType	copyType = `DEEP`
	)

References className, DEEP, and map().

StretchMapping::~StretchMapping ( )

References Mapping::debug.

Member Function Documentation

void StretchMapping::basicInverse	(	const realArray &	x,
		realArray &	r,
		realArray &	rx = `Overture::nullRealDistributedArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)

virtual

Reimplemented from Mapping.

References inverseMap().

void StretchMapping::basicInverseS	(	const RealArray &	x,
		RealArray &	r,
		RealArray &	rx = `Overture::nullRealArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)

virtual

Reimplemented from Mapping.

References inverseMapS().

void StretchMapping::display ( const aString & label = blankString ) const

virtual

Reimplemented from Mapping.

References a0, a1, abc, ar, b1, c1, def, Mapping::display(), exponential, exponentialToLinear, hyperbolicTangent, inverseHyperbolicTangent, iopt, iw, noStretching, numberOfIntervals, numberOfLayers, numberOfSplinePoints, origin, printF(), r0, r1, ra, rb, rw, scale, stretchingType, and unInitialized.

Referenced by update().

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

virtual

Reimplemented from Mapping.

References a0, a0Normalized, a1, a1Normalized, abc, ar, arNormalized, b1, c1, className, Mapping::debug, def, GenericDataBase::find(), GenericDataBase::get(), Mapping::get(), Mapping::inverseIsDistributed, iopt, iw, Mapping::mappingHasChanged(), max(), normalized, numberOfIntervals, numberOfLayers, numberOfSplinePoints, r0, r1, ra, rb, rw, stretchingType, unInitialized, and GenericDataBase::virtualConstructor().

Referenced by StretchedSquare::get().

aString StretchMapping::getClassName ( void ) const

inlinevirtual

Reimplemented from Mapping.

References className.

Referenced by operator=().

int StretchMapping::initialize ( )

References a0, a0Normalized, a1, a1Normalized, abc, ar, arNormalized, axis1, b1, c1, Mapping::debug, def, exponential, exponentialBlend, exponentialToLinear, FALSE, Mapping::getInvertible(), Mapping::getIsPeriodic(), hyperbolicTangent, ierr, inverseHyperbolicTangent, iopt, iw, linearSpacing, Mapping::mappingHasChanged(), max(), normalized, numberOfIntervals, numberOfLayers, numberOfSplinePoints, origin, ra, rb, rw, Mapping::setInvertible(), setIsPeriodic(), SQR, STINIT, stretchingType, TRUE, and unInitialized.

Referenced by inverseMapS(), and mapS().

void StretchMapping::inverseMap	(	const realArray &	x,
		realArray &	r,
		realArray &	rx = `Overture::nullRealDistributedArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)

virtual

Reimplemented from Mapping.

References getLocalArrayWithGhostBoundaries(), and inverseMapS().

Referenced by basicInverse().

void StretchMapping::inverseMapS	(	const RealArray &	x,
		RealArray &	r,
		RealArray &	rx = `Overture::nullRealArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)

virtual

Reimplemented from Mapping.

References a0, a1, b1, Mapping::base, Mapping::bogus, Mapping::bound, c, c1, Mapping::canDoNothing, Mapping::computeMap, Mapping::computeMapDerivative, Mapping::debug, exponentialToLinear, fabs(), Mapping::getIndex(), Mapping::getInvertible(), ierr, initialize(), inverseHyperbolicTangent, Mapping::inverseMapS(), MappingParameters::isNull, iw, linearSpacing, log(), noStretching, OV_ABORT, printF(), R, REAL_EPSILON, rw, RX, s, scale, Mapping::setBasicInverseOption(), SQR, stretchingType, STTR, unInitialized, and X.

Referenced by basicInverseS(), and inverseMap().

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

virtual

Reimplemented from Mapping.

References className, NULL, and StretchMapping().

void StretchMapping::map	(	const realArray &	r,
		realArray &	x,
		realArray &	xr = `Overture::nullRealDistributedArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)

virtual

Reimplemented from Mapping.

References getLocalArrayWithGhostBoundaries(), and mapS().

Referenced by OffsetShell::buildOffsetMappings(), StretchMapping(), StretchTransform::update(), and update().

void StretchMapping::mapS	(	const RealArray &	r,
		RealArray &	x,
		RealArray &	xr = `Overture::nullRealArray()`,
		MappingParameters &	params = `Overture::nullMappingParameters()`
	)