tarch::configuration::Configuration Class Reference

#include <Configuration.h>

Inheritance diagram for tarch::configuration::Configuration:

Public Member Functions
virtual	~Configuration ()
virtual void	parseSubtag (tinyxml2::XMLElement *node)=0
virtual std::string	getTag () const =0
virtual bool	isValid () const =0

Detailed Description

interface for configuration using tinyxml2.

Author

Philipp Neumann

Constructor & Destructor Documentation

~Configuration()

virtual tarch::configuration::Configuration::~Configuration ( )

inlinevirtual

Destructor

Member Function Documentation

getTag()

virtual std::string tarch::configuration::Configuration::getTag ( ) const

pure virtual

Returns

the name of the current xml-element

Implemented in coupling::configurations::BoundaryForceConfiguration< dim >, coupling::configurations::CouplingCellConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< 3 >, coupling::configurations::MomentumInsertionConfiguration, coupling::configurations::ParallelTopologyConfiguration, coupling::configurations::ParticleInsertionConfiguration, coupling::configurations::ThermostatConfiguration, coupling::configurations::TimeIntegrationConfiguration, and coupling::configurations::TransferStrategyConfiguration< dim >.

isValid()

virtual bool tarch::configuration::Configuration::isValid ( ) const

pure virtual

Returns

true if the configuration is valid; false otherwise. This method is basically for debugging purposes and detection of invalid input.

Implemented in coupling::configurations::BoundaryForceConfiguration< dim >, coupling::configurations::CouplingCellConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< 3 >, coupling::configurations::MomentumInsertionConfiguration, coupling::configurations::ParallelTopologyConfiguration, coupling::configurations::ParticleInsertionConfiguration, coupling::configurations::ThermostatConfiguration, coupling::configurations::TimeIntegrationConfiguration, and coupling::configurations::TransferStrategyConfiguration< dim >.

parseSubtag()

virtual void tarch::configuration::Configuration::parseSubtag ( tinyxml2::XMLElement * node )

pure virtual

Parses a XML-element.

Parameters

node	a pointer to the xml-element from tinyxml2 class

Implemented in coupling::configurations::BoundaryForceConfiguration< dim >, coupling::configurations::CouplingCellConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< dim >, coupling::configurations::MaMiCoConfiguration< 3 >, coupling::configurations::MomentumInsertionConfiguration, coupling::configurations::ParallelTopologyConfiguration, coupling::configurations::ParticleInsertionConfiguration, coupling::configurations::ThermostatConfiguration, coupling::configurations::TimeIntegrationConfiguration, and coupling::configurations::TransferStrategyConfiguration< dim >.

---

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

• tarch/configuration/Configuration.h