HelicoilIF Class Reference

#include <HelicoilIF.H>

Inheritance diagram for HelicoilIF:

Inheritance graph
Collaboration diagram for HelicoilIF:

Collaboration graph

List of all members.

Detailed Description

In 3D this is a circle swept around a helix which is always in the plane normal to the tangent of the helix.

In 2D this is an annulus.

Public Member Functions

 HelicoilIF (const Real &a_helixR, const Real &a_helixPitch, const Real &a_circleR, const bool &a_inside)
 HelicoilIF (const HelicoilIF &a_inputIF)
 Copy constructor.
virtual ~HelicoilIF ()
virtual Real value (const RealVect &a_point) const
virtual BaseIFnewImplicitFunction () const

Protected Attributes

Real m_helixR
Real m_helixPitch
Real m_circleR
Real m_circleR2
bool m_inside

Private Member Functions

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

Constructor & Destructor Documentation

HelicoilIF::HelicoilIF ( const Real a_helixR,
const Real a_helixPitch,
const Real a_circleR,
const bool &  a_inside 

Constructor specifying the helix radius, pitch, radius of the swept circle, and whether the domain is on the inside (a_inside), i.e. where the function is negative.

HelicoilIF::HelicoilIF ( const HelicoilIF a_inputIF  ) 

Copy constructor.

virtual HelicoilIF::~HelicoilIF (  )  [virtual]


HelicoilIF::HelicoilIF (  )  [inline, private]

References MayDay::Error().

Member Function Documentation

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

Return the value of the function at a_point.

Implements BaseIF.

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

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

Implements BaseIF.

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

References MayDay::Error().

Member Data Documentation

bool HelicoilIF::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