olb::AnalyticalNormal< D, T, S > Class Template Reference

AnalyticalNormal: DD -> XD, where XD is defined by value.size() More...

#include <analyticalF.h>

Inheritance diagram for olb::AnalyticalNormal< D, T, S >:

Collaboration diagram for olb::AnalyticalNormal< D, T, S >:

Public Member Functions
	AnalyticalNormal (std::vector< T > mean, T stdDev)
bool	operator() (T output[], const S x[]) override
	has to be implemented for 'every' derived class
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::AnalyticalF< D, T, S >
	AnalyticalF (int n)
Protected Member Functions inherited from olb::GenericF< T, S >
	GenericF (int targetDim, int sourceDim)

Detailed Description

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

AnalyticalNormal: DD -> XD, where XD is defined by value.size()

Definition at line 102 of file analyticalF.h.

Constructor & Destructor Documentation

AnalyticalNormal()

template<unsigned D, typename T , typename S >

olb::AnalyticalNormal< D, T, S >::AnalyticalNormal	(	std::vector< T >	mean,
		T	stdDev )

Definition at line 140 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(1), _mean(mean), _stdDev(stdDev)
{
  this->getName() = "normal";
}

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

Here is the call graph for this function:

Member Function Documentation

operator()()

template<unsigned D, typename T , typename S >

bool olb::AnalyticalNormal< D, T, S >::operator() ( T output[], const S input[] )

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, S >.

Definition at line 147 of file analyticalF.hh.

{
  T r2 = T();
  for ( unsigned i = 0; i < D; ++i) {
    r2 += (x[i] - _mean[i]) * (x[i] - _mean[i]);
  }
  output[0] = util::exp(-r2/(2*_stdDev*_stdDev)) / (_stdDev*util::sqrt(2.*M_PI));
  return true;
}

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

Here is the call graph for this function:

---

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

• src/functors/analytical/analyticalF.h
• src/functors/analytical/analyticalF.hh