ProfilePlaneIF Class Reference

Implicit function which represents an infinite half-plane with "holes". More...

#include <CD_ProfilePlaneIF.H>

Inheritance diagram for ProfilePlaneIF:

Collaboration diagram for ProfilePlaneIF:

Public Member Functions
	ProfilePlaneIF ()=delete
	Disallowed weak construction.
	ProfilePlaneIF (const RealVect &a_point, const Real a_width, const BaseIF *a_impFunc, const int a_num_left, const int a_num_right, const Real a_ccDist, const Real a_xShift, const Real a_yShift, const Real a_curv, const bool a_fluidInside)
	Full constructor.
	ProfilePlaneIF (const ProfilePlaneIF &a_inputIF)
	Copy constructor.
virtual	~ProfilePlaneIF ()
	Destructor.
virtual Real	value (const RealVect &a_pos) const
	Level-set function.
virtual BaseIF *	newImplicitFunction () const
	Factory method.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseif
	Baseif.
bool	m_fluidInside
	Fluid inside.

Detailed Description

Implicit function which represents an infinite half-plane with "holes".

Note

This is currently limited to 2D.

Constructor & Destructor Documentation

ProfilePlaneIF() [1/2]

ProfilePlaneIF::ProfilePlaneIF	(	const RealVect &	a_point,
		const Real	a_width,
		const BaseIF *	a_impFunc,
		const int	a_num_left,
		const int	a_num_right,
		const Real	a_ccDist,
		const Real	a_xShift,
		const Real	a_yShift,
		const Real	a_curv,
		const bool	a_fluidInside
	)

Full constructor.

Parameters

[in]	a_point	Point on the plane
[in]	a_width	Box width
[in]	a_impFunc	Implicit function to extract from the box
[in]	a_num_left	Number of holes to the left (of the centerpoint)
[in]	a_num_right	Number of holes to the right (of the centerpoint)
[in]	a_ccDist	Distance between holes
[in]	a_xShift	Profile shift to the left/right (relative to centerponit)
[in]	a_yShift	Profile shift up/down (relative to centerponit)
[in]	a_curv	Corner curvatures
[in]	a_fluidInside	Fluid on inside or not

ProfilePlaneIF() [2/2]

ProfilePlaneIF::ProfilePlaneIF

(

const ProfilePlaneIF &

a_inputIF

)

Copy constructor.

Parameters

[in]

a_inputIF

Other plane

Member Function Documentation

newImplicitFunction()

BaseIF * ProfilePlaneIF::newImplicitFunction ( ) const

virtual

Factory method.

Returns

New implicit function

value()

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

virtual

Level-set 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_ProfilePlaneIF.H
• Source/ImplicitFunctions/CD_ProfilePlaneIF.cpp