Chombo + EB  3.0
Public Member Functions | Protected Attributes | Private Member Functions | List of all members
PlaneIF Class Reference

#include <PlaneIF.H>

Inheritance diagram for PlaneIF:
Inheritance graph
[legend]

Public Member Functions

 PlaneIF (const RealVect &a_normal, const RealVect &a_point, const bool &a_inside)
 
 PlaneIF (const PlaneIF &a_inputIF)
 Copy constructor. More...
 
virtual ~PlaneIF ()
 Destructor. More...
 
virtual void GetParams (RealVect &a_normal, RealVect &a_point, bool &a_inside) const
 
virtual void SetParams (const RealVect &a_normal, const RealVect &a_point, const bool &a_inside)
 
virtual Real value (const RealVect &a_point) const
 
virtual BaseIFnewImplicitFunction () const
 
virtual bool fastIntersection (const RealVect &a_low, const RealVect &a_high) const
 
virtual GeometryService::InOut InsideOutside (const RealVect &a_low, const RealVect &a_high) const
 
- Public Member Functions inherited from BaseIF
 BaseIF ()
 Default constructor. More...
 
virtual ~BaseIF ()
 Default destructor. More...
 
virtual Real value (const IndexTM< int, GLOBALDIM > &a_partialDerivative, const IndexTM< Real, GLOBALDIM > &a_point) const
 
virtual bool fastIntersection (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
 
virtual GeometryService::InOut InsideOutside (const Box &a_region, const ProblemDomain &a_domain, const RealVect &a_origin, const Real &a_dx) const
 
virtual Real value (const IndexTM< Real, GLOBALDIM > &a_point) const
 
virtual void print (ostream &out) const
 
virtual void boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)
 

Protected Attributes

RealVect m_normal
 
RealVect m_point
 
bool m_inside
 

Private Member Functions

 PlaneIF ()
 
void operator= (const PlaneIF &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.

Constructor & Destructor Documentation

PlaneIF::PlaneIF ( const RealVect a_normal,
const RealVect a_point,
const bool &  a_inside 
)

Constructor specifying plane normal (a_normal), a point on the plance (a_point), and whether the domain is the same side as the normal (a_inside).

PlaneIF::PlaneIF ( const PlaneIF a_inputIF)

Copy constructor.

virtual PlaneIF::~PlaneIF ( )
virtual

Destructor.

PlaneIF::PlaneIF ( )
inlineprivate

References MayDay::Abort().

Member Function Documentation

virtual void PlaneIF::GetParams ( RealVect a_normal,
RealVect a_point,
bool &  a_inside 
) const
virtual

Return the parameter information

virtual void PlaneIF::SetParams ( const RealVect a_normal,
const RealVect a_point,
const bool &  a_inside 
)
virtual

Set the parameter information

virtual Real PlaneIF::value ( const RealVect a_point) const
virtual

Return the value of the function at a_point.

Implements BaseIF.

virtual BaseIF* PlaneIF::newImplicitFunction ( ) const
virtual

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

Implements BaseIF.

virtual bool PlaneIF::fastIntersection ( const RealVect a_low,
const RealVect a_high 
) const
inlinevirtual

Reimplemented from BaseIF.

virtual GeometryService::InOut PlaneIF::InsideOutside ( const RealVect a_low,
const RealVect a_high 
) const
virtual

Reimplemented from BaseIF.

void PlaneIF::operator= ( const PlaneIF a_inputIF)
inlineprivate

References MayDay::Abort().

Member Data Documentation

RealVect PlaneIF::m_normal
protected
RealVect PlaneIF::m_point
protected
bool PlaneIF::m_inside
protected

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