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

functor to extract data inside an indicator More...

#include <blockBaseF3D.h>

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

Public Member Functions

 BlockExtractIndicatorF3D (BlockF3D< T > &f, BlockIndicatorF3D< T > &indicatorF)
 
bool operator() (T output[], const int input[])
 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
 
BlockIndicatorF3D< T > & _indicatorF
 
- 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::BlockExtractIndicatorF3D< T >

functor to extract data inside an indicator

Definition at line 118 of file blockBaseF3D.h.

Constructor & Destructor Documentation

◆ BlockExtractIndicatorF3D()

template<typename T >
olb::BlockExtractIndicatorF3D< T >::BlockExtractIndicatorF3D ( BlockF3D< T > & f,
BlockIndicatorF3D< T > & indicatorF )

Definition at line 139 of file blockBaseF3D.hh.

141 : BlockF3D<T>(f.getBlockStructure(), f.getTargetDim()),
142 _f(f),
143 _indicatorF(indicatorF)
144{
145 this->getName() = f.getName();
146}
BlockIndicatorF3D< T > & _indicatorF
std::string & getName()
read and write access to name
Definition genericF.hh:51

Member Function Documentation

◆ operator()()

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

has to be implemented for 'every' derived class

Implements olb::GenericF< T, int >.

Definition at line 149 of file blockBaseF3D.hh.

150{
151 for (int i = 0; i < this->getTargetDim(); ++i) {
152 output[i] = T{};
153 }
154 if (_indicatorF(input)) {
155 _f(output, input);
156 }
157 return true;
158}
int getTargetDim() const
read only access to member variable _n
Definition genericF.hh:45

Member Data Documentation

◆ _f

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

Definition at line 120 of file blockBaseF3D.h.

◆ _indicatorF

template<typename T >
BlockIndicatorF3D<T>& olb::BlockExtractIndicatorF3D< T >::_indicatorF
protected

Definition at line 121 of file blockBaseF3D.h.


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