OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::AnalyticalRandomTruncatedNormal< D, T, S > Class Template Reference

AnalyticalRandomNormal: DD -> 1D with random image in (0,1) Normal distribution cut off outside [mean-n*stdDev, mean+n*stdDev]. More...

#include <analyticalF.h>

+ Inheritance diagram for olb::AnalyticalRandomTruncatedNormal< D, T, S >:
+ Collaboration diagram for olb::AnalyticalRandomTruncatedNormal< D, T, S >:

Public Member Functions

 AnalyticalRandomTruncatedNormal (T mean=0., T stdDev=1., T n=3.)
 
bool operator() (T output[], const S x[]) override
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::AnalyticalRandomNormal< D, T, S >
 AnalyticalRandomNormal (T mean=0., T stdDev=1.)
 
- Public Member Functions inherited from olb::AnalyticalF< D, T, S >
AnalyticalF< D, T, S > & operator- (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator+ (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator* (AnalyticalF< D, T, S > &rhs)
 
AnalyticalF< D, T, S > & operator/ (AnalyticalF< D, T, S > &rhs)
 
- Public Member Functions inherited from olb::GenericF< T, S >
virtual ~GenericF ()=default
 
int getSourceDim () const
 read only access to member variable _m
 
int getTargetDim () const
 read only access to member variable _n
 
std::string & getName ()
 read and write access to name
 
std::string const & getName () const
 read only access to name
 
bool operator() (T output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (T output[], S input0)
 
bool operator() (T output[], S input0, S input1)
 
bool operator() (T output[], S input0, S input1, S input2)
 
bool operator() (T output[], S input0, S input1, S input2, S input3)
 

Additional Inherited Members

- Public Types inherited from olb::AnalyticalF< D, T, S >
using identity_functor_type = AnalyticalIdentity<D,T,S>
 
- Public Types inherited from olb::GenericF< T, S >
using targetType = T
 
using sourceType = S
 
- Public Attributes inherited from olb::GenericF< T, S >
std::shared_ptr< GenericF< T, S > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Static Public Attributes inherited from olb::AnalyticalF< D, T, S >
static constexpr unsigned dim = D
 
- Protected Member Functions inherited from olb::AnalyticalRandomBase< D, T, S >
 AnalyticalRandomBase ()
 
- Protected Member Functions inherited from olb::AnalyticalF< D, T, S >
 AnalyticalF (int n)
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::AnalyticalRandomNormal< D, T, S >
std::normal_distribution< T > distro
 
- Protected Attributes inherited from olb::AnalyticalRandomBase< D, T, S >
std::random_device rd
 
std::mt19937 gen
 

Detailed Description

template<unsigned D, typename T, typename S>
class olb::AnalyticalRandomTruncatedNormal< D, T, S >

AnalyticalRandomNormal: DD -> 1D with random image in (0,1) Normal distribution cut off outside [mean-n*stdDev, mean+n*stdDev].

Definition at line 163 of file analyticalF.h.

Constructor & Destructor Documentation

◆ AnalyticalRandomTruncatedNormal()

template<unsigned D, typename T , typename S >
olb::AnalyticalRandomTruncatedNormal< D, T, S >::AnalyticalRandomTruncatedNormal ( T mean = 0.,
T stdDev = 1.,
T n = 3. )

Definition at line 216 of file analyticalF.hh.

217 : AnalyticalRandomNormal<D,T,S>(mean, stdDev),
218 _min(mean - n*stdDev),
219 _max(mean + n*stdDev)
220{ }

Member Function Documentation

◆ operator()()

template<unsigned D, typename T , typename S >
bool olb::AnalyticalRandomTruncatedNormal< D, T, S >::operator() ( T output[],
const S input[] )
overridevirtual

has to be implemented for 'every' derived class

Reimplemented from olb::AnalyticalRandomNormal< D, T, S >.

Definition at line 223 of file analyticalF.hh.

224{
225 do {
226 output[0] = this->distro(this->gen);
227 }
228 while (output[0] < _min || output[0] > _max);
229 return true;
230}
std::normal_distribution< T > distro

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