HyperPlaneIF Class Reference
#include <HyperPlaneIF.H>
Inheritance diagram for HyperPlaneIF:
Detailed Description
This implicit function specifies a plane templated in dimension.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. | |
| virtual | ~HyperPlaneIF () |
| Destructor. | |
| 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 Attributes | |
| IndexTM< Real, GLOBALDIM > | m_normal |
| IndexTM< Real, GLOBALDIM > | m_point |
| bool | m_normalIn |
Private Member Functions | |
| HyperPlaneIF () | |
| void | operator= (const HyperPlaneIF &a_inputIF) |
Constructor & Destructor Documentation
| 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::HyperPlaneIF | ( | const HyperPlaneIF & | a_inputIF | ) |
Copy constructor.
| virtual HyperPlaneIF::~HyperPlaneIF | ( | ) | [virtual] |
Destructor.
| HyperPlaneIF::HyperPlaneIF | ( | ) | [inline, private] |
References MayDay::Abort().
Member Function Documentation
| 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.
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.
Return the value of the function at a_point (of type INdexTM).
Reimplemented from BaseIF.
| virtual IndexTM<Real,GLOBALDIM> HyperPlaneIF::normal | ( | const IndexTM< Real, GLOBALDIM > & | a_point | ) | const [virtual] |
| virtual Vector<IndexTM<Real,GLOBALDIM> > HyperPlaneIF::gradNormal | ( | const IndexTM< Real, GLOBALDIM > & | a_point | ) | const [virtual] |
| 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.
| void HyperPlaneIF::operator= | ( | const HyperPlaneIF & | a_inputIF | ) | [inline, private] |
References MayDay::Abort().
Member Data Documentation
| IndexTM<Real,GLOBALDIM> HyperPlaneIF::m_normal |
| IndexTM<Real,GLOBALDIM> HyperPlaneIF::m_point |
The documentation for this class was generated from the following file:
