PolarIF Class Reference

#include <PolarIF.H>

Inheritance diagram for PolarIF:

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. More...
virtual	~PolarIF ()
	Destructor. More...
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 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_primaryRadius
Real	m_perturbation
int	m_frequency
bool	m_inside

Private Member Functions
	PolarIF ()
void	operator= (const PolarIF &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 cylinder in polar coordinates: r = a_primaryRadius + a_perturbation*cos(a_frequency*theta)

Constructor & Destructor Documentation

PolarIF() [1/3]

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

PolarIF() [2/3]

PolarIF::PolarIF

(

const PolarIF &

a_inputIF

)

Copy constructor.

~PolarIF()

virtual PolarIF::~PolarIF ( )

virtual

Destructor.

PolarIF() [3/3]

PolarIF::PolarIF ( )

inlineprivate

References MayDay::Abort().

Member Function Documentation

GetParams()

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

virtual

Return the parameter information

SetParams()

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

value()

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

virtual

Return the value of the function at a_point.

Implements BaseIF.

newImplicitFunction()

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.

operator=()

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

inlineprivate

References MayDay::Abort().

Member Data Documentation

m_primaryRadius

Real PolarIF::m_primaryRadius

protected

m_perturbation

Real PolarIF::m_perturbation

protected

m_frequency

int PolarIF::m_frequency

protected

m_inside

bool PolarIF::m_inside

protected

---

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

• PolarIF.H