ProfileCylinderIF Class Reference

Implicit function which takes the form of a cylinder with a surface profiles (grooves). More...

#include <CD_ProfileCylinderIF.H>

Inheritance diagram for ProfileCylinderIF:

Collaboration diagram for ProfileCylinderIF:

Public Member Functions
	ProfileCylinderIF ()=delete
	No weak construction, use the full constructor.
	ProfileCylinderIF (const RealVect &a_endPoint1, const RealVect &a_endPoint2, const Real a_cylinderRadius, const Real a_torusMajorRadius, const Real a_torusMinorRadius, const Real a_ccDistance, const Real a_shift, const Real a_roundingRadius, const int a_numLeft, const int a_numRight, const bool a_fluidInside)
	Full constructor.
	ProfileCylinderIF (const ProfileCylinderIF &a_inputIF)
	Copy constructor.
virtual	~ProfileCylinderIF ()
	Destructor (does nothing)
virtual Real	value (const RealVect &a_pos) const override
	Value function. Returns distance to object.
virtual BaseIF *	newImplicitFunction () const override
	Factory method.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseIF
	Implicit function. This is an intersection between a cylinder and several torii.

Detailed Description

Implicit function which takes the form of a cylinder with a surface profiles (grooves).

The grooves are torii that are cut out of the cylinder. Use the input parameters to adjust the height, distance, and width of the grooves.

Note

This is a 3D object only!

Constructor & Destructor Documentation

ProfileCylinderIF() [1/2]

ProfileCylinderIF::ProfileCylinderIF	(	const RealVect &	a_endPoint1,
		const RealVect &	a_endPoint2,
		const Real	a_cylinderRadius,
		const Real	a_torusMajorRadius,
		const Real	a_torusMinorRadius,
		const Real	a_ccDistance,
		const Real	a_shift,
		const Real	a_roundingRadius,
		const int	a_numLeft,
		const int	a_numRight,
		const bool	a_fluidInside
	)

Full constructor.

Parameters

[in]	a_endPoint1	Endpoint of cylinder
[in]	a_endPoint2	Other endpoint of cylinder
[in]	a_cylinderRadius	Cylinder radius
[in]	a_torusMajorRadius	Major radius of torii
[in]	a_ccDistance	Distance between torii
[in]	a_shift	Shift groove pattern along the axis (relative to cylinder center)
[in]	a_roundingRadius	Rounding radius on geometry
[in]	a_numLeft	Number of torii to the left of the centerpoint
[in]	a_numRight	Number of torii to the right of the centerpoint
[in]	a_fluidInside	Fluid on inside or not
[in]	a_torusMinorRadius	Description

ProfileCylinderIF() [2/2]

ProfileCylinderIF::ProfileCylinderIF

(

const ProfileCylinderIF &

a_inputIF

)

Copy constructor.

Parameters

[in]

a_inputIF

Other cylinder

Member Function Documentation

newImplicitFunction()

BaseIF * ProfileCylinderIF::newImplicitFunction ( ) const

overridevirtual

Factory method.

Returns

New copy of this implicit function

value()

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

overridevirtual

Value function. Returns distance to object.

Parameters

[in]

a_pos

Position

Returns

Function value at the given point

---

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

• Source/ImplicitFunctions/CD_ProfileCylinderIF.H
• Source/ImplicitFunctions/CD_ProfileCylinderIF.cpp