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

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

#include <analyticalF.h>

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

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

Public Types
template<typename V , typename U >
using	exchange_type = AnalyticalConst<D,V,U>
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 Member Functions
	AnalyticalConst (T value)
	AnalyticalConst (T value0, T value1)
	AnalyticalConst (T value0, T value1, T value2)
	AnalyticalConst (const Vector< T, 2 > &value)
	AnalyticalConst (const Vector< T, 3 > &value)
	AnalyticalConst (const std::vector< T > &value)
bool	operator() (T output[], const S x[]) override
	has to be implemented for 'every' derived class
template<typename V , typename U >
auto	copyAs () const
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 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::AnalyticalConst< D, T, S >

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

Definition at line 78 of file analyticalF.h.

Member Typedef Documentation

exchange_type

template<unsigned D, typename T , typename S >

template<typename V , typename U >

using olb::AnalyticalConst< D, T, S >::exchange_type = AnalyticalConst<D,V,U>

Definition at line 92 of file analyticalF.h.

Constructor & Destructor Documentation

AnalyticalConst() [1/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst

(

T

value

)

Definition at line 82 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(1)
{
  _c.push_back(value);
  this->getName() = "const";
}

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

Here is the call graph for this function:

AnalyticalConst() [2/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst	(	T	value0,
		T	value1 )

Definition at line 90 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(2)
{
  _c.push_back(value0);
  _c.push_back(value1);
  this->getName() = "const";
}

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

Here is the call graph for this function:

AnalyticalConst() [3/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst	(	T	value0,
		T	value1,
		T	value2 )

Definition at line 99 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(3)
{
  _c.push_back(value0);
  _c.push_back(value1);
  _c.push_back(value2);
  this->getName() = "const";
}

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

Here is the call graph for this function:

AnalyticalConst() [4/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst

(

const Vector< T, 2 > &

value

)

Definition at line 109 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(2)
{
  _c.reserve(2);
  _c.push_back(value[0]);
  _c.push_back(value[1]);
  this->getName() = "const";
}

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

Here is the call graph for this function:

AnalyticalConst() [5/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst

(

const Vector< T, 3 > &

value

)

Definition at line 119 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(3)
{
  _c.reserve(3);
  _c.push_back(value[0]);
  _c.push_back(value[1]);
  _c.push_back(value[2]);
  this->getName() = "const";
}

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

Here is the call graph for this function:

AnalyticalConst() [6/6]

template<unsigned D, typename T , typename S >

olb::AnalyticalConst< D, T, S >::AnalyticalConst

(

const std::vector< T > &

value

)

Definition at line 75 of file analyticalF.hh.

  : AnalyticalF<D,T,S>(value.size()), _c(value)
{
  this->getName() = "const";
}

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

Here is the call graph for this function:

Member Function Documentation

copyAs()

template<unsigned D, typename T , typename S >

template<typename V , typename U >

auto olb::AnalyticalConst< D, T, S >::copyAs ( ) const

inline

Definition at line 95 of file analyticalF.h.

                      {
    return exchange_type<V,U>(util::copyAs<V,T,util::StdVector>(_c));
  }

operator()()

template<unsigned D, typename T , typename S >

bool olb::AnalyticalConst< 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 130 of file analyticalF.hh.

{
  for ( unsigned i = 0; i < _c.size(); ++i) {
    output[i] = _c[i];
  }
  return true;
}

---

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

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