preCICE v3.2.0
|
Main class for preCICE XML configuration tree. More...
#include <Configuration.hpp>
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. | |
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 |
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 24 of file Configuration.hpp.
precice::config::Configuration::Configuration | ( | ) |
|
overridedefault |
Destructor, empty.
|
inline |
Returns whether experimental features are allowed or not.
Definition at line 53 of file Configuration.hpp.
|
inline |
Returns whether experimental remeshing is allowed or not.
Definition at line 59 of file Configuration.hpp.
|
inline |
Definition at line 87 of file Configuration.hpp.
|
inline |
Definition at line 70 of file Configuration.hpp.
|
inline |
Definition at line 80 of file Configuration.hpp.
|
inline |
Definition at line 75 of file Configuration.hpp.
const PtrParticipantConfiguration & precice::config::Configuration::getParticipantConfiguration | ( | ) | const |
Definition at line 122 of file Configuration.cpp.
xml::XMLTag & precice::config::Configuration::getXMLTag | ( | ) |
Returns root xml tag to start the automatic configuration process.
Definition at line 61 of file Configuration.cpp.
|
inline |
For manual configuration in test cases.
Definition at line 95 of file Configuration.hpp.
|
inline |
For manual configuration in test cases.
Definition at line 103 of file Configuration.hpp.
|
inline |
For manual configuration in test cases.
Definition at line 111 of file Configuration.hpp.
|
inline |
Returns whether participants wait for each other in finalize.
Definition at line 65 of file Configuration.hpp.
|
overridevirtual |
Callback function required for use of automatic configuration.
Implements precice::xml::XMLTag::Listener.
Definition at line 83 of file Configuration.cpp.
|
overridevirtual |
Callback function required for use of automatic configuration.
Implements precice::xml::XMLTag::Listener.
Definition at line 66 of file Configuration.cpp.
|
private |
Definition at line 145 of file Configuration.hpp.
|
private |
Definition at line 137 of file Configuration.hpp.
|
private |
Allow the use of experimental features.
Definition at line 120 of file Configuration.hpp.
|
private |
Definition at line 117 of file Configuration.hpp.
|
private |
Definition at line 132 of file Configuration.hpp.
|
private |
Definition at line 141 of file Configuration.hpp.
|
private |
Definition at line 139 of file Configuration.hpp.
|
private |
Definition at line 143 of file Configuration.hpp.
|
private |
Definition at line 135 of file Configuration.hpp.
|
private |
Allow the use of experimental remeshing features.
Definition at line 123 of file Configuration.hpp.
|
private |
Definition at line 129 of file Configuration.hpp.
|
private |
Synchronize participants in finalize.
Definition at line 126 of file Configuration.hpp.