RandomInterface::ClampedNoisePlane Class Reference

Clamped noisy plane signed distance function. More...

#include <CD_RandomInterface.H>

Inheritance diagram for RandomInterface::ClampedNoisePlane:

Collaboration diagram for RandomInterface::ClampedNoisePlane:

Public Member Functions
	ClampedNoisePlane ()=delete
	Disallowed weak construction.
	ClampedNoisePlane (const Vec3 &a_point, const Vec3 &a_normal, const Vec3 &a_clampLo, const Vec3 &a_clampHi, const Vec3 &a_clampDx, const Vec3 &a_noiseFrequency, const Real a_noiseAmplitude, const Real a_noisePersistence, const int a_noiseOctaves) noexcept
	Full constructor.
	~ClampedNoisePlane ()=default
	Destructor (does nothing)
template<class URNG >
void	shuffle (URNG &a_rng) noexcept
	Shuffle the permutation array.
virtual Real	signedDistance (const Vec3 &a_point) const noexcept override
	Signed distance function.

Protected Attributes
Vec3	m_point
	Point on plane.
Vec3	m_normal
	Plane normal vector.
Vec3	m_clampLo
	Low-end clamping.
Vec3	m_clampHi
	High-end clamping.
Vec3	m_clampDx
	Clamping length.
std::shared_ptr< EBGeometry::PlaneSDF< Real > >	m_plane
	Base implicit function.
std::shared_ptr< EBGeometry::PerlinSDF< Real > >	m_perlin
	Noise function.

Detailed Description

Clamped noisy plane signed distance function.

Constructor & Destructor Documentation

ClampedNoisePlane()

RandomInterface::ClampedNoisePlane::ClampedNoisePlane ( const Vec3 &  a_point, const Vec3 &  a_normal, const Vec3 &  a_clampLo, const Vec3 &  a_clampHi, const Vec3 &  a_clampDx, const Vec3 &  a_noiseFrequency, const Real  a_noiseAmplitude, const Real  a_noisePersistence, const int  a_noiseOctaves  )

noexcept

Full constructor.

Parameters

[in]	a_point	Point on plane
[in]	a_normal	Plane normal vector
[in]	a_clampLo	Clamping at low end
[in]	a_clampHi	Clamping at high
[in]	a_clampDx	Clamping length
[in]	a_noiseFrequency	Noise frequency
[in]	a_noiseAmplitude	Noise amplitude
[in]	a_noisePersistence	Noise persistence
[in]	a_noiseOctaves	Number of noise octaves

Member Function Documentation

shuffle()

template<class URNG >

void RandomInterface::ClampedNoisePlane::shuffle ( URNG &  a_rng )

noexcept

Shuffle the permutation array.

Parameters

[in,out]

a_rng

Uniform random number generator.

signedDistance()

Real RandomInterface::ClampedNoisePlane::signedDistance ( const Vec3 &  a_point ) const

overridevirtualnoexcept

Signed distance function.

Parameters

[in]

a_point

Input point.

Returns

Signed distance to the noisy plane surface.

---

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

• Geometries/RandomInterface/CD_RandomInterface.H
• Geometries/RandomInterface/CD_RandomInterface.cpp