TorusIF Class Reference

#include <TorusIF.H>

Inheritance diagram for TorusIF:

Inheritance graph
[legend]

List of all members.


Detailed Description

This implicit function specifies a torus whose axis is parallel to the z-axis

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.
virtual ~TorusIF ()
 Destructor.
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 BaseIFnewImplicitFunction () const

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)

Constructor & Destructor Documentation

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::TorusIF ( const TorusIF a_inputIF  ) 

Copy constructor.

virtual TorusIF::~TorusIF (  )  [virtual]

Destructor.

TorusIF::TorusIF (  )  [inline, private]

References MayDay::Abort().


Member Function Documentation

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

Return the parameter information

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

virtual Real TorusIF::value ( const RealVect a_point  )  const [virtual]

Return the value of the function at a_point.

Implements BaseIF.

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.

void TorusIF::operator= ( const TorusIF a_inputIF  )  [inline, private]

References MayDay::Abort().


Member Data Documentation

bool TorusIF::m_inside [protected]


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

Generated on Sat Jun 24 04:03:56 2017 for Chombo + EB by  doxygen 1.5.5