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	setExperimental (bool experimental)

virtual	~CouplingSchemeConfiguration ()
	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.

virtual void	xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
	Callback method required when using xml::XMLTag.

virtual void	xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag)
	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 ()

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)

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) 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
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 45 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()

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

inlinevirtual

Destructor, empty.

Definition at line 64 of file CouplingSchemeConfiguration.hpp.

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 669 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 693 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 616 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 1156 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 380 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 1018 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 1066 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 723 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 753 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 552 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 567 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 658 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ addTagExchange()

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

private

Definition at line 530 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 646 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 634 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 516 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 501 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 601 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 585 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 464 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 413 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ checkIfDataIsExchanged()

void precice::cplscheme::CouplingSchemeConfiguration::checkIfDataIsExchanged ( DataID dataID ) const

private

Definition at line 1101 of file CouplingSchemeConfiguration.cpp.

Here is the call graph for this function:

◆ checkIterationLimits()

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

private

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

Definition at line 977 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 1124 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 991 of file CouplingSchemeConfiguration.cpp.

◆ createMultiCouplingScheme()

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

private

Definition at line 911 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 827 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 886 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 804 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 850 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 793 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 783 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 956 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:

◆ setExperimental()

void precice::cplscheme::CouplingSchemeConfiguration::setExperimental ( bool experimental )

◆ setParallelAcceleration()

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

private

Definition at line 1184 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