preCICE v3.1.1
No Matches
Public Member Functions | List of all members
precice::cplscheme::impl::ConvergenceMeasure Class Referenceabstract

Interface for measures checking the convergence of a series of datasets. More...

#include <ConvergenceMeasure.hpp>

Inheritance diagram for precice::cplscheme::impl::ConvergenceMeasure:

Public Member Functions

virtual ~ConvergenceMeasure ()
 Destructor, empty.
virtual void newMeasurementSeries ()=0
 To be called when a new meas. series (iteration process) starts.
virtual void measure (const Eigen::VectorXd &oldValues, const Eigen::VectorXd &newValues)=0
 Performs convergence measurement.
virtual bool isConvergence () const =0
 Returns true, if the last measurement indicates convergence.
virtual std::string printState (const std::string &dataName)=0
 Adds current convergence information to output stream.
virtual double getNormResidual ()
 Returns the l2-norm of the coupling residuum.
virtual std::string getAbbreviation () const
 Returns an abbreviation of the name of the measure for the log file headers.

Detailed Description

Interface for measures checking the convergence of a series of datasets.

A measurement involves two states of the data set: an old state and a new state. Typically, the states corresponds to timestep $t$ and $t+1$. The subclasses of ConvergenceMeasure define how exactly convergence is measured.

A measure has to be used in the following way:

  1. create the measure object (a subclass of ConvergenceMeasure)
  2. call newMeasurementSeries() for one set of iterations
  3. call measure() for convergence measurement
  4. retrieve the convergence status via isConvergence()

Definition at line 22 of file ConvergenceMeasure.hpp.

Constructor & Destructor Documentation

◆ ~ConvergenceMeasure()

virtual precice::cplscheme::impl::ConvergenceMeasure::~ConvergenceMeasure ( )

Destructor, empty.

Definition at line 25 of file ConvergenceMeasure.hpp.

Member Function Documentation

◆ getAbbreviation()

virtual std::string precice::cplscheme::impl::ConvergenceMeasure::getAbbreviation ( ) const

◆ getNormResidual()

virtual double precice::cplscheme::impl::ConvergenceMeasure::getNormResidual ( )

◆ isConvergence()

virtual bool precice::cplscheme::impl::ConvergenceMeasure::isConvergence ( ) const
pure virtual

◆ measure()

virtual void precice::cplscheme::impl::ConvergenceMeasure::measure ( const Eigen::VectorXd & oldValues,
const Eigen::VectorXd & newValues )
pure virtual

◆ newMeasurementSeries()

virtual void precice::cplscheme::impl::ConvergenceMeasure::newMeasurementSeries ( )
pure virtual

◆ printState()

virtual std::string precice::cplscheme::impl::ConvergenceMeasure::printState ( const std::string & dataName)
pure virtual

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