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

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. More...

	ProfileCylinderIF (const ProfileCylinderIF &a_inputIF)
	Copy constructor. More...

virtual	~ProfileCylinderIF ()
	Destructor (does nothing)

virtual Real	value (const RealVect &a_pos) const override
	Value function. Returns distance to object. More...

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.

Constructor & Destructor Documentation

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_torusMajorRadius	Minor 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

ProfileCylinderIF::ProfileCylinderIF ( const ProfileCylinderIF & a_inputIF )

Copy constructor.

Parameters

[in] a_inputIF Other cylinder

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

overridevirtual

Value function. Returns distance to object.

Parameters

[in] a_pos Position

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