PolygonRodIF Class Reference

Implicit function class describing a rod with a polygonal cross section. More...

#include <CD_PolygonRodIF.H>

Inheritance diagram for PolygonRodIF:

Collaboration diagram for PolygonRodIF:

Public Member Functions
	PolygonRodIF (const RealVect &a_endPoint1, const RealVect &a_endPoint2, const Real a_radius, const Real a_cornerCurv, const int a_numSides, const bool a_fluidInside)
	Base constructor.
	PolygonRodIF (const PolygonRodIF &a_inputIF)
	Copy constructor.
virtual	~PolygonRodIF ()
	Destructor.
virtual Real	value (const RealVect &a_pos) const
	Value function. Returns distance to object (ish).
virtual BaseIF *	newImplicitFunction () const
	Factory method.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseif
	Base function.

Detailed Description

Implicit function class describing a rod with a polygonal cross section.

Note

This is a 3D object only!

Constructor & Destructor Documentation

PolygonRodIF() [1/2]

PolygonRodIF::PolygonRodIF	(	const RealVect &	a_endPoint1,
		const RealVect &	a_endPoint2,
		const Real	a_radius,
		const Real	a_cornerCurv,
		const int	a_numSides,
		const bool	a_fluidInside
	)

Base constructor.

Parameters

[in]	a_endPoint1	One endpoint
[in]	a_endPoint2	Other endpoint
[in]	a_radius	Outer radius
[in]	a_cornerCurv	Rounding radius on corners
[in]	a_numSides	Number of sides
[in]	a_fluidInside	Fluid on inside or not

PolygonRodIF() [2/2]

PolygonRodIF::PolygonRodIF

(

const PolygonRodIF &

a_inputIF

)

Copy constructor.

Parameters

[in]

a_inputIF

Another polygon rod

Member Function Documentation

newImplicitFunction()

BaseIF * PolygonRodIF::newImplicitFunction ( ) const

virtual

Factory method.

Returns

New copy of this implicit function

value()

Real PolygonRodIF::value ( const RealVect &  a_pos ) const

virtual

Value function. Returns distance to object (ish).

Returns

Function value at the given point

Parameters

[in,out]

a_pos

Description

---

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

• Source/ImplicitFunctions/CD_PolygonRodIF.H
• Source/ImplicitFunctions/CD_PolygonRodIF.cpp