arithmetic helper class for analytical functors More...

#include <analyticCalcF.h>

Inheritance diagram for olb::AnalyticCalcF< D, T, S, F >:

Collaboration diagram for olb::AnalyticCalcF< D, T, S, F >:

Public Member Functions
	AnalyticCalcF (FunctorPtr< AnalyticalF< D, T, S > > &&f, FunctorPtr< AnalyticalF< D, T, S > > &&g)

	AnalyticCalcF (T scalar, FunctorPtr< AnalyticalF< D, T, S > > &&g)

	AnalyticCalcF (FunctorPtr< AnalyticalF< D, T, S > > &&f, T scalar)

bool	operator() (T output[], const S input[]) 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)

Protected Attributes
FunctorPtr< AnalyticalF< D, T, S > >	_f

FunctorPtr< AnalyticalF< D, T, S > >	_g

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, template< typename > class F>
class olb::AnalyticCalcF< D, T, S, F >

arithmetic helper class for analytical functors

Definition at line 38 of file analyticCalcF.h.

Constructor & Destructor Documentation

◆ AnalyticCalcF() [1/3]

template<unsigned D, typename T , typename S , template< typename > class F>

olb::AnalyticCalcF< D, T, S, F >::AnalyticCalcF	(	FunctorPtr< AnalyticalF< D, T, S > > &&	f,
		FunctorPtr< AnalyticalF< D, T, S > > &&	g )

Definition at line 37 of file analyticCalcF.hh.

  : AnalyticalF<D,T,S>(f->getTargetDim()),
    _f(std::move(f)),
    _g(std::move(g))
{
  OLB_ASSERT(g->getTargetDim() == f->getTargetDim(),
             "the dimensions of both functors need to be equal");
  std::swap(f->_ptrCalcC, this->_ptrCalcC);
  this->getName() = "(" + _f->getName() + F<T>::symbol + _g->getName() + ")";
}

References olb::AnalyticCalcF< D, T, S, F >::_f, olb::AnalyticCalcF< D, T, S, F >::_g, olb::GenericF< T, S >::getName(), and OLB_ASSERT.

Here is the call graph for this function:

◆ AnalyticCalcF() [2/3]

template<unsigned D, typename T , typename S , template< typename > class F>

olb::AnalyticCalcF< D, T, S, F >::AnalyticCalcF	(	T	scalar,
		FunctorPtr< AnalyticalF< D, T, S > > &&	g )

Definition at line 50 of file analyticCalcF.hh.

  : AnalyticCalcF(
      std::unique_ptr<AnalyticalF<D,T,S>>(
        new AnalyticalConst<D,T,S>(std::vector<T>(g->getTargetDim(), scalar))),
      std::forward<decltype(g)>(g))
{ }

◆ AnalyticCalcF() [3/3]

template<unsigned D, typename T , typename S , template< typename > class F>

olb::AnalyticCalcF< D, T, S, F >::AnalyticCalcF	(	FunctorPtr< AnalyticalF< D, T, S > > &&	f,
		T	scalar )

Definition at line 58 of file analyticCalcF.hh.

  : AnalyticCalcF(
      std::forward<decltype(f)>(f),
      std::unique_ptr<AnalyticalF<D,T,S>>(
        new AnalyticalConst<D,T,S>(std::vector<T>(f->getTargetDim(), scalar))))
{ }

Member Function Documentation

◆ operator()()

template<unsigned D, typename T , typename S , template< typename > class F>

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

overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, S >.

Definition at line 66 of file analyticCalcF.hh.

{
  T outputTmp[this->_g->getTargetDim()];
  this->_g(outputTmp, input);
  this->_f(output, input);
  for (int i = 0; i < this->_f->getTargetDim(); ++i) {
    output[i] = F<T>()(output[i], outputTmp[i]);
  }
  return true;
}