HelicoilIF Class Reference

#include <HelicoilIF.H>

Inheritance diagram for HelicoilIF:

[legend]

List of all members.

---

Detailed Description

In 3D this is an approximation of a circle swept around a helix which is always in the plane normal to the tangent of the helix. If the slope of the helix is less than 1.0, this is achieved by sweeping an ellipse oriented vertically along a helix. If the slope is greater than or equal to 1.0, this is achieved by sweeping an ellipse oriented horizontally along a helix. The eccentricity of the ellipse is adjusted based on the slope.

In 2D this is an ellipse offset from the origin.

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 ()
	Destructor.
virtual Real	value (const RealVect &a_point) const
virtual BaseIF *	newImplicitFunction () const
virtual void	boxLayoutChanged (const DisjointBoxLayout &a_newBoxLayout, const RealVect &a_dx)
Protected Attributes
Real	m_helixR
Real	m_helixPitch
Real	m_circleR
bool	m_inside
Real	m_ellipseR
bool	m_vertical
BaseIF *	m_helixIF
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]

Destructor.

HelicoilIF::HelicoilIF

(

)

[inline, private]

References MayDay::Abort().

---

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.

virtual void HelicoilIF::boxLayoutChanged	(	const DisjointBoxLayout &	a_newBoxLayout,
		const RealVect &	a_dx
	)			[inline, virtual]

Pass this call onto the IFs contained in this IF class.

Reimplemented from BaseIF.

References BaseIF::boxLayoutChanged(), and m_helixIF.

void HelicoilIF::operator=

(

const HelicoilIF &

a_inputIF

)

[inline, private]

References MayDay::Abort().

---

Member Data Documentation

Real HelicoilIF::m_helixR [protected]

Real HelicoilIF::m_helixPitch [protected]

Real HelicoilIF::m_circleR [protected]

bool HelicoilIF::m_inside [protected]

Real HelicoilIF::m_ellipseR [protected]

bool HelicoilIF::m_vertical [protected]

BaseIF* HelicoilIF::m_helixIF [protected]

Referenced by boxLayoutChanged().

---

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

• HelicoilIF.H