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

functor returns pointwise the l2-norm, e.g. of a velocity More...

#include <euklidNorm3D.h>

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

Public Member Functions

 BlockEuklidNorm3D (BlockF3D< T > &f)
 
bool operator() (T output[], const int input[]) override
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::BlockF3D< T >
 ~BlockF3D () override
 virtual destructor for defined behaviour
 
virtual BlockStructureD< 3 > & getBlockStructure () const
 
BlockF3D< T > & operator- (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator+ (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator* (BlockF3D< T > &rhs)
 
BlockF3D< T > & operator/ (BlockF3D< T > &rhs)
 
- Public Member Functions inherited from olb::GenericF< T, int >
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[], int input0)
 
bool operator() (T output[], int input0, int input1)
 
bool operator() (T output[], int input0, int input1, int input2)
 
bool operator() (T output[], int input0, int input1, int input2, int input3)
 

Protected Attributes

BlockF3D< T > & _f
 
- Protected Attributes inherited from olb::BlockF3D< T >
BlockStructureD< 3 > & _blockStructure
 

Additional Inherited Members

- Public Types inherited from olb::GenericF< T, int >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< T, int >
std::shared_ptr< GenericF< T, int > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Protected Member Functions inherited from olb::BlockF3D< T >
 BlockF3D (BlockStructureD< 3 > &blockStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 

Detailed Description

template<typename T>
class olb::BlockEuklidNorm3D< T >

functor returns pointwise the l2-norm, e.g. of a velocity

Definition at line 60 of file euklidNorm3D.h.

Constructor & Destructor Documentation

◆ BlockEuklidNorm3D()

template<typename T >
olb::BlockEuklidNorm3D< T >::BlockEuklidNorm3D ( BlockF3D< T > & f)

Definition at line 57 of file euklidNorm3D.hh.

58 : BlockF3D<T>(f.getBlockStructure(), 1),
59 _f(f)
60{
61 this->getName() = "EuklidNorm(" + f.getName() + ")";
62}
BlockF3D< T > & _f
std::string & getName()
read and write access to name
Definition genericF.hh:51

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

+ Here is the call graph for this function:

Member Function Documentation

◆ operator()()

template<typename T >
bool olb::BlockEuklidNorm3D< T >::operator() ( T output[],
const int input[] )
overridevirtual

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 65 of file euklidNorm3D.hh.

66{
67 output[0] = T();
68 T data[_f.getTargetDim()];
69 _f(data,input);
70 for (int i = 0; i < _f.getTargetDim(); ++i) {
71 output[0] += data[i] * data[i];
72 }
73 output[0] = util::sqrt(output[0]);
74 return true;
75}
cpu::simd::Pack< T > sqrt(cpu::simd::Pack< T > value)
Definition pack.h:100

References olb::util::sqrt().

+ Here is the call graph for this function:

Member Data Documentation

◆ _f

template<typename T >
BlockF3D<T>& olb::BlockEuklidNorm3D< T >::_f
protected

Definition at line 62 of file euklidNorm3D.h.


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