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

AnalyticalLinear1D: 1D -> 1D troughout given points (x0,v0) and (x1,v1) More...

#include <analyticalF.h>

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

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

Public Types
template<typename V , typename U >
using	exchange_type = AnalyticalLinear1D<V,U>
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 Member Functions
	AnalyticalLinear1D (T a, T b)
	AnalyticalLinear1D (S x0, T v0, S x1, T v1)
bool	operator() (T output[], const S x[]) override
	returns line _a*x + _b
template<typename V , typename U >
auto	copyAs () const
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
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< 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::AnalyticalLinear1D< T, S >

AnalyticalLinear1D: 1D -> 1D troughout given points (x0,v0) and (x1,v1)

Definition at line 392 of file analyticalF.h.

Member Typedef Documentation

exchange_type

template<typename T , typename S >

template<typename V , typename U >

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

Definition at line 402 of file analyticalF.h.

Constructor & Destructor Documentation

AnalyticalLinear1D() [1/2]

template<typename T , typename S >

olb::AnalyticalLinear1D< T, S >::AnalyticalLinear1D	(	T	a,
		T	b )

Definition at line 372 of file analyticalF.hh.

  : AnalyticalF1D<T,S>(1), _a(a), _b(b)
{
  this->getName() = "linear";
}

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

Here is the call graph for this function:

AnalyticalLinear1D() [2/2]

template<typename T , typename S >

olb::AnalyticalLinear1D< T, S >::AnalyticalLinear1D	(	S	x0,
		T	v0,
		S	x1,
		T	v1 )

Definition at line 379 of file analyticalF.hh.

  : AnalyticalF1D<T,S>(1)
{
  if ( util::nearZero(x1-x0) ) {
    std::cout << "Error: x1-x2=0" << std::endl;
  }
  else {
    _a = ( v1-v0 ) / ( x1-x0 );
    _b = v0 - _a*x0;
  }
  this->getName() = "linear";
}

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

Here is the call graph for this function:

Member Function Documentation

copyAs()

template<typename T , typename S >

template<typename V , typename U >

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

inline

Definition at line 405 of file analyticalF.h.

                      {
    return exchange_type<V,U>(_a, _b);
  }

operator()()

template<typename T , typename S >

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

overridevirtual

returns line _a*x + _b

Implements olb::GenericF< T, S >.

Definition at line 393 of file analyticalF.hh.

{
  output[0]=_a*x[0] + _b;
  return true;
}

---

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

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