PolarIF Class Reference

#include <PolarIF.H>

Inheritance diagram for PolarIF:

Inheritance graph
[legend]
Collaboration diagram for PolarIF:

Collaboration graph
[legend]

List of all members.


Detailed Description

This implicit function specifies a cylinder in polar coordinates: r = a_primaryRadius + a_perturbation*cos(a_frequency*theta)

Public Member Functions

 PolarIF (const Real &a_primaryRadius, const Real &a_perturbation, const int &a_frequency, const bool &a_inside)
 PolarIF (const PolarIF &a_inputIF)
 Copy constructor.
virtual ~PolarIF ()
 Destructor.
virtual void GetParams (Real &a_primaryRadius, Real &a_perturbation, int &a_frequency, bool &a_inside) const
virtual void SetParams (const Real &a_primaryRadius, const Real &a_perturbation, const int &a_frequency, const bool &a_inside)
virtual Real value (const RealVect &a_point) const
virtual BaseIFnewImplicitFunction () const

Protected Attributes

Real m_primaryRadius
Real m_perturbation
int m_frequency
bool m_inside

Private Member Functions

 PolarIF ()
void operator= (const PolarIF &a_inputIF)

Constructor & Destructor Documentation

PolarIF::PolarIF ( const Real a_primaryRadius,
const Real a_perturbation,
const int &  a_frequency,
const bool &  a_inside 
)

PolarIF::PolarIF ( const PolarIF a_inputIF  ) 

Copy constructor.

virtual PolarIF::~PolarIF (  )  [virtual]

Destructor.

PolarIF::PolarIF (  )  [inline, private]

References MayDay::Error().


Member Function Documentation

virtual void PolarIF::GetParams ( Real a_primaryRadius,
Real a_perturbation,
int &  a_frequency,
bool &  a_inside 
) const [virtual]

Return the parameter information

virtual void PolarIF::SetParams ( const Real a_primaryRadius,
const Real a_perturbation,
const int &  a_frequency,
const bool &  a_inside 
) [virtual]

Set the parameter information

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

Return the value of the function at a_point.

Implements BaseIF.

virtual BaseIF* PolarIF::newImplicitFunction (  )  const [virtual]

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

Implements BaseIF.

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

References MayDay::Error().


Member Data Documentation

int PolarIF::m_frequency [protected]

bool PolarIF::m_inside [protected]


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

Generated on Tue Apr 14 14:23:54 2009 for Chombo + EB by  doxygen 1.5.5