HollowCylinderIF Class Reference

This class is used to generate a hollow cylinder with rounded edges. More...

#include <CD_HollowCylinderIF.H>

Inheritance diagram for HollowCylinderIF:

Collaboration diagram for HollowCylinderIF:

Public Member Functions
	HollowCylinderIF ()=delete
	Disallowed weak construction.
	HollowCylinderIF (const RealVect &a_center1, const RealVect &a_center2, const Real a_majorRadius, const Real a_minorRadius, const Real a_outerCurvature, const Real a_innerCurvature, const bool a_fluidInside)
	Full constructor.
	HollowCylinderIF (const HollowCylinderIF &a_inputIF)
	Copy constructor.
virtual Real	value (const RealVect &a_point) const override
	Test whether inside or not.
virtual BaseIF *	newImplicitFunction () const override
	IF factory method.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseIF
	3D object rotated and translated to its specified position

Detailed Description

This class is used to generate a hollow cylinder with rounded edges.

Constructor & Destructor Documentation

HollowCylinderIF() [1/2]

HollowCylinderIF::HollowCylinderIF	(	const RealVect &	a_center1,
		const RealVect &	a_center2,
		const Real	a_majorRadius,
		const Real	a_minorRadius,
		const Real	a_outerCurvature,
		const Real	a_innerCurvature,
		const bool	a_fluidInside
	)

Full constructor.

Parameters

[in]	a_center1	One cylinder end
[in]	a_center2	Other cylinder end
[in]	a_majorRadius	Outer cylinder radius
[in]	a_minorRadius	Inner radius
[in]	a_outerCurvature	Outer curvature
[in]	a_innerCurvature	Inner curvature
[in]	a_fluidInside	Fluid inside or not

HollowCylinderIF() [2/2]

HollowCylinderIF::HollowCylinderIF

(

const HollowCylinderIF &

a_inputIF

)

Copy constructor.

Parameters

[in]

a_inputIF

Input hollow cylinder

Member Function Documentation

newImplicitFunction()

BaseIF * HollowCylinderIF::newImplicitFunction ( ) const

overridevirtual

IF factory method.

Returns

New copy of this implicit function

value()

Real HollowCylinderIF::value ( const RealVect &  a_point ) const

overridevirtual

Test whether inside or not.

Parameters

[in]

a_point

Physical position.

Returns

Function value at the given point

---

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

• Source/ImplicitFunctions/CD_HollowCylinderIF.H
• Source/ImplicitFunctions/CD_HollowCylinderIF.cpp