ReferenceHeightIF Class Reference

#include <ReferenceHeightIF.H>

Inheritance diagram for ReferenceHeightIF:

Inheritance graph
[legend]

List of all members.


Detailed Description

This adapter wraps any BaseIF subclass and gives it the the concept of a reference height. The adapter passes through all function calls to the adapted object, except value(RealVect).. The reference height is used to evaluate the value function when SpaceDim=GLOBALDIM-1,

Public Member Functions

 ReferenceHeightIF (const BaseIF &a_implicitFunction, const Real &a_referenceHeight, const IndexTM< Real, GLOBALDIM > &a_origin)
 ReferenceHeightIF (const BaseIF &a_implicitFunction, const PolynomialIF &a_referenceSurface, const Real &a_referenceHeight, const IndexTM< Real, GLOBALDIM > &a_origin)
virtual ~ReferenceHeightIF ()
 Destructor cleans up the member implicit function.
Real value (const IndexTM< int, GLOBALDIM > &a_partialDerivative, const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Real value (const RealVect &a_point) const
virtual Real value (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual ReferenceHeightIFnewImplicitFunction () const
virtual void print (ostream &a_out) const
Real getReferenceHeight () const
IndexTM< Real, GLOBALDIM > getOrigin () const
void getReferenceSurfacePolynomial (Vector< PolyTerm > &a_polynomial, bool &a_inside) const
Real evaluateReferenceSurfacePolynomial (const RealVect &a_point) const
virtual void boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)
BaseIFgetPointer2IF () const
ReferenceHeightIFnewChangedIF (const BaseIF *a_newIF) const
bool hasReferenceSurface () const

Private Member Functions

 ReferenceHeightIF ()

Private Attributes

BaseIFm_implicitFunction
PolynomialIFm_referenceSurface
Real m_referenceHeight
IndexTM< Real, GLOBALDIM > m_origin

Constructor & Destructor Documentation

ReferenceHeightIF::ReferenceHeightIF ( const BaseIF a_implicitFunction,
const Real a_referenceHeight,
const IndexTM< Real, GLOBALDIM > &  a_origin 
) [inline]

Construct the ReferenceHeightIF using another IF plus a reference height. The delegate IF will be copied.

ReferenceHeightIF::ReferenceHeightIF ( const BaseIF a_implicitFunction,
const PolynomialIF a_referenceSurface,
const Real a_referenceHeight,
const IndexTM< Real, GLOBALDIM > &  a_origin 
) [inline]

virtual ReferenceHeightIF::~ReferenceHeightIF (  )  [inline, virtual]

Destructor cleans up the member implicit function.

References m_implicitFunction.

ReferenceHeightIF::ReferenceHeightIF (  )  [inline, private]


Member Function Documentation

Real ReferenceHeightIF::value ( const IndexTM< int, GLOBALDIM > &  a_partialDerivative,
const IndexTM< Real, GLOBALDIM > &  a_point 
) const [inline, virtual]

Reimplemented from BaseIF.

References m_implicitFunction, m_referenceSurface, PolynomialIF::value(), and BaseIF::value().

Referenced by value().

virtual Real ReferenceHeightIF::value ( const RealVect a_point  )  const [inline, virtual]

Return the value of the function at a_point. value(RealVect) to value(IndexTM). However, in the case where GLOBALDIM == 3 and SpaceDim == 2 the missing dimension is filled in with the reference height. Subclasses need not implement this function, but if

Implements BaseIF.

References MayDay::Abort(), GLOBALDIM, m_origin, m_referenceHeight, m_referenceSurface, SpaceDim, PolynomialIF::value(), and value().

virtual Real ReferenceHeightIF::value ( const IndexTM< Real, GLOBALDIM > &  a_point  )  const [inline, virtual]

Return the value of the function at a_point (of type INdexTM).

Reimplemented from BaseIF.

References m_implicitFunction, and BaseIF::value().

virtual ReferenceHeightIF* ReferenceHeightIF::newImplicitFunction (  )  const [inline, virtual]

Return a newly allocated derived class. The responsibility for deleting the memory is left to the calling function.

Implements BaseIF.

References m_implicitFunction, m_origin, m_referenceHeight, m_referenceSurface, and ReferenceHeightIF().

virtual void ReferenceHeightIF::print ( ostream &  a_out  )  const [inline, virtual]

Reimplemented from BaseIF.

References m_implicitFunction, and BaseIF::print().

Real ReferenceHeightIF::getReferenceHeight (  )  const [inline]

Return the reference height for this IF

References m_referenceHeight.

IndexTM<Real,GLOBALDIM> ReferenceHeightIF::getOrigin (  )  const [inline]

Return the physical origin of the domain

References m_origin.

void ReferenceHeightIF::getReferenceSurfacePolynomial ( Vector< PolyTerm > &  a_polynomial,
bool &  a_inside 
) const [inline]

Return the reference surface for this IF

References PolynomialIF::GetParams(), and m_referenceSurface.

Real ReferenceHeightIF::evaluateReferenceSurfacePolynomial ( const RealVect a_point  )  const [inline]

Evaluate the reference surface at a point

References m_referenceSurface, and PolynomialIF::value().

virtual void ReferenceHeightIF::boxLayoutChanged ( const DisjointBoxLayout a_newBoxLayout,
const RealVect a_dx 
) [inline, virtual]

Pass this call onto the IFs contained in this IF class.

Reimplemented from BaseIF.

References BaseIF::boxLayoutChanged(), m_implicitFunction, and m_referenceSurface.

BaseIF* ReferenceHeightIF::getPointer2IF (  )  const [inline]

return the pointer to the implicit function m_implicitFunction

References m_implicitFunction.

ReferenceHeightIF* ReferenceHeightIF::newChangedIF ( const BaseIF a_newIF  )  const [inline]

bool ReferenceHeightIF::hasReferenceSurface (  )  const [inline]

References m_referenceSurface.


Member Data Documentation


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

Generated on Wed Mar 29 03:43:05 2017 for Chombo + EB by  doxygen 1.5.5