Configuration for coupling schemes. More...

#include <CouplingSchemeConfiguration.hpp>

Inheritance diagram for precice::cplscheme::CouplingSchemeConfiguration:

Collaboration diagram for precice::cplscheme::CouplingSchemeConfiguration:

Classes
struct	Config
struct	ConvergenceMeasureDefintion

Public Member Functions
	CouplingSchemeConfiguration (xml::XMLTag &parent, mesh::PtrMeshConfiguration meshConfig, m2n::M2NConfiguration::SharedPointer m2nConfig, config::PtrParticipantConfiguration participantConfig)
	Constructor.
void	setRemeshing (bool allowed)
	~CouplingSchemeConfiguration () override=default
	Destructor, empty.
bool	hasCouplingScheme (const std::string &participantName) const
	Check, if a coupling scheme is configured for a participant.
const PtrCouplingScheme &	getCouplingScheme (const std::string &participantName) const
	Returns the configured coupling scheme.
const std::string &	getDataToExchange (int index) const
	Returns the name of one dataset exchanged in the coupling scheme.
void	xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback method required when using xml::XMLTag.
void	xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback method required when using xml::XMLTag.
void	addCouplingScheme (const PtrCouplingScheme &cplScheme, const std::string &participantName)
	Adds a manually configured coupling scheme for a participant.
Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener &	operator= (Listener &&)=delete
virtual	~Listener ()=default

Private Member Functions
void	addTypespecifcSubtags (const std::string &type, xml::XMLTag &tag)
void	addTransientLimitTags (const std::string &type, xml::XMLTag &tag)
void	addTagParticipants (xml::XMLTag &tag)
void	addTagParticipant (xml::XMLTag &tag)
void	addTagExchange (xml::XMLTag &tag, bool substepsDefault)
void	addTagAbsoluteConvergenceMeasure (xml::XMLTag &tag)
void	addTagAbsoluteOrRelativeConvergenceMeasure (xml::XMLTag &tag)
void	addTagRelativeConvergenceMeasure (xml::XMLTag &tag)
void	addTagResidualRelativeConvergenceMeasure (xml::XMLTag &tag)
void	addBaseAttributesTagConvergenceMeasure (xml::XMLTag &tag)
void	addTagMinIterations (xml::XMLTag &tag)
void	addTagMaxIterations (xml::XMLTag &tag)
void	addTagAcceleration (xml::XMLTag &tag)
void	addAbsoluteConvergenceMeasure (const std::string &dataName, const std::string &meshName, double limit, bool suffices, bool strict)
void	addAbsoluteOrRelativeConvergenceMeasure (const std::string &dataName, const std::string &meshName, double absLimit, double relLimit, bool suffices, bool strict)
void	addRelativeConvergenceMeasure (const std::string &dataName, const std::string &meshName, double limit, bool suffices, bool strict)
void	addResidualRelativeConvergenceMeasure (const std::string &dataName, const std::string &meshName, double limit, bool suffices, bool strict)
mesh::PtrData	getData (const std::string &dataName, const std::string &meshName) const
mesh::PtrData	findDataByID (int ID) const
PtrCouplingScheme	createSerialExplicitCouplingScheme (const std::string &accessor) const
PtrCouplingScheme	createParallelExplicitCouplingScheme (const std::string &accessor) const
PtrCouplingScheme	createSerialImplicitCouplingScheme (const std::string &accessor) const
PtrCouplingScheme	createParallelImplicitCouplingScheme (const std::string &accessor) const
PtrCouplingScheme	createMultiCouplingScheme (const std::string &accessor) const
constants::TimesteppingMethod	getTimesteppingMethod (const std::string &method) const
void	addDataToBeExchanged (BiCouplingScheme &scheme, const std::string &accessor) const
	Adds configured exchange data to be sent or received to scheme.
void	addMultiDataToBeExchanged (MultiCouplingScheme &scheme, const std::string &accessor) const
	Adds configured exchange data to be sent or received to scheme. Only used specifically for MultiCouplingScheme.
void	checkIfDataIsExchanged (DataID dataID, std::string_view participant) const
void	checkSerialImplicitAccelerationData (DataID dataID, const std::string &first, const std::string &second) const
void	addConvergenceMeasures (BaseCouplingScheme *scheme, const std::string &participant, const std::vector< ConvergenceMeasureDefintion > &convergenceMeasureDefinitions) const
void	setSerialAcceleration (BaseCouplingScheme *scheme, const std::string &first, const std::string &second) const
void	setParallelAcceleration (BaseCouplingScheme *scheme, const std::string &participant) const
void	checkSubstepExchangeWaveformDegree (const Config::Exchange &exchange) const
	Helper function to check that waveform-degree and substep exchange are compatible.
void	updateConfigForImplicitCoupling ()
	Helper to update some configs which may have a different meaning in implicit coupling.
void	checkIterationLimits () const
	Helper function to check iteration limits in conjunction with convergence measures.

Private Attributes
bool	_allowRemeshing = false
logging::Logger	_log {"cplscheme::CouplingSchemeConfiguration"}
const std::string	TAG
const std::string	TAG_PARTICIPANTS
const std::string	TAG_PARTICIPANT
const std::string	TAG_EXCHANGE
const std::string	TAG_MAX_TIME
const std::string	TAG_MAX_TIME_WINDOWS
const std::string	TAG_TIME_WINDOW_SIZE
const std::string	TAG_ABS_CONV_MEASURE
const std::string	TAG_ABS_OR_REL_CONV_MEASURE
const std::string	TAG_REL_CONV_MEASURE
const std::string	TAG_RES_REL_CONV_MEASURE
const std::string	TAG_MIN_ITERATIONS
const std::string	TAG_MAX_ITERATIONS
const std::string	ATTR_DATA
const std::string	ATTR_MESH
const std::string	ATTR_PARTICIPANT
const std::string	ATTR_INITIALIZE
const std::string	ATTR_EXCHANGE_SUBSTEPS
const std::string	ATTR_TYPE
const std::string	ATTR_FIRST
const std::string	ATTR_SECOND
const std::string	ATTR_VALUE
const std::string	ATTR_METHOD
const std::string	ATTR_LIMIT
const std::string	ATTR_ABS_LIMIT
const std::string	ATTR_REL_LIMIT
const std::string	ATTR_NAME
const std::string	ATTR_FROM
const std::string	ATTR_TO
const std::string	ATTR_SUFFICES
const std::string	ATTR_STRICT
const std::string	ATTR_CONTROL
const std::string	VALUE_SERIAL_EXPLICIT
const std::string	VALUE_PARALLEL_EXPLICIT
const std::string	VALUE_SERIAL_IMPLICIT
const std::string	VALUE_PARALLEL_IMPLICIT
const std::string	VALUE_MULTI
const std::string	VALUE_FIXED
const std::string	VALUE_FIRST_PARTICIPANT
struct precice::cplscheme::CouplingSchemeConfiguration::Config	_config
mesh::PtrMeshConfiguration	_meshConfig
m2n::M2NConfiguration::SharedPointer	_m2nConfig
acceleration::PtrAccelerationConfiguration	_accelerationConfig
precice::config::PtrParticipantConfiguration	_participantConfig
std::map< std::string, PtrCouplingScheme >	_couplingSchemes
	Map from participant name to coupling scheme (composition).
std::map< std::string, CompositionalCouplingScheme * >	_couplingSchemeCompositions
	If a participant has more than one coupling scheme, a composition is created.

Static Private Attributes
static const int	DEFAULT_MIN_ITERATIONS
static const int	DEFAULT_MAX_ITERATIONS

Detailed Description

Configuration for coupling schemes.

Definition at line 43 of file CouplingSchemeConfiguration.hpp.

Constructor & Destructor Documentation

◆ CouplingSchemeConfiguration()

precice::cplscheme::CouplingSchemeConfiguration::CouplingSchemeConfiguration	(	xml::XMLTag &	parent,
		mesh::PtrMeshConfiguration	meshConfig,
		m2n::M2NConfiguration::SharedPointer	m2nConfig,
		config::PtrParticipantConfiguration	participantConfig )

Constructor.

Parameters

[in]	parent	Used to add subtags to hierarchical XML structure.
[in]	meshConfig	For checking if a used mesh is defined.
[in]	m2nConfig	For checking if a communication between participants to be coupled is defined.
[in]	participantConfig	For checking waveform degree.

Definition at line 45 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ ~CouplingSchemeConfiguration()

precice::cplscheme::CouplingSchemeConfiguration::~CouplingSchemeConfiguration ( )

overridedefault

Destructor, empty.

Member Function Documentation

◆ addAbsoluteConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addAbsoluteConvergenceMeasure	(	const std::string &	dataName,
		const std::string &	meshName,
		double	limit,
		bool	suffices,
		bool	strict )

private

Definition at line 685 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addAbsoluteOrRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addAbsoluteOrRelativeConvergenceMeasure	(	const std::string &	dataName,
		const std::string &	meshName,
		double	absLimit,
		double	relLimit,
		bool	suffices,
		bool	strict )

private

Definition at line 707 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addBaseAttributesTagConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addBaseAttributesTagConvergenceMeasure ( xml::XMLTag & tag )

private

Definition at line 632 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addConvergenceMeasures()

void precice::cplscheme::CouplingSchemeConfiguration::addConvergenceMeasures	(	BaseCouplingScheme *	scheme,
		const std::string &	participant,
		const std::vector< ConvergenceMeasureDefintion > &	convergenceMeasureDefinitions ) const

private

Definition at line 1168 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addCouplingScheme()

void precice::cplscheme::CouplingSchemeConfiguration::addCouplingScheme	(	const PtrCouplingScheme &	cplScheme,
		const std::string &	participantName )

Adds a manually configured coupling scheme for a participant.

Definition at line 394 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addDataToBeExchanged()

void precice::cplscheme::CouplingSchemeConfiguration::addDataToBeExchanged	(	BiCouplingScheme &	scheme,
		const std::string &	accessor ) const

private

Adds configured exchange data to be sent or received to scheme.

Definition at line 1023 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addMultiDataToBeExchanged()

void precice::cplscheme::CouplingSchemeConfiguration::addMultiDataToBeExchanged	(	MultiCouplingScheme &	scheme,
		const std::string &	accessor ) const

private

Adds configured exchange data to be sent or received to scheme. Only used specifically for MultiCouplingScheme.

Definition at line 1071 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addRelativeConvergenceMeasure	(	const std::string &	dataName,
		const std::string &	meshName,
		double	limit,
		bool	suffices,
		bool	strict )

private

Definition at line 735 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addResidualRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addResidualRelativeConvergenceMeasure	(	const std::string &	dataName,
		const std::string &	meshName,
		double	limit,
		bool	suffices,
		bool	strict )

private

Definition at line 763 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagAbsoluteConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addTagAbsoluteConvergenceMeasure ( xml::XMLTag & tag )

private

Definition at line 568 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagAbsoluteOrRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addTagAbsoluteOrRelativeConvergenceMeasure ( xml::XMLTag & tag )

private

Definition at line 583 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagAcceleration()

void precice::cplscheme::CouplingSchemeConfiguration::addTagAcceleration ( xml::XMLTag & tag )

private

Definition at line 674 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagExchange()

void precice::cplscheme::CouplingSchemeConfiguration::addTagExchange	(	xml::XMLTag &	tag,
		bool	substepsDefault )

private

Definition at line 546 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagMaxIterations()

void precice::cplscheme::CouplingSchemeConfiguration::addTagMaxIterations ( xml::XMLTag & tag )

private

Definition at line 662 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagMinIterations()

void precice::cplscheme::CouplingSchemeConfiguration::addTagMinIterations ( xml::XMLTag & tag )

private

Definition at line 650 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagParticipant()

void precice::cplscheme::CouplingSchemeConfiguration::addTagParticipant ( xml::XMLTag & tag )

private

Definition at line 532 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagParticipants()

void precice::cplscheme::CouplingSchemeConfiguration::addTagParticipants ( xml::XMLTag & tag )

private

Definition at line 517 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addTagRelativeConvergenceMeasure ( xml::XMLTag & tag )

private

Definition at line 617 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagResidualRelativeConvergenceMeasure()

void precice::cplscheme::CouplingSchemeConfiguration::addTagResidualRelativeConvergenceMeasure ( xml::XMLTag & tag )

private

Definition at line 601 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTransientLimitTags()

void precice::cplscheme::CouplingSchemeConfiguration::addTransientLimitTags	(	const std::string &	type,
		xml::XMLTag &	tag )

private

Definition at line 480 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTypespecifcSubtags()

void precice::cplscheme::CouplingSchemeConfiguration::addTypespecifcSubtags	(	const std::string &	type,
		xml::XMLTag &	tag )

private

Definition at line 429 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ checkIfDataIsExchanged()

void precice::cplscheme::CouplingSchemeConfiguration::checkIfDataIsExchanged	(	DataID	dataID,
		std::string_view	participant ) const

private

Definition at line 1106 of file CouplingSchemeConfiguration.cpp.

◆ checkIterationLimits()

void precice::cplscheme::CouplingSchemeConfiguration::checkIterationLimits ( ) const

private

Helper function to check iteration limits in conjunction with convergence measures.

Definition at line 982 of file CouplingSchemeConfiguration.cpp.

◆ checkSerialImplicitAccelerationData()

void precice::cplscheme::CouplingSchemeConfiguration::checkSerialImplicitAccelerationData	(	DataID	dataID,
		const std::string &	first,
		const std::string &	second ) const

private

Definition at line 1136 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ checkSubstepExchangeWaveformDegree()

void precice::cplscheme::CouplingSchemeConfiguration::checkSubstepExchangeWaveformDegree ( const Config::Exchange & exchange ) const

private

Helper function to check that waveform-degree and substep exchange are compatible.

The following rules are checked:

1) If waveform-degree="0", then user must set substeps="false", because constant interpolation (zeroth degree) is intended for debugging and user should use first degree instead. 2) If waveform-degree="1", then any configuration for substeps is allowed. The user might want to set substeps="false" for better performance. 3) If waveform-degree="2" or greater, the user must set substeps="true", because subcycling and exchange of substeps is required for higher-degree B-splines.

Parameters

exchange The Exchange being checked.

Definition at line 996 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ createMultiCouplingScheme()

PtrCouplingScheme precice::cplscheme::CouplingSchemeConfiguration::createMultiCouplingScheme ( const std::string & accessor ) const

private

Definition at line 915 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ createParallelExplicitCouplingScheme()

PtrCouplingScheme precice::cplscheme::CouplingSchemeConfiguration::createParallelExplicitCouplingScheme ( const std::string & accessor ) const

private

Definition at line 832 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ createParallelImplicitCouplingScheme()

PtrCouplingScheme precice::cplscheme::CouplingSchemeConfiguration::createParallelImplicitCouplingScheme ( const std::string & accessor ) const

private

Definition at line 889 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ createSerialExplicitCouplingScheme()

PtrCouplingScheme precice::cplscheme::CouplingSchemeConfiguration::createSerialExplicitCouplingScheme ( const std::string & accessor ) const

private

Definition at line 812 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ createSerialImplicitCouplingScheme()

PtrCouplingScheme precice::cplscheme::CouplingSchemeConfiguration::createSerialImplicitCouplingScheme ( const std::string & accessor ) const

private

Definition at line 853 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ findDataByID()

mesh::PtrData precice::cplscheme::CouplingSchemeConfiguration::findDataByID ( int ID ) const

private

Definition at line 801 of file CouplingSchemeConfiguration.cpp.

◆ getCouplingScheme()

const PtrCouplingScheme & precice::cplscheme::CouplingSchemeConfiguration::getCouplingScheme ( const std::string & participantName ) const

Returns the configured coupling scheme.

Definition at line 145 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ getData()

mesh::PtrData precice::cplscheme::CouplingSchemeConfiguration::getData	(	const std::string &	dataName,
		const std::string &	meshName ) const

private

Definition at line 791 of file CouplingSchemeConfiguration.cpp.

◆ getDataToExchange()

const std::string & precice::cplscheme::CouplingSchemeConfiguration::getDataToExchange ( int index ) const

Returns the name of one dataset exchanged in the coupling scheme.

◆ getTimesteppingMethod()

constants::TimesteppingMethod precice::cplscheme::CouplingSchemeConfiguration::getTimesteppingMethod ( const std::string & method ) const

private

Definition at line 961 of file CouplingSchemeConfiguration.cpp.

◆ hasCouplingScheme()

bool precice::cplscheme::CouplingSchemeConfiguration::hasCouplingScheme ( const std::string & participantName ) const

Check, if a coupling scheme is configured for a participant.

Definition at line 139 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ setParallelAcceleration()

void precice::cplscheme::CouplingSchemeConfiguration::setParallelAcceleration	(	BaseCouplingScheme *	scheme,
		const std::string &	participant ) const

private

Definition at line 1196 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ setRemeshing()

void precice::cplscheme::CouplingSchemeConfiguration::setRemeshing ( bool allowed )

Definition at line 1219 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ setSerialAcceleration()

void precice::cplscheme::CouplingSchemeConfiguration::setSerialAcceleration	(	BaseCouplingScheme *	scheme,
		const std::string &	first,
		const std::string &	second ) const

private

Definition at line 1180 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ updateConfigForImplicitCoupling()

void precice::cplscheme::CouplingSchemeConfiguration::updateConfigForImplicitCoupling ( )

private

Helper to update some configs which may have a different meaning in implicit coupling.

Definition at line 975 of file CouplingSchemeConfiguration.cpp.

◆ xmlEndTagCallback()

void precice::cplscheme::CouplingSchemeConfiguration::xmlEndTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback method required when using xml::XMLTag.

TODO test multi coupling scheme

Implements precice::xml::XMLTag::Listener.

Definition at line 318 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::cplscheme::CouplingSchemeConfiguration::xmlTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback method required when using xml::XMLTag.

Implements precice::xml::XMLTag::Listener.

Definition at line 156 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _accelerationConfig

acceleration::PtrAccelerationConfiguration precice::cplscheme::CouplingSchemeConfiguration::_accelerationConfig

private

Definition at line 175 of file CouplingSchemeConfiguration.hpp.

◆ _allowRemeshing

bool precice::cplscheme::CouplingSchemeConfiguration::_allowRemeshing = false

private

Definition at line 83 of file CouplingSchemeConfiguration.hpp.

◆ _config

struct precice::cplscheme::CouplingSchemeConfiguration::Config precice::cplscheme::CouplingSchemeConfiguration::_config

private

◆ _couplingSchemeCompositions

std::map<std::string, CompositionalCouplingScheme *> precice::cplscheme::CouplingSchemeConfiguration::_couplingSchemeCompositions

private

If a participant has more than one coupling scheme, a composition is created.

Definition at line 183 of file CouplingSchemeConfiguration.hpp.

◆ _couplingSchemes

std::map<std::string, PtrCouplingScheme> precice::cplscheme::CouplingSchemeConfiguration::_couplingSchemes

private

Map from participant name to coupling scheme (composition).

Definition at line 180 of file CouplingSchemeConfiguration.hpp.

◆ _log

logging::Logger precice::cplscheme::CouplingSchemeConfiguration::_log {"cplscheme::CouplingSchemeConfiguration"}

mutableprivate

Definition at line 84 of file CouplingSchemeConfiguration.hpp.

◆ _m2nConfig

m2n::M2NConfiguration::SharedPointer precice::cplscheme::CouplingSchemeConfiguration::_m2nConfig

private

Definition at line 173 of file CouplingSchemeConfiguration.hpp.

◆ _meshConfig

mesh::PtrMeshConfiguration precice::cplscheme::CouplingSchemeConfiguration::_meshConfig

private

Definition at line 171 of file CouplingSchemeConfiguration.hpp.

◆ _participantConfig

precice::config::PtrParticipantConfiguration precice::cplscheme::CouplingSchemeConfiguration::_participantConfig

private

Definition at line 177 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_ABS_LIMIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_ABS_LIMIT

private

Definition at line 111 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_CONTROL

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_CONTROL

private

Definition at line 118 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_DATA

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_DATA

private

Definition at line 100 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_EXCHANGE_SUBSTEPS

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_EXCHANGE_SUBSTEPS

private

Definition at line 104 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_FIRST

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_FIRST

private

Definition at line 106 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_FROM

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_FROM

private

Definition at line 114 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_INITIALIZE

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_INITIALIZE

private

Definition at line 103 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_LIMIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_LIMIT

private

Definition at line 110 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_MESH

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_MESH

private

Definition at line 101 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_METHOD

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_METHOD

private

Definition at line 109 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_NAME

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_NAME

private

Definition at line 113 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_PARTICIPANT

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_PARTICIPANT

private

Definition at line 102 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_REL_LIMIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_REL_LIMIT

private

Definition at line 112 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_SECOND

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_SECOND

private

Definition at line 107 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_STRICT

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_STRICT

private

Definition at line 117 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_SUFFICES

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_SUFFICES

private

Definition at line 116 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_TO

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_TO

private

Definition at line 115 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_TYPE

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_TYPE

private

Definition at line 105 of file CouplingSchemeConfiguration.hpp.

◆ ATTR_VALUE

const std::string precice::cplscheme::CouplingSchemeConfiguration::ATTR_VALUE

private

Definition at line 108 of file CouplingSchemeConfiguration.hpp.

◆ DEFAULT_MAX_ITERATIONS

const int precice::cplscheme::CouplingSchemeConfiguration::DEFAULT_MAX_ITERATIONS

staticprivate

Definition at line 129 of file CouplingSchemeConfiguration.hpp.

◆ DEFAULT_MIN_ITERATIONS

const int precice::cplscheme::CouplingSchemeConfiguration::DEFAULT_MIN_ITERATIONS

staticprivate

Definition at line 128 of file CouplingSchemeConfiguration.hpp.

◆ TAG

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG

private

Definition at line 86 of file CouplingSchemeConfiguration.hpp.

◆ TAG_ABS_CONV_MEASURE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_ABS_CONV_MEASURE

private

Definition at line 93 of file CouplingSchemeConfiguration.hpp.

◆ TAG_ABS_OR_REL_CONV_MEASURE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_ABS_OR_REL_CONV_MEASURE

private

Definition at line 94 of file CouplingSchemeConfiguration.hpp.

◆ TAG_EXCHANGE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_EXCHANGE

private

Definition at line 89 of file CouplingSchemeConfiguration.hpp.

◆ TAG_MAX_ITERATIONS

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_MAX_ITERATIONS

private

Definition at line 98 of file CouplingSchemeConfiguration.hpp.

◆ TAG_MAX_TIME

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_MAX_TIME

private

Definition at line 90 of file CouplingSchemeConfiguration.hpp.

◆ TAG_MAX_TIME_WINDOWS

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_MAX_TIME_WINDOWS

private

Definition at line 91 of file CouplingSchemeConfiguration.hpp.

◆ TAG_MIN_ITERATIONS

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_MIN_ITERATIONS

private

Definition at line 97 of file CouplingSchemeConfiguration.hpp.

◆ TAG_PARTICIPANT

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_PARTICIPANT

private

Definition at line 88 of file CouplingSchemeConfiguration.hpp.

◆ TAG_PARTICIPANTS

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_PARTICIPANTS

private

Definition at line 87 of file CouplingSchemeConfiguration.hpp.

◆ TAG_REL_CONV_MEASURE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_REL_CONV_MEASURE

private

Definition at line 95 of file CouplingSchemeConfiguration.hpp.

◆ TAG_RES_REL_CONV_MEASURE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_RES_REL_CONV_MEASURE

private

Definition at line 96 of file CouplingSchemeConfiguration.hpp.

◆ TAG_TIME_WINDOW_SIZE

const std::string precice::cplscheme::CouplingSchemeConfiguration::TAG_TIME_WINDOW_SIZE

private

Definition at line 92 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_FIRST_PARTICIPANT

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_FIRST_PARTICIPANT

private

Definition at line 126 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_FIXED

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_FIXED

private

Definition at line 125 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_MULTI

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_MULTI

private

Definition at line 124 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_PARALLEL_EXPLICIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_PARALLEL_EXPLICIT

private

Definition at line 121 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_PARALLEL_IMPLICIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_PARALLEL_IMPLICIT

private

Definition at line 123 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_SERIAL_EXPLICIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_SERIAL_EXPLICIT

private

Definition at line 120 of file CouplingSchemeConfiguration.hpp.

◆ VALUE_SERIAL_IMPLICIT

const std::string precice::cplscheme::CouplingSchemeConfiguration::VALUE_SERIAL_IMPLICIT

private

Definition at line 122 of file CouplingSchemeConfiguration.hpp.

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

src/cplscheme/config/CouplingSchemeConfiguration.hpp
src/cplscheme/config/CouplingSchemeConfiguration.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CouplingSchemeConfiguration()

◆ ~CouplingSchemeConfiguration()

Member Function Documentation

◆ addAbsoluteConvergenceMeasure()

◆ addAbsoluteOrRelativeConvergenceMeasure()

◆ addBaseAttributesTagConvergenceMeasure()

◆ addConvergenceMeasures()

◆ addCouplingScheme()

◆ addDataToBeExchanged()

◆ addMultiDataToBeExchanged()

◆ addRelativeConvergenceMeasure()

◆ addResidualRelativeConvergenceMeasure()

◆ addTagAbsoluteConvergenceMeasure()

◆ addTagAbsoluteOrRelativeConvergenceMeasure()

◆ addTagAcceleration()

◆ addTagExchange()

◆ addTagMaxIterations()

◆ addTagMinIterations()

◆ addTagParticipant()

◆ addTagParticipants()

◆ addTagRelativeConvergenceMeasure()

◆ addTagResidualRelativeConvergenceMeasure()

◆ addTransientLimitTags()

◆ addTypespecifcSubtags()

◆ checkIfDataIsExchanged()

◆ checkIterationLimits()

◆ checkSerialImplicitAccelerationData()

◆ checkSubstepExchangeWaveformDegree()

◆ createMultiCouplingScheme()

◆ createParallelExplicitCouplingScheme()

◆ createParallelImplicitCouplingScheme()

◆ createSerialExplicitCouplingScheme()

◆ createSerialImplicitCouplingScheme()

◆ findDataByID()

◆ getCouplingScheme()

◆ getData()

◆ getDataToExchange()

◆ getTimesteppingMethod()

◆ hasCouplingScheme()

◆ setParallelAcceleration()

◆ setRemeshing()

◆ setSerialAcceleration()

◆ updateConfigForImplicitCoupling()

◆ xmlEndTagCallback()

◆ xmlTagCallback()

Member Data Documentation

◆ _accelerationConfig

◆ _allowRemeshing

◆ _config

◆ _couplingSchemeCompositions

◆ _couplingSchemes

◆ _log

◆ _m2nConfig

◆ _meshConfig

◆ _participantConfig

◆ ATTR_ABS_LIMIT

◆ ATTR_CONTROL

◆ ATTR_DATA

◆ ATTR_EXCHANGE_SUBSTEPS

◆ ATTR_FIRST

◆ ATTR_FROM

◆ ATTR_INITIALIZE

◆ ATTR_LIMIT

◆ ATTR_MESH

◆ ATTR_METHOD

◆ ATTR_NAME

◆ ATTR_PARTICIPANT

◆ ATTR_REL_LIMIT

◆ ATTR_SECOND

◆ ATTR_STRICT

◆ ATTR_SUFFICES

◆ ATTR_TO

◆ ATTR_TYPE