DUNE PDELab (git)
Class for collecting statistics over several invocations. More...
#include <dune/pdelab/backend/istl/matrixfree/solverstatistics.hh>
Public Member Functions | |
SolverStatistics (const Dune::Communication< MPI_Comm > &comm_) | |
Create new instance of class. More... | |
void | append (const T x) |
Add new data point. More... | |
void | clear () |
clear out data | |
size_t | size () const |
Total number of calls. More... | |
double | avg () const |
Calculate global average. More... | |
double | stddev () const |
Calculate standard deviation. More... | |
const T | min () const |
Calculate global minimum. More... | |
const T | max () const |
Calculate global maximum. More... | |
const StatisticsResult< T > | result () const |
Convert to statistics result. | |
Detailed Description
class Dune::PDELab::SolverStatistics< T >
Class for collecting statistics over several invocations.
Records data for every invocation and provides methods for calculating min/max/avg/stddev over all invocations. This can then be used to calculate statistics on the block-solves
Constructor & Destructor Documentation
◆ SolverStatistics()
|
inline |
Create new instance of class.
- Parameters
-
[in] comm_ Collective communication object
Member Function Documentation
◆ append()
|
inline |
Add new data point.
- Parameters
-
[in] x Data point to add
◆ avg()
|
inline |
Calculate global average.
Calculates global average over all processors and invocations
References Dune::Hybrid::accumulate(), and Dune::Communication< MPI_Comm >::sum().
Referenced by Dune::PDELab::SolverStatistics< T >::result().
◆ max()
|
inline |
Calculate global maximum.
Calculates global maximum over all processors and invocations
References Dune::Communication< MPI_Comm >::max().
Referenced by Dune::PDELab::SolverStatistics< T >::result().
◆ min()
|
inline |
Calculate global minimum.
Calculates global minimum over all processors and invocations
References Dune::Communication< MPI_Comm >::min().
Referenced by Dune::PDELab::SolverStatistics< T >::result().
◆ size()
|
inline |
Total number of calls.
Calculates total number of invocations
References Dune::Communication< MPI_Comm >::sum().
Referenced by Dune::PDELab::SolverStatistics< T >::result().
◆ stddev()
|
inline |
Calculate standard deviation.
Calculates standard deviation
References Dune::Hybrid::accumulate(), and Dune::Communication< MPI_Comm >::sum().
Referenced by Dune::PDELab::SolverStatistics< T >::result().
The documentation for this class was generated from the following file:
- dune/pdelab/backend/istl/matrixfree/solverstatistics.hh