olb::GaussDistribution< T, S > Class Template Reference

Functor for a Gaussian (normal) distribution. More...

#include <ParticleDistribution.h>

Inheritance diagram for olb::GaussDistribution< T, S >:

Collaboration diagram for olb::GaussDistribution< T, S >:

Public Member Functions
	GaussDistribution (T standardDeviation, T mean, T scale=1)
bool	operator() (T output[1], const S x[1])
Public Member Functions inherited from olb::AnalyticalF< 1, 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
virtual bool	operator() (T output[], const S input[])=0
	has to be implemented for 'every' derived class
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< 1, T, S >
using	identity_functor_type
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< 1, T, S >
static constexpr unsigned	dim
Protected Member Functions inherited from olb::AnalyticalF< 1, T, S >
	AnalyticalF (int n)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

template<typename T, typename S>
class olb::GaussDistribution< T, S >

Functor for a Gaussian (normal) distribution.

Definition at line 46 of file ParticleDistribution.h.

Constructor & Destructor Documentation

GaussDistribution()

template<typename T , typename S >

olb::GaussDistribution< T, S >::GaussDistribution	(	T	standardDeviation,
		T	mean,
		T	scale = 1 )

Definition at line 44 of file ParticleDistribution.hh.

                                                                                 :AnalyticalF1D<T, S>(1), _standardDeviation(standardDeviation), _mean(mean), _scale(scale) {
    this->getName() = "GaussDistribution";
  };

References olb::GenericF< T, S >::getName().

Here is the call graph for this function:

Member Function Documentation

operator()()

template<typename T , typename S >

bool olb::GaussDistribution< T, S >::operator()	(	T	output[1],
		const S	x[1] )

Definition at line 49 of file ParticleDistribution.hh.

                                                                    {
    output[0] = _scale / (_standardDeviation * util::pow((2 * M_PI), 0.5)) * util::exp(-0.5 * util::pow((x[0] - _mean) / (_standardDeviation), 2.));
    return true;
  };

References olb::util::exp(), M_PI, and olb::util::pow().

Here is the call graph for this function:

---

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

• src/particles/subgrid3DLegacyFramework/ParticleDistribution.h
• src/particles/subgrid3DLegacyFramework/ParticleDistribution.hh