TorusIF Class Reference

#include <TorusIF.H>

Inheritance diagram for TorusIF:

Public Member Functions
	TorusIF (const Real &a_majorRadius, const Real &a_minorRadius, const RealVect &a_center, const bool &a_inside)
	TorusIF (const TorusIF &a_inputIF)
	Copy constructor. More...
virtual	~TorusIF ()
	Destructor. More...
virtual void	GetParams (Real &a_majorRadius, Real &a_minorRadius, RealVect &a_center, bool &a_inside) const
virtual void	SetParams (const Real &a_majorRadius, const Real &a_minorRadius, const RealVect &a_center, const bool &a_inside)
virtual Real	value (const RealVect &a_point) const
virtual BaseIF *	newImplicitFunction () 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 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	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
Real	m_majorRadius
Real	m_minorRadius
RealVect	m_center
bool	m_inside
Real	m_minorRadius2

Private Member Functions
	TorusIF ()
void	operator= (const TorusIF &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 torus whose axis is parallel to the z-axis

Constructor & Destructor Documentation

TorusIF() [1/3]

TorusIF::TorusIF	(	const Real &	a_majorRadius,
		const Real &	a_minorRadius,
		const RealVect &	a_center,
		const bool &	a_inside
	)

Constructor specifying torus major radius (a_majorRadius), minor radius (a_minorRadius), center (a_center), and whether the domain is on the inside (a_inside).

TorusIF() [2/3]

TorusIF::TorusIF

(

const TorusIF &

a_inputIF

)

Copy constructor.

~TorusIF()

virtual TorusIF::~TorusIF ( )

virtual

Destructor.

TorusIF() [3/3]

TorusIF::TorusIF ( )

inlineprivate

References MayDay::Abort().

Member Function Documentation

GetParams()

virtual void TorusIF::GetParams ( Real &  a_majorRadius, Real &  a_minorRadius, RealVect &  a_center, bool &  a_inside  ) const

virtual

Return the parameter information

SetParams()

virtual void TorusIF::SetParams ( const Real &  a_majorRadius, const Real &  a_minorRadius, const RealVect &  a_center, const bool &  a_inside  )

virtual

Set the parameter information

value()

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

virtual

Return the value of the function at a_point.

Implements BaseIF.

newImplicitFunction()

virtual BaseIF* TorusIF::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 TorusIF::operator= ( const TorusIF &  a_inputIF )

inlineprivate

References MayDay::Abort().

Member Data Documentation

m_majorRadius

Real TorusIF::m_majorRadius

protected

m_minorRadius

Real TorusIF::m_minorRadius

protected

m_center

RealVect TorusIF::m_center

protected

m_inside

bool TorusIF::m_inside

protected

m_minorRadius2

Real TorusIF::m_minorRadius2

protected

---

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

• TorusIF.H