Performs XML configuration of a participant. More...

#include <ParticipantConfiguration.hpp>

Inheritance diagram for precice::config::ParticipantConfiguration:

Collaboration diagram for precice::config::ParticipantConfiguration:

Classes
struct	WatchIntegralConfig
struct	WatchPointConfig

Public Member Functions
	ParticipantConfiguration (xml::XMLTag &parent, mesh::PtrMeshConfiguration meshConfiguration)
void	setExperimental (bool experimental)
void	setRemeshing (bool allowed)
void	xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback function required for use of automatic configuration.
void	xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &callingTag) override
	Callback function required for use of automatic configuration.
std::size_t	nParticipants () const
const std::vector< impl::PtrParticipant > &	getParticipants () const
	Returns all configured participants.
const impl::PtrParticipant	getParticipant (std::string_view participantName) const
	Returns a participant with the given name.
std::set< std::string >	knownParticipants () const
bool	hasParticipant (std::string_view name) const
std::string	hintFor (std::string_view wrongName) const
Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener &	operator= (Listener &&)=delete
virtual	~Listener ()=default

Private Member Functions
partition::ReceivedPartition::GeometricFilter	getGeoFilter (const std::string &geoFilter) const
mesh::PtrMesh	copy (const mesh::PtrMesh &mesh) const
const mesh::PtrData &	getData (const mesh::PtrMesh &mesh, const std::string &nameData) const
mapping::PtrMapping	getMapping (const std::string &mappingName)
void	finishParticipantConfiguration (const xml::ConfigurationContext &context, const impl::PtrParticipant &participant)
void	checkIllDefinedMappings (const mapping::MappingConfiguration::ConfiguredMapping &mapping, const impl::PtrParticipant &participant)
	Check whether a mapping to the same mesh and with similar data fields already exists.

Private Attributes
logging::Logger	_log {"config::ParticipantConfiguration"}
const std::string	TAG = "participant"
const std::string	TAG_WRITE = "write-data"
const std::string	TAG_READ = "read-data"
const std::string	TAG_DATA_ACTION = "data-action"
const std::string	TAG_PROVIDE_MESH = "provide-mesh"
const std::string	TAG_RECEIVE_MESH = "receive-mesh"
const std::string	TAG_WATCH_INTEGRAL = "watch-integral"
const std::string	TAG_WATCH_POINT = "watch-point"
const std::string	TAG_INTRA_COMM = "intra-comm"
const std::string	ATTR_NAME = "name"
const std::string	ATTR_SOURCE_DATA = "source-data"
const std::string	ATTR_TARGET_DATA = "target-data"
const std::string	ATTR_TIMING = "timing"
const std::string	ATTR_LOCAL_OFFSET = "offset"
const std::string	ATTR_ACTION_TYPE = "type"
const std::string	ATTR_FROM = "from"
const std::string	ATTR_SAFETY_FACTOR = "safety-factor"
const std::string	ATTR_GEOMETRIC_FILTER = "geometric-filter"
const std::string	ATTR_DIRECT_ACCESS = "direct-access"
const std::string	ATTR_API_ACCESS = "api-access"
const std::string	ATTR_PROVIDE = "provide"
const std::string	ATTR_MESH = "mesh"
const std::string	ATTR_COORDINATE = "coordinate"
const std::string	ATTR_COMMUNICATION = "communication"
const std::string	ATTR_CONTEXT = "context"
const std::string	ATTR_NETWORK = "network"
const std::string	ATTR_EXCHANGE_DIRECTORY = "exchange-directory"
const std::string	ATTR_SCALE_WITH_CONN = "scale-with-connectivity"
const std::string	VALUE_FILTER_ON_SECONDARY_RANKS = "on-secondary-ranks"
const std::string	VALUE_FILTER_ON_PRIMARY_RANK = "on-primary-rank"
const std::string	VALUE_NO_FILTER = "no-filter"
const std::string	VALUE_VTK = "vtk"
const std::string	VALUE_VTU = "vtu"
const std::string	VALUE_VTP = "vtp"
const std::string	VALUE_CSV = "csv"
bool	_experimental = false
bool	_remeshing = false
mesh::PtrMeshConfiguration	_meshConfig
mapping::PtrMappingConfiguration	_mappingConfig
action::PtrActionConfiguration	_actionConfig
io::PtrExportConfiguration	_exportConfig
std::vector< impl::PtrParticipant >	_participants
std::vector< WatchPointConfig >	_watchPointConfigs
std::vector< WatchIntegralConfig >	_watchIntegralConfigs
bool	_isIntraCommDefined = false

Detailed Description

Performs XML configuration of a participant.

Definition at line 24 of file ParticipantConfiguration.hpp.

Constructor & Destructor Documentation

◆ ParticipantConfiguration()

precice::config::ParticipantConfiguration::ParticipantConfiguration	(	xml::XMLTag &	parent,
		mesh::PtrMeshConfiguration	meshConfiguration )

Definition at line 45 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ checkIllDefinedMappings()

void precice::config::ParticipantConfiguration::checkIllDefinedMappings	(	const mapping::MappingConfiguration::ConfiguredMapping &	mapping,
		const impl::PtrParticipant &	participant )

private

Check whether a mapping to the same mesh and with similar data fields already exists.

Definition at line 785 of file ParticipantConfiguration.cpp.

◆ copy()

mesh::PtrMesh precice::config::ParticipantConfiguration::copy ( const mesh::PtrMesh & mesh ) const

private

◆ finishParticipantConfiguration()

void precice::config::ParticipantConfiguration::finishParticipantConfiguration	(	const xml::ConfigurationContext &	context,
		const impl::PtrParticipant &	participant )

private

Definition at line 422 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

◆ getData()

const mesh::PtrData & precice::config::ParticipantConfiguration::getData	(	const mesh::PtrMesh &	mesh,
		const std::string &	nameData ) const

private

Definition at line 411 of file ParticipantConfiguration.cpp.

◆ getGeoFilter()

partition::ReceivedPartition::GeometricFilter precice::config::ParticipantConfiguration::getGeoFilter ( const std::string & geoFilter ) const

private

Definition at line 399 of file ParticipantConfiguration.cpp.

◆ getMapping()

mapping::PtrMapping precice::config::ParticipantConfiguration::getMapping ( const std::string & mappingName )

private

◆ getParticipant()

const impl::PtrParticipant precice::config::ParticipantConfiguration::getParticipant ( std::string_view participantName ) const

Returns a participant with the given name.

Definition at line 365 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

◆ getParticipants()

const std::vector< impl::PtrParticipant > & precice::config::ParticipantConfiguration::getParticipants ( ) const

Returns all configured participants.

Definition at line 360 of file ParticipantConfiguration.cpp.

◆ hasParticipant()

bool precice::config::ParticipantConfiguration::hasParticipant ( std::string_view name ) const

Definition at line 379 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

◆ hintFor()

std::string precice::config::ParticipantConfiguration::hintFor ( std::string_view wrongName ) const

Definition at line 384 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

◆ knownParticipants()

std::set< std::string > precice::config::ParticipantConfiguration::knownParticipants ( ) const

Definition at line 373 of file ParticipantConfiguration.cpp.

◆ nParticipants()

std::size_t precice::config::ParticipantConfiguration::nParticipants ( ) const

Definition at line 354 of file ParticipantConfiguration.cpp.

◆ setExperimental()

void precice::config::ParticipantConfiguration::setExperimental ( bool experimental )

Definition at line 241 of file ParticipantConfiguration.cpp.

◆ setRemeshing()

void precice::config::ParticipantConfiguration::setRemeshing ( bool allowed )

Definition at line 248 of file ParticipantConfiguration.cpp.

◆ xmlEndTagCallback()

void precice::config::ParticipantConfiguration::xmlEndTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback function required for use of automatic configuration.

Returns: True, if successful.

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

Definition at line 345 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::config::ParticipantConfiguration::xmlTagCallback	(	const xml::ConfigurationContext &	context,
		xml::XMLTag &	callingTag )

overridevirtual

Callback function required for use of automatic configuration.

Returns: True, if successful.

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

Definition at line 254 of file ParticipantConfiguration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _actionConfig

action::PtrActionConfiguration precice::config::ParticipantConfiguration::_actionConfig

private

Definition at line 126 of file ParticipantConfiguration.hpp.

◆ _experimental

bool precice::config::ParticipantConfiguration::_experimental = false

private

Definition at line 119 of file ParticipantConfiguration.hpp.

◆ _exportConfig

io::PtrExportConfiguration precice::config::ParticipantConfiguration::_exportConfig

private

Definition at line 128 of file ParticipantConfiguration.hpp.

◆ _isIntraCommDefined

bool precice::config::ParticipantConfiguration::_isIntraCommDefined = false

private

Definition at line 149 of file ParticipantConfiguration.hpp.

◆ _log

logging::Logger precice::config::ParticipantConfiguration::_log {"config::ParticipantConfiguration"}

mutableprivate

Definition at line 78 of file ParticipantConfiguration.hpp.

◆ _mappingConfig

mapping::PtrMappingConfiguration precice::config::ParticipantConfiguration::_mappingConfig

private

Definition at line 124 of file ParticipantConfiguration.hpp.

◆ _meshConfig

mesh::PtrMeshConfiguration precice::config::ParticipantConfiguration::_meshConfig

private

Definition at line 122 of file ParticipantConfiguration.hpp.

◆ _participants

std::vector<impl::PtrParticipant> precice::config::ParticipantConfiguration::_participants

private

Definition at line 130 of file ParticipantConfiguration.hpp.

◆ _remeshing

bool precice::config::ParticipantConfiguration::_remeshing = false

private

Definition at line 120 of file ParticipantConfiguration.hpp.

◆ _watchIntegralConfigs

std::vector<WatchIntegralConfig> precice::config::ParticipantConfiguration::_watchIntegralConfigs

private

Definition at line 134 of file ParticipantConfiguration.hpp.

◆ _watchPointConfigs

std::vector<WatchPointConfig> precice::config::ParticipantConfiguration::_watchPointConfigs

private

Definition at line 132 of file ParticipantConfiguration.hpp.

◆ ATTR_ACTION_TYPE

const std::string precice::config::ParticipantConfiguration::ATTR_ACTION_TYPE = "type"

private

Definition at line 95 of file ParticipantConfiguration.hpp.

◆ ATTR_API_ACCESS

const std::string precice::config::ParticipantConfiguration::ATTR_API_ACCESS = "api-access"

private

Definition at line 100 of file ParticipantConfiguration.hpp.

◆ ATTR_COMMUNICATION

const std::string precice::config::ParticipantConfiguration::ATTR_COMMUNICATION = "communication"

private

Definition at line 104 of file ParticipantConfiguration.hpp.

◆ ATTR_CONTEXT

const std::string precice::config::ParticipantConfiguration::ATTR_CONTEXT = "context"

private

Definition at line 105 of file ParticipantConfiguration.hpp.

◆ ATTR_COORDINATE

const std::string precice::config::ParticipantConfiguration::ATTR_COORDINATE = "coordinate"

private

Definition at line 103 of file ParticipantConfiguration.hpp.

◆ ATTR_DIRECT_ACCESS

const std::string precice::config::ParticipantConfiguration::ATTR_DIRECT_ACCESS = "direct-access"

private

Definition at line 99 of file ParticipantConfiguration.hpp.

◆ ATTR_EXCHANGE_DIRECTORY

const std::string precice::config::ParticipantConfiguration::ATTR_EXCHANGE_DIRECTORY = "exchange-directory"

private

Definition at line 107 of file ParticipantConfiguration.hpp.

◆ ATTR_FROM

const std::string precice::config::ParticipantConfiguration::ATTR_FROM = "from"

private

Definition at line 96 of file ParticipantConfiguration.hpp.

◆ ATTR_GEOMETRIC_FILTER

const std::string precice::config::ParticipantConfiguration::ATTR_GEOMETRIC_FILTER = "geometric-filter"

private

Definition at line 98 of file ParticipantConfiguration.hpp.

◆ ATTR_LOCAL_OFFSET

const std::string precice::config::ParticipantConfiguration::ATTR_LOCAL_OFFSET = "offset"

private

Definition at line 94 of file ParticipantConfiguration.hpp.

◆ ATTR_MESH

const std::string precice::config::ParticipantConfiguration::ATTR_MESH = "mesh"

private

Definition at line 102 of file ParticipantConfiguration.hpp.

◆ ATTR_NAME

const std::string precice::config::ParticipantConfiguration::ATTR_NAME = "name"

private

Definition at line 90 of file ParticipantConfiguration.hpp.

◆ ATTR_NETWORK

const std::string precice::config::ParticipantConfiguration::ATTR_NETWORK = "network"

private

Definition at line 106 of file ParticipantConfiguration.hpp.

◆ ATTR_PROVIDE

const std::string precice::config::ParticipantConfiguration::ATTR_PROVIDE = "provide"

private

Definition at line 101 of file ParticipantConfiguration.hpp.

◆ ATTR_SAFETY_FACTOR

const std::string precice::config::ParticipantConfiguration::ATTR_SAFETY_FACTOR = "safety-factor"

private

Definition at line 97 of file ParticipantConfiguration.hpp.

◆ ATTR_SCALE_WITH_CONN

const std::string precice::config::ParticipantConfiguration::ATTR_SCALE_WITH_CONN = "scale-with-connectivity"

private

Definition at line 108 of file ParticipantConfiguration.hpp.

◆ ATTR_SOURCE_DATA

const std::string precice::config::ParticipantConfiguration::ATTR_SOURCE_DATA = "source-data"

private

Definition at line 91 of file ParticipantConfiguration.hpp.

◆ ATTR_TARGET_DATA

const std::string precice::config::ParticipantConfiguration::ATTR_TARGET_DATA = "target-data"

private

Definition at line 92 of file ParticipantConfiguration.hpp.

◆ ATTR_TIMING

const std::string precice::config::ParticipantConfiguration::ATTR_TIMING = "timing"

private

Definition at line 93 of file ParticipantConfiguration.hpp.

◆ TAG

const std::string precice::config::ParticipantConfiguration::TAG = "participant"

private

Definition at line 80 of file ParticipantConfiguration.hpp.

◆ TAG_DATA_ACTION

const std::string precice::config::ParticipantConfiguration::TAG_DATA_ACTION = "data-action"

private

Definition at line 83 of file ParticipantConfiguration.hpp.

◆ TAG_INTRA_COMM

const std::string precice::config::ParticipantConfiguration::TAG_INTRA_COMM = "intra-comm"

private

Definition at line 88 of file ParticipantConfiguration.hpp.

◆ TAG_PROVIDE_MESH

const std::string precice::config::ParticipantConfiguration::TAG_PROVIDE_MESH = "provide-mesh"

private

Definition at line 84 of file ParticipantConfiguration.hpp.

◆ TAG_READ

const std::string precice::config::ParticipantConfiguration::TAG_READ = "read-data"

private

Definition at line 82 of file ParticipantConfiguration.hpp.

◆ TAG_RECEIVE_MESH

const std::string precice::config::ParticipantConfiguration::TAG_RECEIVE_MESH = "receive-mesh"

private

Definition at line 85 of file ParticipantConfiguration.hpp.

◆ TAG_WATCH_INTEGRAL

const std::string precice::config::ParticipantConfiguration::TAG_WATCH_INTEGRAL = "watch-integral"

private

Definition at line 86 of file ParticipantConfiguration.hpp.

◆ TAG_WATCH_POINT

const std::string precice::config::ParticipantConfiguration::TAG_WATCH_POINT = "watch-point"

private

Definition at line 87 of file ParticipantConfiguration.hpp.

◆ TAG_WRITE

const std::string precice::config::ParticipantConfiguration::TAG_WRITE = "write-data"

private

Definition at line 81 of file ParticipantConfiguration.hpp.

◆ VALUE_CSV

const std::string precice::config::ParticipantConfiguration::VALUE_CSV = "csv"

private

Definition at line 117 of file ParticipantConfiguration.hpp.

◆ VALUE_FILTER_ON_PRIMARY_RANK

const std::string precice::config::ParticipantConfiguration::VALUE_FILTER_ON_PRIMARY_RANK = "on-primary-rank"

private

Definition at line 111 of file ParticipantConfiguration.hpp.

◆ VALUE_FILTER_ON_SECONDARY_RANKS

const std::string precice::config::ParticipantConfiguration::VALUE_FILTER_ON_SECONDARY_RANKS = "on-secondary-ranks"

private

Definition at line 110 of file ParticipantConfiguration.hpp.

◆ VALUE_NO_FILTER

const std::string precice::config::ParticipantConfiguration::VALUE_NO_FILTER = "no-filter"

private

Definition at line 112 of file ParticipantConfiguration.hpp.

◆ VALUE_VTK

const std::string precice::config::ParticipantConfiguration::VALUE_VTK = "vtk"

private

Definition at line 114 of file ParticipantConfiguration.hpp.

◆ VALUE_VTP

const std::string precice::config::ParticipantConfiguration::VALUE_VTP = "vtp"

private

Definition at line 116 of file ParticipantConfiguration.hpp.

◆ VALUE_VTU

const std::string precice::config::ParticipantConfiguration::VALUE_VTU = "vtu"

private

Definition at line 115 of file ParticipantConfiguration.hpp.

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

src/precice/config/ParticipantConfiguration.hpp
src/precice/config/ParticipantConfiguration.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ParticipantConfiguration()

Member Function Documentation

◆ checkIllDefinedMappings()

◆ copy()

◆ finishParticipantConfiguration()

◆ getData()

◆ getGeoFilter()

◆ getMapping()

◆ getParticipant()

◆ getParticipants()

◆ hasParticipant()

◆ hintFor()

◆ knownParticipants()

◆ nParticipants()

◆ setExperimental()

◆ setRemeshing()

◆ xmlEndTagCallback()

◆ xmlTagCallback()

Member Data Documentation

◆ _actionConfig

◆ _experimental

◆ _exportConfig

◆ _isIntraCommDefined

◆ _log

◆ _mappingConfig

◆ _meshConfig

◆ _participants

◆ _remeshing

◆ _watchIntegralConfigs

◆ _watchPointConfigs

◆ ATTR_ACTION_TYPE

◆ ATTR_API_ACCESS

◆ ATTR_COMMUNICATION

◆ ATTR_CONTEXT

◆ ATTR_COORDINATE

◆ ATTR_DIRECT_ACCESS

◆ ATTR_EXCHANGE_DIRECTORY

◆ ATTR_FROM

◆ ATTR_GEOMETRIC_FILTER

◆ ATTR_LOCAL_OFFSET

◆ ATTR_MESH

◆ ATTR_NAME

◆ ATTR_NETWORK

◆ ATTR_PROVIDE

◆ ATTR_SAFETY_FACTOR

◆ ATTR_SCALE_WITH_CONN

◆ ATTR_SOURCE_DATA

◆ ATTR_TARGET_DATA

◆ ATTR_TIMING

◆ TAG

◆ TAG_DATA_ACTION

◆ TAG_INTRA_COMM

◆ TAG_PROVIDE_MESH

◆ TAG_READ

◆ TAG_RECEIVE_MESH

◆ TAG_WATCH_INTEGRAL

◆ TAG_WATCH_POINT

◆ TAG_WRITE

◆ VALUE_CSV

◆ VALUE_FILTER_ON_PRIMARY_RANK

◆ VALUE_FILTER_ON_SECONDARY_RANKS

◆ VALUE_NO_FILTER

◆ VALUE_VTK

◆ VALUE_VTP

◆ VALUE_VTU