Calculates the sum of a location-dependent quantity of type T over locations held on all PEs, each taken into account only once even if it's held on multiple PEs.
More...
#include <Accumulator.h>
Public Member Functions | |
| virtual | ~Accumulator () |
| virtual void | addTerm (std::size_t loc, const T &term)=0 |
Increment the sum with the contribution term of location loc held on the current PE. More... | |
| virtual T | computeResult () const =0 |
| Return the sum of contributions associated with locations held on all PEs (each taken into account only once). More... | |
Detailed Description
template<typename T>
class ioda::Accumulator< T >
Calculates the sum of a location-dependent quantity of type T over locations held on all PEs, each taken into account only once even if it's held on multiple PEs.
The intended usage is as follows:
- Create an Accumulator by calling the
createAccumulator()method of a Distribution. - Iterate over locations held on the current PE and call addTerm() for each location making a non-zero contribution to the sum.
- Call computeResult() to calculate the global sum (over all PEs).
Subclasses need to implement addTerm() and computeResult() in such a way that contributions made by locations held on multiple PEs are included only once in the global sum.
Definition at line 27 of file Accumulator.h.
Constructor & Destructor Documentation
◆ ~Accumulator()
|
inlinevirtual |
Definition at line 29 of file Accumulator.h.
Member Function Documentation
◆ addTerm()
|
pure virtual |
Increment the sum with the contribution term of location loc held on the current PE.
Implemented in ioda::NonoverlappingDistributionAccumulator< T >, ioda::InefficientDistributionAccumulator< T >, ioda::PairOfDistributionsAccumulator< T >, and ioda::GeneralDistributionAccumulator< T >.
◆ computeResult()
|
pure virtual |
Return the sum of contributions associated with locations held on all PEs (each taken into account only once).
Implemented in ioda::PairOfDistributionsAccumulator< T >, ioda::NonoverlappingDistributionAccumulator< T >, ioda::InefficientDistributionAccumulator< T >, and ioda::GeneralDistributionAccumulator< T >.
The documentation for this class was generated from the following file:
