MushroomIF Class Reference

"Mushroom" implicit function. Consists of a cylinder with a circular plate on top. More...

#include <CD_MushroomIF.H>

Inheritance diagram for MushroomIF:

Collaboration diagram for MushroomIF:

Public Member Functions
	MushroomIF (const RealVect &a_center, const Real a_R, const Real a_r, const Real a_L, const Real a_d, const Real a_curv, const bool a_fluidInside)
	Full constructor.
	MushroomIF (const MushroomIF &a_inputIF)
	Copy constructor.
virtual	~MushroomIF ()
	Destructor (does nothing)
virtual Real	value (const RealVect &a_pos) const override
	Value function.
virtual BaseIF *	newImplicitFunction () const override
	Factory function.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseIF
	Implicit function – this is a smooth union between the foot and the circular plate.
bool	m_fluidInside
	Fluid on the inside or not.

Detailed Description

"Mushroom" implicit function. Consists of a cylinder with a circular plate on top.

Oriented along +z in 3D and +y in 2D.

Constructor & Destructor Documentation

MushroomIF() [1/2]

MushroomIF::MushroomIF	(	const RealVect &	a_center,
		const Real	a_R,
		const Real	a_r,
		const Real	a_L,
		const Real	a_d,
		const Real	a_curv,
		const bool	a_fluidInside
	)

Full constructor.

Parameters

[in]	a_center	Center point of the circular platew
[in]	a_R	Radius of the flat plate.
[in]	a_r	Radius of the cylinder foot
[in]	a_L	Length of the cylinder foot
[in]	a_d	Plate thickness
[in]	a_curv	Corner curvature
[in]	a_fluidInside	Fluid on inside or not

MushroomIF() [2/2]

MushroomIF::MushroomIF

(

const MushroomIF &

a_inputIF

)

Copy constructor.

Parameters

[in]

a_inputIF

Other input

Member Function Documentation

newImplicitFunction()

BaseIF * MushroomIF::newImplicitFunction ( ) const

overridevirtual

Factory function.

Returns

Returns new MushroomIF object, casted to BaseIF*

value()

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

overridevirtual

Value function.

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_MushroomIF.H
• Source/ImplicitFunctions/CD_MushroomIF.cpp