HyperPlaneIF Class Reference

#include <HyperPlaneIF.H>

Inheritance diagram for HyperPlaneIF:

Public Member Functions
	HyperPlaneIF (const IndexTM< Real, GLOBALDIM > &a_normal, const IndexTM< Real, GLOBALDIM > &a_point, const bool &a_normalIn)
	HyperPlaneIF (const HyperPlaneIF &a_inputIF)
	Copy constructor. More...
virtual	~HyperPlaneIF ()
	Destructor. More...
virtual 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 IndexTM< Real, GLOBALDIM >	normal (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual Vector< IndexTM< Real, GLOBALDIM > >	gradNormal (const IndexTM< Real, GLOBALDIM > &a_point) const
virtual BaseIF *	newImplicitFunction () const
Public Member Functions inherited from BaseIF
	BaseIF ()
	Default constructor. More...
virtual	~BaseIF ()
	Default destructor. More...
virtual IndMomSpaceDim	getExactVolumeMoments (const VolIndex &a_vof, const Real &a_dx) const
	return int x^p dV for the vof More...
virtual IndMomSpaceDim	getExactEBMoments (const VolIndex &a_vof, const Real &a_dx) const
	return int_eb x^p dA for the eb More...
virtual IndMomSpaceDim	getExactEBNormalMoments (const VolIndex &a_vof, const Real &a_dx, const int &a_ni) const
	return int_eb x^p n_i dA for the eb More...
virtual IndMomSpaceDim	getExactEBNormalPartialDerivs (const VolIndex &a_vof, const Real &a_dx, const int &a_ni) const
virtual IndMomSDMinOne	getExactFaceMoments (const FaceIndex &a_face, const Real &a_dx) const
	return int x^p dA for the face More...
virtual Real	derivative (const IntVect &a_deriv, const RealVect &a_point) const
	return the partial derivative at the point More...
virtual Real	value (const IntVect &a_deriv, const RealVect &a_point) const
virtual bool	fastIntersection (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
virtual bool	fastIntersection (const RealVect &a_low, const RealVect &a_high) const
virtual GeometryService::InOut	InsideOutside (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
virtual GeometryService::InOut	InsideOutside (const RealVect &a_low, const RealVect &a_high) const
virtual Real	derivative (const IndexTM< int, GLOBALDIM > &a_deriv, const IndexTM< Real, GLOBALDIM > &a_point) const
virtual void	print (ostream &out) const
virtual void	makeGrids (const ProblemDomain &a_domain, DisjointBoxLayout &a_grids, const int &a_maxGridSize, const int &a_maxIrregGridSize)
virtual void	boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)

Public Attributes
IndexTM< Real, GLOBALDIM >	m_normal
IndexTM< Real, GLOBALDIM >	m_point
bool	m_normalIn

Private Member Functions
	HyperPlaneIF ()
void	operator= (const HyperPlaneIF &a_inputIF)

Additional Inherited Members
Static Public Member Functions inherited from BaseIF
static void	corners (const Box &a_region, const RealVect &a_origin, const Real &a_dx, RealVect &a_lo, RealVect &a_hi)

Detailed Description

This implicit function specifies a plane templated in dimension.

Constructor & Destructor Documentation

HyperPlaneIF() [1/3]

HyperPlaneIF::HyperPlaneIF	(	const IndexTM< Real, GLOBALDIM > &	a_normal,
		const IndexTM< Real, GLOBALDIM > &	a_point,
		const bool &	a_normalIn
	)

Constructor specifying the coefficients of the plane normal, a_normal, and a point on the plane, a_point.

HyperPlaneIF() [2/3]

HyperPlaneIF::HyperPlaneIF

(

const HyperPlaneIF &

a_inputIF

)

Copy constructor.

~HyperPlaneIF()

virtual HyperPlaneIF::~HyperPlaneIF ( )

virtual

Destructor.

HyperPlaneIF() [3/3]

HyperPlaneIF::HyperPlaneIF ( )

inlineprivate

References MayDay::Abort().

Member Function Documentation

value() [1/3]

virtual Real HyperPlaneIF::value ( const IndexTM< int, GLOBALDIM > &  a_partialDerivative, const IndexTM< Real, GLOBALDIM > &  a_point  ) const

virtual

Return the value of the function at a_point.

Reimplemented from BaseIF.

value() [2/3]

virtual Real HyperPlaneIF::value ( const RealVect &  a_point ) const

virtual

Return the value of the function at a_point. When delineating a domain, the level set value=0 represents the boundary and value<0 is inside the fluid.

Implements BaseIF.

value() [3/3]

virtual Real HyperPlaneIF::value ( const IndexTM< Real, GLOBALDIM > &  a_point ) const

virtual

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

Reimplemented from BaseIF.

normal()

virtual IndexTM<Real,GLOBALDIM> HyperPlaneIF::normal ( const IndexTM< Real, GLOBALDIM > &  a_point ) const

virtual

gradNormal()

virtual Vector<IndexTM<Real,GLOBALDIM> > HyperPlaneIF::gradNormal ( const IndexTM< Real, GLOBALDIM > &  a_point ) const

virtual

newImplicitFunction()

virtual BaseIF* HyperPlaneIF::newImplicitFunction ( ) const

virtual

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

Implements BaseIF.

operator=()

void HyperPlaneIF::operator= ( const HyperPlaneIF &  a_inputIF )

inlineprivate

References MayDay::Abort().

Member Data Documentation

m_normal

IndexTM<Real,GLOBALDIM> HyperPlaneIF::m_normal

m_point

IndexTM<Real,GLOBALDIM> HyperPlaneIF::m_point

m_normalIn

bool HyperPlaneIF::m_normalIn

---

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

• HyperPlaneIF.H