preCICE v3.1.2
|
Measures the convergence from an old data set to a new one. More...
#include <AbsoluteConvergenceMeasure.hpp>
Public Member Functions | |
AbsoluteConvergenceMeasure (double convergenceLimit) | |
virtual | ~AbsoluteConvergenceMeasure () |
virtual void | newMeasurementSeries () |
To be called when a new meas. series (iteration process) starts. | |
virtual void | measure (const Eigen::VectorXd &oldValues, const Eigen::VectorXd &newValues) |
Performs convergence measurement. | |
virtual bool | isConvergence () const |
Returns true, if the last measurement indicates convergence. | |
virtual std::string | printState (const std::string &dataName) |
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. | |
![]() | |
virtual | ~ConvergenceMeasure () |
Destructor, empty. | |
Private Attributes | |
logging::Logger | _log {"cplscheme::AbsoluteConvergenceMeasure"} |
double | _convergenceLimit |
double | _normDiff = 0 |
bool | _isConvergence = false |
Measures the convergence from an old data set to a new one.
The convergence is evaluated by looking at the two norm of the differences between each data value from the new and old data set. If the two norm is equal or below a given limit, convergence is achieved.
For a description of how to perform the measurement, see class ConvergenceMeasure.
Definition at line 33 of file AbsoluteConvergenceMeasure.hpp.
|
explicit |
Definition at line 7 of file AbsoluteConvergenceMeasure.cpp.
|
inlinevirtual |
Definition at line 37 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
Returns an abbreviation of the name of the measure for the log file headers.
Reimplemented from precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 78 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
Returns the l2-norm of the coupling residuum.
Reimplemented from precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 73 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
Returns true, if the last measurement indicates convergence.
Implements precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 52 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
Performs convergence measurement.
[in] | oldValues | Old iterate values. |
[in] | newValues | New iterate values. |
Implements precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 44 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
To be called when a new meas. series (iteration process) starts.
Implements precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 39 of file AbsoluteConvergenceMeasure.hpp.
|
inlinevirtual |
Adds current convergence information to output stream.
Implements precice::cplscheme::impl::ConvergenceMeasure.
Definition at line 58 of file AbsoluteConvergenceMeasure.hpp.
|
private |
Definition at line 86 of file AbsoluteConvergenceMeasure.hpp.
|
private |
Definition at line 90 of file AbsoluteConvergenceMeasure.hpp.
|
private |
Definition at line 84 of file AbsoluteConvergenceMeasure.hpp.
|
private |
Definition at line 88 of file AbsoluteConvergenceMeasure.hpp.