Measures the convergence from an old data set to a new one. More...

#include <AbsoluteOrRelativeConvergenceMeasure.hpp>

Inheritance diagram for precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure:

Collaboration diagram for precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure:

Public Member Functions
	AbsoluteOrRelativeConvergenceMeasure (double absLimit, double relLimit)
	Constructor.

	~AbsoluteOrRelativeConvergenceMeasure () override=default

void	newMeasurementSeries () override
	To be called when a new meas. series (iteration process) starts.

void	measure (const Eigen::VectorXd &oldValues, const Eigen::VectorXd &newValues) override
	Performs convergence measurement.

bool	isConvergence () const override
	Returns true, if the last measurement indicates convergence.

std::string	printState (const std::string &dataName) override
	Adds current convergence information to output stream.

virtual double	getNormAbsResidual ()

virtual double	getNormRelResidual ()

std::string	getAbbreviation () const override
	Returns an abbreviation of the name of the measure for the log file headers.

Public Member Functions inherited from precice::cplscheme::impl::ConvergenceMeasure
virtual	~ConvergenceMeasure ()=default
	Destructor, empty.

virtual double	getNormResidual ()
	Returns the l2-norm of the coupling residuum.

Private Attributes
logging::Logger	_log {"cplscheme::AbsoluteOrRelativeConvergenceMeasure"}

double	_convergenceLimit

double	_convergenceLimitPercent

double	_normDiff = 0

double	_norm = 0

bool	_isConvergence = false

Detailed Description

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 absolute value or a given percentage of the norm of the new data set, convergence is achieved.

For a description of how to perform the measurement, see class ConvergenceMeasure.

Definition at line 37 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

Constructor & Destructor Documentation

◆ AbsoluteOrRelativeConvergenceMeasure()

precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::AbsoluteOrRelativeConvergenceMeasure	(	double	absLimit,
		double	relLimit )

Constructor.

Parameters

[in]	absLimit	Limit to define absolute convergence to the norm of the current new dataset. Has to be larger than zero.
[in]	relLimit	Limit to define convergence relative to the norm of the current new dataset. Has to be in $] 0 ; 1 ]$.

Definition at line 6 of file AbsoluteOrRelativeConvergenceMeasure.cpp.

Here is the call graph for this function:

◆ ~AbsoluteOrRelativeConvergenceMeasure()

precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::~AbsoluteOrRelativeConvergenceMeasure ( )

overridedefault

Member Function Documentation

◆ getAbbreviation()

std::string precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::getAbbreviation ( ) const

inlineoverridevirtual

Returns an abbreviation of the name of the measure for the log file headers.

Reimplemented from precice::cplscheme::impl::ConvergenceMeasure.

Definition at line 110 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ getNormAbsResidual()

virtual double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::getNormAbsResidual ( )

inlinevirtual

Definition at line 97 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ getNormRelResidual()

virtual double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::getNormRelResidual ( )

inlinevirtual

Definition at line 102 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

◆ isConvergence()

bool precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::isConvergence ( ) const

inlineoverridevirtual

Returns true, if the last measurement indicates convergence.

Implements precice::cplscheme::impl::ConvergenceMeasure.

Definition at line 68 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ measure()

void precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::measure	(	const Eigen::VectorXd &	oldValues,
		const Eigen::VectorXd &	newValues )

inlineoverridevirtual

Performs convergence measurement.

Parameters

[in]	oldValues	Old iterate values.
[in]	newValues	New iterate values.

Implements precice::cplscheme::impl::ConvergenceMeasure.

Definition at line 58 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

◆ newMeasurementSeries()

void precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::newMeasurementSeries ( )

inlineoverridevirtual

To be called when a new meas. series (iteration process) starts.

Implements precice::cplscheme::impl::ConvergenceMeasure.

Definition at line 53 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ printState()

std::string precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::printState ( const std::string & dataName )

inlineoverridevirtual

Adds current convergence information to output stream.

Implements precice::cplscheme::impl::ConvergenceMeasure.

Definition at line 76 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ _convergenceLimit

double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_convergenceLimit

private

Definition at line 118 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ _convergenceLimitPercent

double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_convergenceLimitPercent

private

Definition at line 120 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ _isConvergence

bool precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_isConvergence = false

private

Definition at line 126 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ _log

logging::Logger precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_log {"cplscheme::AbsoluteOrRelativeConvergenceMeasure"}

private

Definition at line 116 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ _norm

double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_norm = 0

private

Definition at line 124 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

◆ _normDiff

double precice::cplscheme::impl::AbsoluteOrRelativeConvergenceMeasure::_normDiff = 0

private

Definition at line 122 of file AbsoluteOrRelativeConvergenceMeasure.hpp.

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

src/cplscheme/impl/AbsoluteOrRelativeConvergenceMeasure.hpp
src/cplscheme/impl/AbsoluteOrRelativeConvergenceMeasure.cpp

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AbsoluteOrRelativeConvergenceMeasure()

◆ ~AbsoluteOrRelativeConvergenceMeasure()

Member Function Documentation

◆ getAbbreviation()

◆ getNormAbsResidual()

◆ getNormRelResidual()

◆ isConvergence()

◆ measure()

◆ newMeasurementSeries()

◆ printState()

Member Data Documentation

◆ _convergenceLimit

◆ _convergenceLimitPercent

◆ _isConvergence

◆ _log

◆ _norm

◆ _normDiff