preCICE v3.2.0
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
precice::cplscheme::impl::RelativeConvergenceMeasure Class Reference

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

#include <RelativeConvergenceMeasure.hpp>

Inheritance diagram for precice::cplscheme::impl::RelativeConvergenceMeasure:
[legend]
Collaboration diagram for precice::cplscheme::impl::RelativeConvergenceMeasure:
[legend]

Public Member Functions

 RelativeConvergenceMeasure (double convergenceLimitPercent)
 Constructor.
 
 ~RelativeConvergenceMeasure () 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.
 
double getNormResidual () override
 Returns the l2-norm of the coupling residuum.
 
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.
 

Private Attributes

logging::Logger _log {"cplscheme::RelativeConvergenceMeasure"}
 
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 percentage of the norm of the old data set, convergence is achieved.

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

Definition at line 36 of file RelativeConvergenceMeasure.hpp.

Constructor & Destructor Documentation

◆ RelativeConvergenceMeasure()

precice::cplscheme::impl::RelativeConvergenceMeasure::RelativeConvergenceMeasure ( double convergenceLimitPercent)

Constructor.

Parameters
[in]convergenceLimitPercentLimit to define convergence relative to the norm of the current new dataset. Has to be in $] 0 ; 1 ]$.

Definition at line 6 of file RelativeConvergenceMeasure.cpp.

Here is the call graph for this function:

◆ ~RelativeConvergenceMeasure()

precice::cplscheme::impl::RelativeConvergenceMeasure::~RelativeConvergenceMeasure ( )
overridedefault

Member Function Documentation

◆ getAbbreviation()

std::string precice::cplscheme::impl::RelativeConvergenceMeasure::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 103 of file RelativeConvergenceMeasure.hpp.

◆ getNormResidual()

double precice::cplscheme::impl::RelativeConvergenceMeasure::getNormResidual ( )
inlineoverridevirtual

Returns the l2-norm of the coupling residuum.

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

Definition at line 95 of file RelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

◆ isConvergence()

bool precice::cplscheme::impl::RelativeConvergenceMeasure::isConvergence ( ) const
inlineoverridevirtual

Returns true, if the last measurement indicates convergence.

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

Definition at line 71 of file RelativeConvergenceMeasure.hpp.

◆ measure()

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

Performs convergence measurement.

Parameters
[in]oldValuesOld iterate values.
[in]newValuesNew iterate values.

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

Definition at line 54 of file RelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

◆ newMeasurementSeries()

void precice::cplscheme::impl::RelativeConvergenceMeasure::newMeasurementSeries ( )
inlineoverridevirtual

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

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

Definition at line 49 of file RelativeConvergenceMeasure.hpp.

◆ printState()

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

Adds current convergence information to output stream.

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

Definition at line 79 of file RelativeConvergenceMeasure.hpp.

Here is the call graph for this function:

Member Data Documentation

◆ _convergenceLimitPercent

double precice::cplscheme::impl::RelativeConvergenceMeasure::_convergenceLimitPercent
private

Definition at line 111 of file RelativeConvergenceMeasure.hpp.

◆ _isConvergence

bool precice::cplscheme::impl::RelativeConvergenceMeasure::_isConvergence = false
private

Definition at line 117 of file RelativeConvergenceMeasure.hpp.

◆ _log

logging::Logger precice::cplscheme::impl::RelativeConvergenceMeasure::_log {"cplscheme::RelativeConvergenceMeasure"}
private

Definition at line 109 of file RelativeConvergenceMeasure.hpp.

◆ _norm

double precice::cplscheme::impl::RelativeConvergenceMeasure::_norm = 0
private

Definition at line 115 of file RelativeConvergenceMeasure.hpp.

◆ _normDiff

double precice::cplscheme::impl::RelativeConvergenceMeasure::_normDiff = 0
private

Definition at line 113 of file RelativeConvergenceMeasure.hpp.

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