precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext Struct Reference

Holds meta information to perform a convergence measurement. More...

Collaboration diagram for precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext:

Public Member Functions
std::string	logHeader () const

Public Attributes
PtrCouplingData	couplingData
bool	suffices
bool	strict
impl::PtrConvergenceMeasure	measure

Detailed Description

Holds meta information to perform a convergence measurement.

Parameters

data	Associated data field
couplingData	Coupling data history
suffices	Whether this measure already suffices for convergence
strict	Whether non-convergence of this measure leads to a premature end of the simulation
measure	Link to the actual convergence measure
doesLogging	Whether this measure is logged in the convergence file

Definition at line 491 of file BaseCouplingScheme.hpp.

Member Function Documentation

logHeader()

std::string precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext::logHeader ( ) const

inline

Definition at line 497 of file BaseCouplingScheme.hpp.

Member Data Documentation

couplingData

PtrCouplingData precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext::couplingData

Definition at line 492 of file BaseCouplingScheme.hpp.

measure

impl::PtrConvergenceMeasure precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext::measure

Definition at line 495 of file BaseCouplingScheme.hpp.

strict

bool precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext::strict

Definition at line 494 of file BaseCouplingScheme.hpp.

suffices

bool precice::cplscheme::BaseCouplingScheme::ConvergenceMeasureContext::suffices

Definition at line 493 of file BaseCouplingScheme.hpp.

---

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

• src/cplscheme/BaseCouplingScheme.hpp