HelixIF Class Reference

#include <HelixIF.H>

Inheritance diagram for HelixIF:

Inheritance graph
Collaboration diagram for HelixIF:

Collaboration graph

List of all members.

Detailed Description

This implicit function takes one implicit function and spirals it in 3D. In 2D the implicit function is simply returned.

In 3D, the given function is restricted to to the x-y plane (z = 0), and this restricted function is rotated around the z-axis at the specified rate as z changes.

In 2D, the given function is simply returned.

Public Member Functions

 HelixIF (const BaseIF &a_impFunc, const Real &a_rate, const bool &a_inside)
 HelixIF (const HelixIF &a_inputIF)
 Copy constructor.
virtual ~HelixIF ()
virtual Real value (const RealVect &a_point) const
virtual BaseIFnewImplicitFunction () const

Protected Attributes

Real m_rate
bool m_inside

Private Member Functions

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

Constructor & Destructor Documentation

HelixIF::HelixIF ( const BaseIF a_impFunc,
const Real a_rate,
const bool &  a_inside 

Constructor specifying one implicit function to be rotated, the rotation rate, and whether the domain is on the inside (a_inside), i.e. where the function is negative.

HelixIF::HelixIF ( const HelixIF a_inputIF  ) 

Copy constructor.

virtual HelixIF::~HelixIF (  )  [virtual]


HelixIF::HelixIF (  )  [inline, private]

References MayDay::Error().

Member Function Documentation

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

Return the value of the function at a_point.

Implements BaseIF.

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

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

Implements BaseIF.

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

References MayDay::Error().

Member Data Documentation

BaseIF* HelixIF::m_impFunc [protected]

Real HelixIF::m_rate [protected]

bool HelixIF::m_inside [protected]

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

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