precice::cplscheme::impl::AbsoluteConvergenceMeasure Class Reference

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

#include <AbsoluteConvergenceMeasure.hpp>

Inheritance diagram for precice::cplscheme::impl::AbsoluteConvergenceMeasure:

Collaboration diagram for precice::cplscheme::impl::AbsoluteConvergenceMeasure:

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.
Public Member Functions inherited from precice::cplscheme::impl::ConvergenceMeasure
virtual	~ConvergenceMeasure ()
	Destructor, empty.

Private Attributes
logging::Logger	_log {"cplscheme::AbsoluteConvergenceMeasure"}
double	_convergenceLimit
double	_normDiff = 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 limit, convergence is achieved.

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

Definition at line 33 of file AbsoluteConvergenceMeasure.hpp.

Constructor & Destructor Documentation

AbsoluteConvergenceMeasure()

precice::cplscheme::impl::AbsoluteConvergenceMeasure::AbsoluteConvergenceMeasure ( double convergenceLimit )

explicit

Definition at line 7 of file AbsoluteConvergenceMeasure.cpp.

Here is the call graph for this function:

~AbsoluteConvergenceMeasure()

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

inlinevirtual

Definition at line 37 of file AbsoluteConvergenceMeasure.hpp.

Member Function Documentation

getAbbreviation()

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

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.

getNormResidual()

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

inlinevirtual

Returns the l2-norm of the coupling residuum.

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

Definition at line 73 of file AbsoluteConvergenceMeasure.hpp.

isConvergence()

virtual bool precice::cplscheme::impl::AbsoluteConvergenceMeasure::isConvergence ( ) const

inlinevirtual

Returns true, if the last measurement indicates convergence.

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

Definition at line 52 of file AbsoluteConvergenceMeasure.hpp.

measure()

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

inlinevirtual

Performs convergence measurement.

Parameters

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

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

Definition at line 44 of file AbsoluteConvergenceMeasure.hpp.

Here is the call graph for this function:

newMeasurementSeries()

virtual void precice::cplscheme::impl::AbsoluteConvergenceMeasure::newMeasurementSeries ( )

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.

printState()

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

inlinevirtual

Adds current convergence information to output stream.

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

Definition at line 58 of file AbsoluteConvergenceMeasure.hpp.

Here is the call graph for this function:

Member Data Documentation

_convergenceLimit

double precice::cplscheme::impl::AbsoluteConvergenceMeasure::_convergenceLimit

private

Definition at line 86 of file AbsoluteConvergenceMeasure.hpp.

_isConvergence

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

private

Definition at line 90 of file AbsoluteConvergenceMeasure.hpp.

_log

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

private

Definition at line 84 of file AbsoluteConvergenceMeasure.hpp.

_normDiff

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

private

Definition at line 88 of file AbsoluteConvergenceMeasure.hpp.

---

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

• src/cplscheme/impl/AbsoluteConvergenceMeasure.hpp
• src/cplscheme/impl/AbsoluteConvergenceMeasure.cpp