OpenLB 1.8.1
Loading...
Searching...
No Matches
olb::SuperSum2D< T, W > Class Template Referencefinal

SuperSum2D sums all components of f over a indicated subset. More...

#include <superIntegralF2D.h>

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

Public Member Functions

 SuperSum2D (FunctorPtr< SuperF2D< T, W > > &&f, FunctorPtr< SuperIndicatorF2D< T > > &&indicatorF)
 Constructor for summing f on a indicated subset.
 
 SuperSum2D (FunctorPtr< SuperF2D< T, W > > &&f, SuperGeometry< T, 2 > &superGeometry, const int material)
 Constructor for summing f on a given material.
 
bool operator() (W output[], const int input[]) override
 has to be implemented for 'every' derived class
 
- Public Member Functions inherited from olb::SuperF2D< T, T >
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)
 
- Public Member Functions inherited from olb::GenericF< W, 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() (W output[])
 wrapper that call the pure virtual operator() (T output[], const S input[]) from above
 
bool operator() (W output[], int input0)
 
bool operator() (W output[], int input0, int input1)
 
bool operator() (W output[], int input0, int input1, int input2)
 
bool operator() (W output[], int input0, int input1, int input2, int input3)
 

Additional Inherited Members

- Public Types inherited from olb::SuperF2D< T, T >
using identity_functor_type
 
- Public Types inherited from olb::GenericF< W, int >
using targetType
 
using sourceType
 
- Public Attributes inherited from olb::GenericF< W, int >
std::shared_ptr< GenericF< W, int > > _ptrCalcC
 memory management, frees resouces (calcClass)
 
- Protected Member Functions inherited from olb::SuperF2D< T, T >
 SuperF2D (SuperStructure< T, 2 > &superStructure, int targetDim)
 
- Protected Member Functions inherited from olb::GenericF< W, int >
 GenericF (int targetDim, int sourceDim)
 
- Protected Attributes inherited from olb::SuperF2D< T, T >
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::SuperSum2D< T, W >

SuperSum2D sums all components of f over a indicated subset.

Definition at line 39 of file superIntegralF2D.h.

Constructor & Destructor Documentation

◆ SuperSum2D() [1/2]

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

Constructor for summing f on a indicated subset.

Parameters
ffunctor to be summed
indicatorFindicator describing the subset on which to evaluate f

Definition at line 39 of file superIntegralF2D.hh.

41 : SuperF2D<T,W>(f->getSuperStructure(), f->getTargetDim()+1),
42 _f(std::move(f)),
43 _indicatorF(std::move(indicatorF))
44{
45 this->getName() = "Sum("+_f->getName()+")";
46
47 LoadBalancer<T>& load = _f->getSuperStructure().getLoadBalancer();
48
49 if ( _f->getBlockFSize() == load.size() &&
50 _indicatorF->getBlockFSize() == load.size() ) {
51 for (int iC = 0; iC < load.size(); ++iC) {
52 this->_blockF.emplace_back(
53 new BlockSum2D<T,W>(_f->getBlockF(iC),
54 _indicatorF->getBlockIndicatorF(iC))
55 );
56 }
57 }
58}
std::string & getName()
Definition genericF.hh:51
std::vector< std::unique_ptr< BlockF2D< W > > > _blockF

References olb::GenericF< W, int >::getName().

+ Here is the call graph for this function:

◆ SuperSum2D() [2/2]

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

Constructor for summing f on a given material.

Parameters
ffunctor to be summed
superGeometrysuper geometry for constructing material indicator
materialnumber of the relevant material

Definition at line 61 of file superIntegralF2D.hh.

64 : SuperSum2D(
65 std::forward<decltype(f)>(f),
66 superGeometry.getMaterialIndicator(material))
67{ }
SuperSum2D(FunctorPtr< SuperF2D< T, W > > &&f, FunctorPtr< SuperIndicatorF2D< T > > &&indicatorF)
Constructor for summing f on a indicated subset.

Member Function Documentation

◆ operator()()

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

has to be implemented for 'every' derived class

Reimplemented from olb::SuperF2D< T, T >.

Definition at line 70 of file superIntegralF2D.hh.

71{
72 _f->getSuperStructure().communicate();
73 auto& geometry = _f->getSuperStructure().getCuboidDecomposition();
74 LoadBalancer<T>& load = _f->getSuperStructure().getLoadBalancer();
75
76 for (int i = 0; i < this->getTargetDim(); ++i) {
77 output[i] = W(0);
78 }
79
80 if (this->_blockF.empty()) {
81 W outputTmp[_f->getTargetDim()];
82 int inputTmp[_f->getSourceDim()];
83 std::size_t voxels(0);
84 std::vector<util::KahanSummator<W>> summators(_f->getTargetDim(), util::KahanSummator<W>());
85
86 for (int iC = 0; iC < load.size(); ++iC) {
87 const Cuboid2D<T> cuboid = geometry.get(load.glob(iC));
88 inputTmp[0] = load.glob(iC);
89 for (inputTmp[1] = 0; inputTmp[1] < cuboid.getNx(); ++inputTmp[1]) {
90 for (inputTmp[2] = 0; inputTmp[2] < cuboid.getNy(); ++inputTmp[2]) {
91 if (_indicatorF(inputTmp)) {
92 _f(outputTmp,inputTmp);
93 for (int i = 0; i < _f->getTargetDim(); ++i) {
94 summators[i].add(outputTmp[i]);
95 }
96 voxels += 1;
97 }
98 }
99 }
100 }
101 for (int i = 0; i < _f->getTargetDim(); ++i) {
102 output[i] = summators[i].getSum();
103 }
104 output[_f->getTargetDim()] = voxels;
105 }
106 else {
107 for (int iC = 0; iC < load.size(); ++iC) {
108 this->getBlockF(iC)(output, input);
109 }
110 }
111
112#ifdef PARALLEL_MODE_MPI
113 for (int i = 0; i < this->getTargetDim(); ++i) {
114 singleton::mpi().reduceAndBcast(output[i], MPI_SUM);
115 }
116#endif
117 return true;
118}
int getTargetDim() const
Definition genericF.hh:45
BlockF2D< W > & getBlockF(int iCloc)
void reduceAndBcast(T &reductVal, MPI_Op op, int root=0, MPI_Comm comm=MPI_COMM_WORLD)
Reduction operation, followed by a broadcast.
MpiManager & mpi()
Cuboid< T, 2 > Cuboid2D
Definition cuboid.h:149

References olb::SuperStructure< T, D >::communicate(), olb::Cuboid< T, D >::getNx(), olb::Cuboid< T, D >::getNy(), olb::SuperF2D< T, U >::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: