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

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

#include <superAverage2D.h>

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

Public Member Functions

 SuperAverage2D (FunctorPtr< SuperF2D< T, W > > &&f, FunctorPtr< SuperIndicatorF2D< T > > &&indicatorF)
 Constructor for determining the average of f on a indicated subset.
 
 SuperAverage2D (FunctorPtr< SuperF2D< T, W > > &&f, SuperGeometry< T, 2 > &superGeometry, const int material)
 Constructor for determining the average of f on a given material.
 
bool operator() (W output[], const int input[]) override
 Global average operator.
 
- Public Member Functions inherited from olb::SuperF2D< T, W >
SuperF2D< T, W > & operator- (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator+ (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator* (SuperF2D< T, W > &rhs)
 
SuperF2D< T, W > & operator/ (SuperF2D< T, W > &rhs)
 
SuperStructure< T, 2 > & getSuperStructure ()
 
int getBlockFSize () const
 
BlockF2D< W > & getBlockF (int iCloc)
 
bool operator() (W output[], const int input[]) override
 
- 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)
 

Additional Inherited Members

- Public Types inherited from olb::SuperF2D< T, W >
using identity_functor_type = SuperIdentity2D<T,W>
 
- 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)
 
- Protected Member Functions inherited from olb::SuperF2D< T, W >
 SuperF2D (SuperStructure< T, 2 > &superStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< T, S >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::SuperF2D< T, W >
SuperStructure< T, 2 > & _superStructure
 
std::vector< std::unique_ptr< BlockF2D< W > > > _blockF
 Super functors may consist of several BlockF2D<W> derived functors.
 

Detailed Description

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

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

Definition at line 37 of file superAverage2D.h.

Constructor & Destructor Documentation

◆ SuperAverage2D() [1/2]

template<typename T , typename W >
olb::SuperAverage2D< T, W >::SuperAverage2D ( FunctorPtr< SuperF2D< T, W > > && f,
FunctorPtr< SuperIndicatorF2D< T > > && indicatorF )

Constructor for determining the average of f on a indicated subset.

Parameters
ffunctor of which the average is to be determined
indicatorFindicator describing the subset on which to evaluate f

Definition at line 34 of file superAverage2D.hh.

36 : SuperF2D<T,W>(f->getSuperStructure(), f->getTargetDim()+1),
37 _f(std::move(f)),
38 _indicatorF(std::move(indicatorF))
39{
40 this->getName() = "Average("+_f->getName()+")";
41
42 LoadBalancer<T>& load = _f->getSuperStructure().getLoadBalancer();
43
44 if ( _f->getBlockFSize() == load.size() &&
45 _indicatorF->getBlockFSize() == load.size() ) {
46 for (int iC = 0; iC < load.size(); ++iC) {
47 this->_blockF.emplace_back(
48 new BlockAverage2D<T,W>(_f->getBlockF(iC),
49 _indicatorF->getBlockIndicatorF(iC))
50 );
51 }
52 }
53}
std::string & getName()
read and write access to name
Definition genericF.hh:51
std::vector< std::unique_ptr< BlockF2D< W > > > _blockF
Super functors may consist of several BlockF2D<W> derived functors.

References olb::SuperF2D< T, W >::_blockF, olb::GenericF< T, S >::getName(), and olb::LoadBalancer< T >::size().

+ Here is the call graph for this function:

◆ SuperAverage2D() [2/2]

template<typename T , typename W >
olb::SuperAverage2D< T, W >::SuperAverage2D ( FunctorPtr< SuperF2D< T, W > > && f,
SuperGeometry< T, 2 > & superGeometry,
const int material )

Constructor for determining the average of f on a given material.

Parameters
ffunctor of which the average is to be determined
superGeometrysuper geometry for constructing material indicator
materialnumber of the relevant material

Definition at line 56 of file superAverage2D.hh.

60 std::forward<decltype(f)>(f),
61 superGeometry.getMaterialIndicator(material))
62{ }
SuperAverage2D(FunctorPtr< SuperF2D< T, W > > &&f, FunctorPtr< SuperIndicatorF2D< T > > &&indicatorF)
Constructor for determining the average of f on a indicated subset.
std::unique_ptr< SuperIndicatorF< T, D > > getMaterialIndicator(std::vector< int > &&materials)
Returns a material indicator using the given vector of materials.

Member Function Documentation

◆ operator()()

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

Global average operator.

Note: While this functor exposes BlockAverage3D functors if possible, a call to this function will not use them but calculate the global average by summing all components and voxel counts. Calling BlockAverage2D in this situation would unnecessarily complicate this as we would have to weight the aggregated averages according to their share in the global average.

Definition at line 65 of file superAverage2D.hh.

66{
67 _f->getSuperStructure().communicate();
68 CuboidGeometry2D<T>& geometry = _f->getSuperStructure().getCuboidGeometry();
69 LoadBalancer<T>& load = _f->getSuperStructure().getLoadBalancer();
70
71 for (int i = 0; i < _f->getTargetDim(); ++i) {
72 output[i] = W(0);
73 }
74
75 W outputTmp[_f->getTargetDim()];
76 int inputTmp[_f->getSourceDim()];
77 std::size_t voxels(0);
78
79 for (int iC = 0; iC < load.size(); ++iC) {
80 const Cuboid2D<T>& cuboid = geometry.get(load.glob(iC));
81 inputTmp[0] = load.glob(iC);
82 for (inputTmp[1] = 0; inputTmp[1] < cuboid.getNx(); ++inputTmp[1]) {
83 for (inputTmp[2] = 0; inputTmp[2] < cuboid.getNy(); ++inputTmp[2]) {
84 if (_indicatorF(inputTmp)) {
85 _f(outputTmp,inputTmp);
86 for (int i = 0; i < _f->getTargetDim(); ++i) {
87 output[i] += outputTmp[i];
88 }
89 voxels += 1;
90 }
91
92 }
93 }
94 }
95
96#ifdef PARALLEL_MODE_MPI
97 for (int i = 0; i < _f->getTargetDim(); ++i) {
98 singleton::mpi().reduceAndBcast(output[i], MPI_SUM);
99 }
100 singleton::mpi().reduceAndBcast(voxels, MPI_SUM);
101#endif
102
103 output[_f->getTargetDim()] = voxels;
104 for (int i = 0; i < _f->getTargetDim(); ++i) {
105 output[i] /= output[_f->getTargetDim()];
106 }
107
108 return true;
109}
void reduceAndBcast(T &reductVal, MPI_Op op, int root=0, MPI_Comm comm=MPI_COMM_WORLD)
Reduction operation, followed by a broadcast.
MpiManager & mpi()

References olb::SuperStructure< T, D >::communicate(), olb::CuboidGeometry2D< T >::get(), olb::Cuboid2D< T >::getNx(), olb::Cuboid2D< T >::getNy(), olb::SuperF2D< T, W >::getSuperStructure(), olb::LoadBalancer< T >::glob(), olb::singleton::mpi(), olb::singleton::MpiManager::reduceAndBcast(), and olb::LoadBalancer< T >::size().

+ Here is the call graph for this function:

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