PerlinSlabSdf Class Reference

Implicit function class describing a slab (box) with surface noise on the top. More...

#include <CD_PerlinSlabSdf.H>

Inheritance diagram for PerlinSlabSdf:

Collaboration diagram for PerlinSlabSdf:

Public Member Functions
	PerlinSlabSdf ()=delete
	No weak constructor allowed, use the full constructor.
	PerlinSlabSdf (const RealVect &a_ccPoint, const RealVect &a_normal, const RealVect &a_xyz, const RealVect &a_noiseFreq, const int a_octaves, const Real a_noiseAmp, const Real a_persistence, const Real a_cornerCurv, const bool a_reseed, const bool a_fluidInside)
	Constructor.
	PerlinSlabSdf (const PerlinSlabSdf &a_inputIF)
	Copy constructor. Copies over implicit function.
virtual	~PerlinSlabSdf ()
	Destructor (does nothing)
virtual Real	value (const RealVect &a_pos) const override
	Value function. Returns distance to object.
virtual BaseIF *	newImplicitFunction () const override
	Factory function.

Protected Attributes
RefCountedPtr< BaseIF >	m_baseif
	Implicit function. This is a union between cutting planes and a perlin plane.
bool	m_fluidInside
	Fluid on inside or not.

Detailed Description

Implicit function class describing a slab (box) with surface noise on the top.

Constructor & Destructor Documentation

PerlinSlabSdf() [1/2]

PerlinSlabSdf::PerlinSlabSdf	(	const RealVect &	a_ccPoint,
		const RealVect &	a_normal,
		const RealVect &	a_xyz,
		const RealVect &	a_noiseFreq,
		const int	a_octaves,
		const Real	a_noiseAmp,
		const Real	a_persistence,
		const Real	a_cornerCurv,
		const bool	a_reseed,
		const bool	a_fluidInside
	)

Constructor.

Parameters

[in]	a_ccPoint	Center point on the slab side with surface noise
[in]	a_normal	Normal vector of slab side with surface noise
[in]	a_xyz	Width, depth, and height of slab
[in]	a_noiseFreq	Noise frequency
[in]	a_octaves	Number of octaves
[in]	a_noiseAmp	Noise amplitude
[in]	a_persistence	Factor for noise octaves.
[in]	a_cornerCurv	Corner curvatures
[in]	a_reseed	If true, reseed the RNG. Otherwise, the the original Perlin hash table.

Note

The persistence argument indicates how we add octaves. With 0.5 we use half the amplitude and twice the frequency for the next octave.

Parameters

[in]

a_fluidInside

Fluid on inside or not

PerlinSlabSdf() [2/2]

PerlinSlabSdf::PerlinSlabSdf

(

const PerlinSlabSdf &

a_inputIF

)

Copy constructor. Copies over implicit function.

Parameters

[in,out]

a_inputIF

Description

Member Function Documentation

newImplicitFunction()

BaseIF * PerlinSlabSdf::newImplicitFunction ( ) const

overridevirtual

Factory function.

Returns

New copy of this implicit function

value()

Real PerlinSlabSdf::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_PerlinSlabSdf.H
• Source/ImplicitFunctions/CD_PerlinSlabSdf.cpp