ReferenceHeightIF Class Reference

#include <ReferenceHeightIF.H>

Inheritance diagram for ReferenceHeightIF:

Inheritance graph
[legend]
Collaboration diagram for ReferenceHeightIF:

Collaboration 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)
virtual ~ReferenceHeightIF ()
 Destructor cleans up the member implicit function.
virtual Real value (const RealVect &a_point) const
virtual Real value (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual IndexTM< Real, GLOBALDIM > grad (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual IndexTM< Real, GLOBALDIM > normal (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Vector< IndexTM< Real,
GLOBALDIM > > 
gradGrad (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Vector< IndexTM< Real,
GLOBALDIM > > 
gradNormal (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual ReferenceHeightIFnewImplicitFunction () const
Real getReferenceHeight () const

Private Member Functions

 ReferenceHeightIF ()

Private Attributes

BaseIFm_implicitFunction
Real m_referenceHeight

Constructor & Destructor Documentation

ReferenceHeightIF::ReferenceHeightIF ( const BaseIF a_implicitFunction,
const Real a_referenceHeight 
) [inline]

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

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

Destructor cleans up the member implicit function.

References m_implicitFunction.

ReferenceHeightIF::ReferenceHeightIF (  )  [inline, private]

Referenced by newImplicitFunction().


Member Function Documentation

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 GLOBALDIM, m_referenceHeight, and SpaceDim.

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 IndexTM<Real,GLOBALDIM> ReferenceHeightIF::grad ( const IndexTM< Real, GLOBALDIM > &  a_point  )  const [inline, virtual]

Return the gradient of the function at a_point.

Reimplemented from BaseIF.

References BaseIF::grad(), and m_implicitFunction.

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

Return the normalized gradient of the function at a_point.

Reimplemented from BaseIF.

References m_implicitFunction, and BaseIF::normal().

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

Return the gradient of the gradient at a_point.

Reimplemented from BaseIF.

References BaseIF::gradGrad(), and m_implicitFunction.

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

Return the gradient of the normal at a_point.

Reimplemented from BaseIF.

References BaseIF::gradNormal(), and m_implicitFunction.

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_referenceHeight, and ReferenceHeightIF().

Real ReferenceHeightIF::getReferenceHeight (  )  const [inline]

Return the reference height for this IF

References m_referenceHeight.


Member Data Documentation


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

Generated on Tue Apr 14 14:23:57 2009 for Chombo + EB by  doxygen 1.5.5