#include <InterpolateParameters.h>

Collaboration diagram for InterpolateParameters:

Public Types
enum	InterpolateType { defaultValue, polynomial, fullWeighting, nearestNeighbor, injection, numberOfInterpolateTypes }

enum	InterpolateOffsetDirection { offsetInterpolateToLeft, offsetInterpolateToRight, numberOfInterpolateOffsetDirections }

Public Member Functions
	InterpolateParameters (const int numberFOfDimensions_=2, const bool debug_=LogicalFalse)

	~InterpolateParameters ()

int	interactivelySetParameters ()

void	display () const

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

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

void	setAmrRefinementRatio (const IntegerArray &amrRefinementRatio_)

void	setNumberOfDimensions (const int numberOfDimensions_=defaultNumberOfDimensions)

void	setInterpolateType (const InterpolateParameters::InterpolateType interpolateType_=InterpolateParameters::defaultInterpolateType)

void	setInterpolateOrder (const int interpolateOrder_=InterpolateParameters::defaultInterpolateOrder)

void	setGridCentering (const GridFunctionParameters::GridFunctionType gridCentering_=InterpolateParameters::defaultGridCentering)

void	setUseGeneralInterpolationFormula (const bool TrueOrFalse=LogicalFalse)

int	amrRefinementRatio (const int axis) const

GridFunctionParameters::GridFunctionType	gridCentering () const

InterpolateType	interpolateType () const

int	interpolateOrder () const

int	numberOfDimensions () const

bool	useGeneralInterpolationFormula () const

Public Attributes
bool	debug

NameList	nl

Static Public Attributes
static const int	defaultAmrRefinementRatio = 4

static const GridFunctionParameters::GridFunctionType	defaultGridCentering = GridFunctionParameters::vertexCentered

static const InterpolateParameters::InterpolateType	defaultInterpolateType = InterpolateParameters::polynomial

static const int	defaultInterpolateOrder = 2

static const int	defaultMaxRefinementRatio

static const int	defaultNumberOfDimensions = 2

static const real	coeffEps = REAL_EPSILON*100

static const InterpolateOffsetDirection	defaultInterpolateOffsetDirection

Protected Attributes
IntegerArray	amrRefinementRatio__

int	maxRefinementRatio__

int	numberOfDimensions__

GridFunctionParameters::GridFunctionType	gridCentering__

InterpolateType	interpolateType__

int	interpolateOrder__

bool	useGeneralInterpolationFormula__

Member Enumeration Documentation

enum InterpolateParameters::InterpolateOffsetDirection

Enumerator
offsetInterpolateToLeft
offsetInterpolateToRight
numberOfInterpolateOffsetDirections

enum InterpolateParameters::InterpolateType

Enumerator
defaultValue
polynomial
fullWeighting
nearestNeighbor
injection
numberOfInterpolateTypes

Constructor & Destructor Documentation

InterpolateParameters::InterpolateParameters	(	const int	numberFOfDimensions_ = `2`,
		const bool	debug_ = `LogicalFalse`
	)

References amrRefinementRatio__, debug, setAmrRefinementRatio(), setGridCentering(), setInterpolateOrder(), setInterpolateType(), setNumberOfDimensions(), and setUseGeneralInterpolationFormula().

InterpolateParameters::~InterpolateParameters ( )

Member Function Documentation

int InterpolateParameters::amrRefinementRatio ( const int axis ) const

inline

References amrRefinementRatio__.

Referenced by Interpolate::initialize().

void InterpolateParameters::display ( ) const

References amrRefinementRatio__, debug, gridCentering__, interpolateOrder__, interpolateType__, maxRefinementRatio__, and useGeneralInterpolationFormula__.

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

References amrRefinementRatio__, aString, GenericDataBase::find(), GenericDataBase::get(), gridCentering__, interpolateOrder__, interpolateType__, maxRefinementRatio__, numberOfDimensions__, useGeneralInterpolationFormula__, and GenericDataBase::virtualConstructor().

Referenced by InterpolateRefinements::get().

GridFunctionParameters::GridFunctionType InterpolateParameters::gridCentering ( ) const

inline

References gridCentering__.

Referenced by Interpolate::initialize().

int InterpolateParameters::interactivelySetParameters ( )

References amrRefinementRatio__, aString, debug, NameList::getIntArray(), NameList::getVariableName(), gridCentering__, interpolateOrder__, interpolateType__, NameList::intValue(), maxRefinementRatio__, nl, numberOfDimensions__, and useGeneralInterpolationFormula__.

int InterpolateParameters::interpolateOrder ( ) const

inline

References interpolateOrder__.

Referenced by Interpolate::initialize().

InterpolateType InterpolateParameters::interpolateType ( ) const

inline

References interpolateType__.

Referenced by Interpolate::initialize().

int InterpolateParameters::numberOfDimensions ( ) const

inline

References numberOfDimensions__.

Referenced by Interpolate::initialize().

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

References GenericDataBase::create(), GenericDataBase::put(), and GenericDataBase::virtualConstructor().

void InterpolateParameters::setAmrRefinementRatio ( const IntegerArray & amrRefinementRatio_ )

References amrRefinementRatio__, defaultAmrRefinementRatio, and numberOfDimensions__.

Referenced by InterpolateParameters().

void InterpolateParameters::setGridCentering ( const GridFunctionParameters::GridFunctionType gridCentering_ = InterpolateParameters::defaultGridCentering )

References gridCentering__.

Referenced by InterpolateParameters().

void InterpolateParameters::setInterpolateOrder ( const int interpolateOrder_ = InterpolateParameters::defaultInterpolateOrder )

References interpolateOrder__.

Referenced by InterpolateParameters(), InterpolateRefinements::InterpolateRefinements(), and InterpolateRefinements::setOrderOfInterpolation().

void InterpolateParameters::setInterpolateType ( const InterpolateParameters::InterpolateType interpolateType_ = InterpolateParameters::defaultInterpolateType )

References defaultInterpolateType, defaultValue, and interpolateType__.

Referenced by InterpolateParameters().

void InterpolateParameters::setNumberOfDimensions ( const int numberOfDimensions_ = defaultNumberOfDimensions )

References numberOfDimensions__.

Referenced by InterpolateParameters().

void InterpolateParameters::setUseGeneralInterpolationFormula ( const bool TrueOrFalse = LogicalFalse )

References useGeneralInterpolationFormula__.

Referenced by InterpolateParameters().

bool InterpolateParameters::useGeneralInterpolationFormula ( ) const

inline

References useGeneralInterpolationFormula__.

Referenced by Interpolate::initialize().