OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
olb::AnalyticalDerivativeFD1D< T > Class Template Reference

Class for computing the derivative of a given 1D functor with a finite difference. More...

#include <derivativeF.h>

+ Inheritance diagram for olb::AnalyticalDerivativeFD1D< T >:
+ Collaboration diagram for olb::AnalyticalDerivativeFD1D< T >:

Public Member Functions

 AnalyticalDerivativeFD1D (AnalyticalF1D< T, T > &f)
 
 AnalyticalDerivativeFD1D (AnalyticalF1D< T, T > &f, T eps)
 
bool operator() (T output[], const T input[]) override
 Finite Difference computation.
 
- 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)
 

Protected Attributes

AnalyticalF1D< T, T > & _f
 
_eps {1.e-10}
 

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>
class olb::AnalyticalDerivativeFD1D< T >

Class for computing the derivative of a given 1D functor with a finite difference.

Definition at line 43 of file derivativeF.h.

Constructor & Destructor Documentation

◆ AnalyticalDerivativeFD1D() [1/2]

template<typename T >
olb::AnalyticalDerivativeFD1D< T >::AnalyticalDerivativeFD1D ( AnalyticalF1D< T, T > & f)
inlineexplicit

Definition at line 48 of file derivativeF.h.

48: AnalyticalF1D<T,T>(1), _f(f) { };
AnalyticalF1D< T, T > & _f
Definition derivativeF.h:45

◆ AnalyticalDerivativeFD1D() [2/2]

template<typename T >
olb::AnalyticalDerivativeFD1D< T >::AnalyticalDerivativeFD1D ( AnalyticalF1D< T, T > & f,
T eps )
inline

Definition at line 49 of file derivativeF.h.

49: AnalyticalF1D<T,T>(1), _f(f), _eps(eps) { };

Member Function Documentation

◆ operator()()

template<typename T >
bool olb::AnalyticalDerivativeFD1D< T >::operator() ( T output[],
const T input[] )
override

Finite Difference computation.

Definition at line 55 of file derivativeF.h.

56{
57 _f(output,input);
58 T x = output[0];
59 T input2[1];
60 input2[0] = input[0] + _eps;
61 _f(output,input2);
62 output[0] -= x;
63 output[0] /= _eps;
64 return true;
65}

Member Data Documentation

◆ _eps

template<typename T >
T olb::AnalyticalDerivativeFD1D< T >::_eps {1.e-10}
protected

Definition at line 46 of file derivativeF.h.

46{1.e-10};

◆ _f

template<typename T >
AnalyticalF1D<T,T>& olb::AnalyticalDerivativeFD1D< T >::_f
protected

Definition at line 45 of file derivativeF.h.


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