Interpolant Class Reference

#include <Interpolant.h>

Inheritance diagram for Interpolant:

Collaboration diagram for Interpolant:

Public Types
enum	InterpolationMethodEnum { standard, optimized, optimizedC, numberOfInterpolationMethods }
enum	ExplicitInterpolationStorageOptionEnum { precomputeAllCoefficients, precomputeSomeCoefficients, precomputeNoCoefficients }
enum	ImplicitInterpolationMethodEnum { directSolve, sparseSolve, iterateToInterpolate }
enum	InterpolationOptionEnum { interpolateOverlappingRefinementPoints, interpolateAllRefinementBoundaries, interpolateHiddenRefinementPoints }

Public Member Functions
	Interpolant ()
	Interpolant (CompositeGrid &cg)
	Interpolant (GridCollection &gc)
	Interpolant (const Interpolant &interpolant, const CopyType copyType=DEEP)
virtual	~Interpolant ()
Interpolant &	operator= (const Interpolant &interpolant)
void	reference (const Interpolant &interpolant)
virtual void	breakReference ()
void	updateToMatchGrid (CompositeGrid &cg, int refinementLevel=0)
int	interpolate (realCompositeGridFunction &u, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
int	interpolate (realGridCollectionFunction &u, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
int	interpolate (int gridToInterpolate, realCompositeGridFunction &u, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
int	interpolate (realCompositeGridFunction &u, const IntegerArray &gridsToInterpolate, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
int	interpolate (realCompositeGridFunction &u, const IntegerArray &gridsToInterpolate, const IntegerArray &gridsToInterpolateFrom, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
int	interpolate (realArray &ui, int gridToInterpolate, int interpoleeGrid, realCompositeGridFunction &u, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
bool	interpolationIsExplicit () const
bool	interpolationIsImplicit () const
int	setInterpolationMethod (InterpolationMethodEnum method)
int	setMaximumNumberOfIterations (int maximumNumberOfIterations)
int	setExplicitInterpolationStorageOption (ExplicitInterpolationStorageOptionEnum option)
int	setImplicitInterpolationMethod (ImplicitInterpolationMethodEnum method)
ImplicitInterpolationMethodEnum	getImplicitInterpolationMethod () const
int	setImplicitInterpolationTolerance (real tol)
int	setInterpolationOption (InterpolationOptionEnum option, bool trueOrFalse)
int	getInterpolationOption (InterpolationOptionEnum option)
int	setInterpolateRefinements (InterpolateRefinements &interpolateRefinements)
int	setMaximumRefinementLevelToInterpolate (int maxLevelToInterpolate)
	Only interpolate grids on refinement levels that are less than or equal to a given level.
int	getMaximumRefinementLevelToInterpolate () const
	return the maximum refinement level to interpolate
virtual real	sizeOf (FILE *file=NULL) const
int	printMyStatistics (FILE *file=stdout)
int	interpolateRefinementLevel (const int refinementLevel, realCompositeGridFunction &u, const Range &C0=nullRange, const Range &C1=nullRange, const Range &C2=nullRange)
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 ()
virtual aString	getClassName () const
Integer	getGlobalID () const
void	setGlobalID (int id)
virtual void	consistencyCheck () const

Static Public Member Functions
static int	printStatistics (FILE *file=stdout)
static int	testInterpolation (CompositeGrid &cg, int problemType)

Public Attributes
BoundaryConditionParameters	bcParams
int	debug
RCData *	rcData

Protected Member Functions
int	getComponentRanges (const Range &C0, const Range &C1, const Range &C2, Range C[4], realCompositeGridFunction &u)

Member Enumeration Documentation

enum Interpolant::ExplicitInterpolationStorageOptionEnum

Enumerator
precomputeAllCoefficients
precomputeSomeCoefficients
precomputeNoCoefficients

enum Interpolant::ImplicitInterpolationMethodEnum

Enumerator
directSolve
sparseSolve
iterateToInterpolate

enum Interpolant::InterpolationMethodEnum

Enumerator
standard
optimized
optimizedC
numberOfInterpolationMethods

enum Interpolant::InterpolationOptionEnum

Enumerator
interpolateOverlappingRefinementPoints
interpolateAllRefinementBoundaries
interpolateHiddenRefinementPoints

Constructor & Destructor Documentation

Interpolant::Interpolant

(

)

Interpolant::Interpolant

(

CompositeGrid &

cg

)

References updateToMatchGrid().

Interpolant::Interpolant

(

GridCollection &

gc

)

Interpolant::Interpolant	(	const Interpolant &	interpolant,
		const CopyType	copyType = DEEP
	)

References DEEP, NOCOPY, rcData, reference(), and SHALLOW.

Interpolant::~Interpolant ( )

virtual

References ReferenceCounting::getReferenceCount(), printF(), and rcData.

Member Function Documentation

void Interpolant::breakReference ( void  )

virtual

Reimplemented from ReferenceCounting.

References rcData, and reference().

int Interpolant::getComponentRanges ( const Range &  C0, const Range &  C1, const Range &  C2, Range  C[4], realCompositeGridFunction &  u  )

protected

References iterateToInterpolate, and doubleGridCollectionFunction::positionOfComponent().

Referenced by interpolate(), and interpolateRefinementLevel().

Interpolant::ImplicitInterpolationMethodEnum Interpolant::getImplicitInterpolationMethod

(

)

const

int Interpolant::getInterpolationOption

(

InterpolationOptionEnum

option

)

References interpolateAllRefinementBoundaries, interpolateHiddenRefinementPoints, interpolateOverlappingRefinementPoints, and printF().

Referenced by ErrorEstimator::interpolateAndApplyBoundaryConditions().

int Interpolant::getMaximumRefinementLevelToInterpolate

(

)

const

return the maximum refinement level to interpolate

int Interpolant::interpolate	(	realCompositeGridFunction &	u,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References C, and getComponentRanges().

Referenced by floatGridCollectionFunction::interpolate(), floatCompositeGridFunction::interpolate(), Ogmg::interpolate(), and main().

int Interpolant::interpolate	(	realGridCollectionFunction &	u,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

int Interpolant::interpolate	(	int	gridToInterpolate,
		realCompositeGridFunction &	u,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References assert, C, getComponentRanges(), and GenericGridCollection::numberOfComponentGrids().

int Interpolant::interpolate	(	realCompositeGridFunction &	u,
		const IntegerArray &	gridsToInterpolate,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References Overture::abort(), C, getComponentRanges(), interpolationIsExplicit(), iterateToInterpolate, GenericGridCollection::numberOfComponentGrids(), and printF().

int Interpolant::interpolate	(	realCompositeGridFunction &	u,
		const IntegerArray &	gridsToInterpolate,
		const IntegerArray &	gridsToInterpolateFrom,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References Overture::abort(), C, getComponentRanges(), interpolationIsExplicit(), iterateToInterpolate, GenericGridCollection::numberOfComponentGrids(), and printF().

int Interpolant::interpolate	(	realArray &	ui,
		int	gridToInterpolate,
		int	interpoleeGrid,
		realCompositeGridFunction &	u,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References Overture::abort(), assert, axis1, axis2, C, coeffg, getComponentRanges(), getCPU(), il, CompositeGrid::interpolationStartEndIndex, CompositeGrid::interpoleeLocation, GenericGridCollection::numberOfComponentGrids(), GridCollection::numberOfDimensions(), OV_ABORT, and R.

int Interpolant::interpolateRefinementLevel	(	const int	refinementLevel,
		realCompositeGridFunction &	u,
		const Range &	C0 = nullRange,
		const Range &	C1 = nullRange,
		const Range &	C2 = nullRange
	)

References Overture::abort(), C, GenericGridCollection::componentGridNumber, getComponentRanges(), interpolationIsExplicit(), iterateToInterpolate, GenericGridCollection::numberOfComponentGrids(), GenericGridCollection::numberOfRefinementLevels(), optimized, printF(), and GridCollection::refinementLevel.

bool Interpolant::interpolationIsExplicit

(

)

const

Referenced by interpolate(), and interpolateRefinementLevel().

bool Interpolant::interpolationIsImplicit

(

)

const

Interpolant & Interpolant::operator=

(

const Interpolant &

interpolant

)

References rcData.

int Interpolant::printMyStatistics

(

FILE *

file = stdout

)

References NULL, printStatistics(), and rcData.

int Interpolant::printStatistics ( FILE *  file = stdout )

static

References max(), and REAL_MIN.

Referenced by printMyStatistics().

void Interpolant::reference

(

const Interpolant &

interpolant

)

References rcData, ListOfFloatDistributedArray::reference(), and CompositeGrid::reference().

Referenced by breakReference(), and Interpolant().

int Interpolant::setExplicitInterpolationStorageOption

(

ExplicitInterpolationStorageOptionEnum

option

)

int Interpolant::setImplicitInterpolationMethod

(

ImplicitInterpolationMethodEnum

method

)

References FALSE.

Referenced by DerivedFunctions::computeDerivedFunctions(), main(), and testInterpolation().

int Interpolant::setImplicitInterpolationTolerance

(

real

tol

)

int Interpolant::setInterpolateRefinements

(

InterpolateRefinements &

interpolateRefinements

)

Referenced by main().

int Interpolant::setInterpolationMethod

(

InterpolationMethodEnum

method

)

int Interpolant::setInterpolationOption	(	InterpolationOptionEnum	option,
		bool	trueOrFalse
	)

References interpolateAllRefinementBoundaries, interpolateHiddenRefinementPoints, interpolateOverlappingRefinementPoints, and printF().

int Interpolant::setMaximumNumberOfIterations

(

int

maximumNumberOfIterations

)

Referenced by DerivedFunctions::computeDerivedFunctions(), and Ogmg::interpolate().

int Interpolant::setMaximumRefinementLevelToInterpolate

(

int

maxLevelToInterpolate

)

Only interpolate grids on refinement levels that are less than or equal to a given level.

This option is used by the error estimator.

real Interpolant::sizeOf ( FILE *  file = NULL ) const

virtual

References NULL.

int Interpolant::testInterpolation ( CompositeGrid &  cg, int  problemType  )

static

References abs(), GenericGridCollection::baseGridNumber, MappedGrid::boundaryCondition(), debug, Oges::debug, MappedGrid::dimension(), display(), displayMask(), MappedGrid::extendedIndexRange(), ForBoundary, getBoundaryIndex(), getIndex(), gridIndexRange, indexRange, GridCollectionData::interpolant, doubleCompositeGridFunction::interpolate(), interpolateRefinements(), iterateToInterpolate, mask, MappedGrid::mask(), max(), min(), GenericGridCollection::numberOfComponentGrids(), GridCollection::numberOfDimensions(), poly, printF(), GridCollection::refinementLevel, setImplicitInterpolationMethod(), doubleCompositeGridFunction::setOperators(), MappedGrid::THEcenter, MappedGrid::THEvertex, and CompositeGrid::update().

void Interpolant::updateToMatchGrid	(	CompositeGrid &	cg,
		int	refinementLevel = 0
	)

References ReferenceCounting::decrementReferenceCount(), ParallelUtility::getMaxValue(), ReferenceCounting::incrementReferenceCount(), GridCollectionData::interpolant, CompositeGrid::interpolationIsImplicit, iterateToInterpolate, max(), NULL, GenericGridCollection::numberOfComponentGrids(), GridCollection::numberOfDimensions(), GenericGridCollection::numberOfMultigridLevels(), OV_ABORT, printF(), CompositeGrid::rcData, CompositeGrid::reference(), and ReferenceCounting::uncountedReferencesMayExist().

Referenced by Interpolant(), and main().

Member Data Documentation

BoundaryConditionParameters Interpolant::bcParams

int Interpolant::debug

Referenced by main(), and testInterpolation().

RCData* Interpolant::rcData

Referenced by breakReference(), Interpolant(), operator=(), printMyStatistics(), reference(), and ~Interpolant().

---

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

• Interpolant.h
• Interpolant.C