preCICE v3.3.0
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
precice::config::Configuration Class Reference

Main class for preCICE XML configuration tree. More...

#include <Configuration.hpp>

Inheritance diagram for precice::config::Configuration:
[legend]
Collaboration diagram for precice::config::Configuration:
[legend]

Public Member Functions

 Configuration ()
 ~Configuration () override=default
 Destructor, empty.
xml::XMLTag & getXMLTag ()
 Returns root xml tag to start the automatic configuration process.
void xmlTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &tag) override
 Callback function required for use of automatic configuration.
void xmlEndTagCallback (const xml::ConfigurationContext &context, xml::XMLTag &tag) override
 Callback function required for use of automatic configuration.
bool allowsExperimental () const
 Returns whether experimental features are allowed or not.
bool allowsRemeshing () const
 Returns whether experimental remeshing is allowed or not.
bool waitInFinalize () const
 Returns whether participants wait for each other in finalize.
const mesh::PtrDataConfiguration getDataConfiguration () const
const mesh::PtrMeshConfiguration getMeshConfiguration () const
const m2n::M2NConfiguration::SharedPointer getM2NConfiguration () const
const PtrParticipantConfiguration & getParticipantConfiguration () const
const cplscheme::PtrCouplingSchemeConfiguration getCouplingSchemeConfiguration () const
void setDataConfiguration (mesh::PtrDataConfiguration config)
 For manual configuration in test cases.
void setMeshConfiguration (mesh::PtrMeshConfiguration config)
 For manual configuration in test cases.
void setParticipantConfiguration (PtrParticipantConfiguration config)
 For manual configuration in test cases.
std::map< std::string, m2n::BoundM2N > getBoundM2NsFor (std::string_view participant) const
void configurePartitionsFor (std::string_view participantName)
Public Member Functions inherited from precice::xml::XMLTag::Listener
Listener & operator= (Listener &&)=delete
virtual ~Listener ()=default

Private Attributes

logging::Logger _log {"config::Configuration"}
bool _experimental = false
 Allow the use of experimental features.
bool _remeshing = false
 Allow the use of experimental remeshing features.
bool _waitInFinalize = false
 Synchronize participants in finalize.
xml::XMLTag _tag
logging::LogConfiguration _logConfig
precice::profiling::ProfilingConfiguration _profilingConfig
mesh::PtrDataConfiguration _dataConfiguration
mesh::PtrMeshConfiguration _meshConfiguration
m2n::M2NConfiguration::SharedPointer _m2nConfiguration
PtrParticipantConfiguration _participantConfiguration
cplscheme::PtrCouplingSchemeConfiguration _couplingSchemeConfiguration

Detailed Description

Main class for preCICE XML configuration tree.

The configuration process is triggered by fetching the root tag with method getXMLTag() and calling its parse() method.

Definition at line 25 of file Configuration.hpp.

Constructor & Destructor Documentation

◆ Configuration()

precice::config::Configuration::Configuration ( )

Definition at line 26 of file Configuration.cpp.

Here is the call graph for this function:

◆ ~Configuration()

precice::config::Configuration::~Configuration ( )
overridedefault

Destructor, empty.

Member Function Documentation

◆ allowsExperimental()

bool precice::config::Configuration::allowsExperimental ( ) const
inline

Returns whether experimental features are allowed or not.

Definition at line 54 of file Configuration.hpp.

◆ allowsRemeshing()

bool precice::config::Configuration::allowsRemeshing ( ) const
inline

Returns whether experimental remeshing is allowed or not.

Definition at line 60 of file Configuration.hpp.

◆ configurePartitionsFor()

void precice::config::Configuration::configurePartitionsFor ( std::string_view participantName)

Definition at line 168 of file Configuration.cpp.

◆ getBoundM2NsFor()

std::map< std::string, m2n::BoundM2N > precice::config::Configuration::getBoundM2NsFor ( std::string_view participant) const

Definition at line 129 of file Configuration.cpp.

Here is the call graph for this function:

◆ getCouplingSchemeConfiguration()

const cplscheme::PtrCouplingSchemeConfiguration precice::config::Configuration::getCouplingSchemeConfiguration ( ) const
inline

Definition at line 88 of file Configuration.hpp.

◆ getDataConfiguration()

const mesh::PtrDataConfiguration precice::config::Configuration::getDataConfiguration ( ) const
inline

Definition at line 71 of file Configuration.hpp.

◆ getM2NConfiguration()

const m2n::M2NConfiguration::SharedPointer precice::config::Configuration::getM2NConfiguration ( ) const
inline

Definition at line 81 of file Configuration.hpp.

◆ getMeshConfiguration()

const mesh::PtrMeshConfiguration precice::config::Configuration::getMeshConfiguration ( ) const
inline

Definition at line 76 of file Configuration.hpp.

◆ getParticipantConfiguration()

const PtrParticipantConfiguration & precice::config::Configuration::getParticipantConfiguration ( ) const

Definition at line 124 of file Configuration.cpp.

◆ getXMLTag()

xml::XMLTag & precice::config::Configuration::getXMLTag ( )

Returns root xml tag to start the automatic configuration process.

Definition at line 63 of file Configuration.cpp.

◆ setDataConfiguration()

void precice::config::Configuration::setDataConfiguration ( mesh::PtrDataConfiguration config)
inline

For manual configuration in test cases.

Definition at line 96 of file Configuration.hpp.

◆ setMeshConfiguration()

void precice::config::Configuration::setMeshConfiguration ( mesh::PtrMeshConfiguration config)
inline

For manual configuration in test cases.

Definition at line 104 of file Configuration.hpp.

◆ setParticipantConfiguration()

void precice::config::Configuration::setParticipantConfiguration ( PtrParticipantConfiguration config)
inline

For manual configuration in test cases.

Definition at line 112 of file Configuration.hpp.

◆ waitInFinalize()

bool precice::config::Configuration::waitInFinalize ( ) const
inline

Returns whether participants wait for each other in finalize.

Definition at line 66 of file Configuration.hpp.

◆ xmlEndTagCallback()

void precice::config::Configuration::xmlEndTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & tag )
overridevirtual

Callback function required for use of automatic configuration.

Returns
True, if successful.

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

Definition at line 85 of file Configuration.cpp.

Here is the call graph for this function:

◆ xmlTagCallback()

void precice::config::Configuration::xmlTagCallback ( const xml::ConfigurationContext & context,
xml::XMLTag & tag )
overridevirtual

Callback function required for use of automatic configuration.

Returns
True, if successful.

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

Definition at line 68 of file Configuration.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _couplingSchemeConfiguration

cplscheme::PtrCouplingSchemeConfiguration precice::config::Configuration::_couplingSchemeConfiguration
private

Definition at line 150 of file Configuration.hpp.

◆ _dataConfiguration

mesh::PtrDataConfiguration precice::config::Configuration::_dataConfiguration
private

Definition at line 142 of file Configuration.hpp.

◆ _experimental

bool precice::config::Configuration::_experimental = false
private

Allow the use of experimental features.

Definition at line 125 of file Configuration.hpp.

◆ _log

logging::Logger precice::config::Configuration::_log {"config::Configuration"}
private

Definition at line 122 of file Configuration.hpp.

◆ _logConfig

logging::LogConfiguration precice::config::Configuration::_logConfig
private

Definition at line 137 of file Configuration.hpp.

◆ _m2nConfiguration

m2n::M2NConfiguration::SharedPointer precice::config::Configuration::_m2nConfiguration
private

Definition at line 146 of file Configuration.hpp.

◆ _meshConfiguration

mesh::PtrMeshConfiguration precice::config::Configuration::_meshConfiguration
private

Definition at line 144 of file Configuration.hpp.

◆ _participantConfiguration

PtrParticipantConfiguration precice::config::Configuration::_participantConfiguration
private

Definition at line 148 of file Configuration.hpp.

◆ _profilingConfig

precice::profiling::ProfilingConfiguration precice::config::Configuration::_profilingConfig
private

Definition at line 140 of file Configuration.hpp.

◆ _remeshing

bool precice::config::Configuration::_remeshing = false
private

Allow the use of experimental remeshing features.

Definition at line 128 of file Configuration.hpp.

◆ _tag

xml::XMLTag precice::config::Configuration::_tag
private

Definition at line 134 of file Configuration.hpp.

◆ _waitInFinalize

bool precice::config::Configuration::_waitInFinalize = false
private

Synchronize participants in finalize.

Definition at line 131 of file Configuration.hpp.

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