OpenLB 1.7
Loading...
Searching...
No Matches
Public Member Functions | List of all members
olb::BlockAverage2D< T, W > Class Template Referencefinal

BlockAverage2D returns the average in each component of f on a indicated subset. More...

#include <blockAverage2D.h>

+ Inheritance diagram for olb::BlockAverage2D< T, W >:
+ Collaboration diagram for olb::BlockAverage2D< T, W >:

Public Member Functions

 BlockAverage2D (BlockF2D< W > &f, BlockIndicatorF2D< T > &indicatorF)
 
bool operator() (W output[], const int input[]) override
 
- Public Member Functions inherited from olb::BlockSum2D< T, W >
 BlockSum2D (BlockF2D< W > &f, BlockIndicatorF2D< T > &indicatorF)
 
bool operator() (W output[], const int input[]) override
 
- Public Member Functions inherited from olb::BlockF2D< T >
virtual BlockStructureD< 2 > & getBlockStructure ()
 virtual destructor for defined behaviour
 
void setBlockStructure (BlockStructureD< 2 > *blockStructure)
 
BlockF2D< T > & operator- (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator+ (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator* (BlockF2D< T > &rhs)
 
BlockF2D< T > & operator/ (BlockF2D< 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
 
virtual bool operator() (T output[], const int 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[], 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)
 

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::BlockF2D< T >
 BlockF2D (BlockStructureD< 2 > &blockStructure, int targetDim)
 
 BlockF2D (int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, int >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::BlockF2D< T >
BlockStructureD< 2 > * _blockStructure
 

Detailed Description

template<typename T, typename W = T>
class olb::BlockAverage2D< T, W >

BlockAverage2D returns the average in each component of f on a indicated subset.

Definition at line 36 of file blockAverage2D.h.

Constructor & Destructor Documentation

◆ BlockAverage2D()

template<typename T , typename W >
olb::BlockAverage2D< T, W >::BlockAverage2D ( BlockF2D< W > & f,
BlockIndicatorF2D< T > & indicatorF )

Definition at line 33 of file blockAverage2D.hh.

35 : BlockSum2D<T,W>(f, indicatorF)
36{
37 this->getName() = "BlockAverage("+f.getName()+")";
38}
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 , typename W >
bool olb::BlockAverage2D< T, W >::operator() ( W output[],
const int input[] )
override

Definition at line 41 of file blockAverage2D.hh.

42{
43 for (int i = 0; i < this->getTargetDim(); ++i) {
44 output[i] = W(0);
45 }
46
47 const bool result = BlockSum2D<T,W>::operator()(output, input);
48
49 for (int i = 0; i < this->getTargetDim()-1; ++i) {
50 output[i] /= output[this->getTargetDim()-1];
51 }
52
53 return result;
54}
bool operator()(W output[], const int input[]) override
int getTargetDim() const
read only access to member variable _n
Definition genericF.hh:45

References olb::BlockSum2D< T, W >::operator()().

+ Here is the call graph for this function:

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