chombo-discharge
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
RandomInterface::ClampedNoisePlane Class Reference

Clamped noisy plane signed distance function. More...

#include <CD_RandomInterface.H>

Inheritance diagram for RandomInterface::ClampedNoisePlane:
Inheritance graph
[legend]
Collaboration diagram for RandomInterface::ClampedNoisePlane:
Collaboration graph
[legend]

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_pointPoint on plane
[in]a_normalPlane normal vector
[in]a_clampLoClamping at low end
[in]a_clampHiClamping at high
[in]a_clampDxClamping length
[in]a_noiseFrequencyNoise frequency
[in]a_noiseAmplitudeNoise amplitude
[in]a_noisePersistenceNoise persistence
[in]a_noiseOctavesNumber of noise octaves

Member Function Documentation

◆ signedDistance()

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

Signed distance function.

Parameters
[in]a_pointInput point

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