DOpE::ParameterReader Class Reference

#include <parameterreader.h>

Inheritance diagram for DOpE::ParameterReader:

Public Member Functions
	ParameterReader ()
void	SetSubsection (const std::string subsection)
void	read_parameters (const std::string parameter_file)
void	declare_entry (const std::string &entry, const std::string &default_value, const Patterns::PatternBase &pattern=Patterns::Anything(), const std::string &documentation=std::string())
double	get_double (const std::string &entry_name)
int	get_integer (const std::string &entry_name)
std::string	get_string (const std::string &entry_name)
bool	get_bool (const std::string &entry_name)

Detailed Description

This class is designed to allow all components of the program to use the same parameter file.

Constructor & Destructor Documentation

DOpE::ParameterReader::ParameterReader ( )

inline

Member Function Documentation

void DOpE::ParameterReader::declare_entry ( const std::string &  entry, const std::string &  default_value, const Patterns::PatternBase &  pattern = Patterns::Anything(), const std::string &  documentation = std::string()  )

inline

This is a wrapper to the corresponding dealii::ParameterHandler routine. But the previously subsection is set to the last value set by SetSubsection is used for the declaration.

bool DOpE::ParameterReader::get_bool ( const std::string &  entry_name )

inline

This is a wrapper to the corresponding dealii::ParameterHandler routine. But the previously subsection is set to the last value set by SetSubsection is used for the declaration.

double DOpE::ParameterReader::get_double ( const std::string &  entry_name )

inline

This is a wrapper to the corresponding dealii::ParameterHandler routine. But the previously subsection is set to the last value set by SetSubsection is used for the declaration.

int DOpE::ParameterReader::get_integer ( const std::string &  entry_name )

inline

This is a wrapper to the corresponding dealii::ParameterHandler routine. But the previously subsection is set to the last value set by SetSubsection is used for the declaration.

std::string DOpE::ParameterReader::get_string ( const std::string &  entry_name )

inline

This is a wrapper to the corresponding dealii::ParameterHandler routine. But the previously subsection is set to the last value set by SetSubsection is used for the declaration.

void DOpE::ParameterReader::read_parameters ( const std::string  parameter_file )

inline

This function is called in order to read all previously declared entries from a param file.

Parameters

parameter_file

The name of the parameter file from which the parameters are to be read.

void DOpE::ParameterReader::SetSubsection ( const std::string  subsection )

inline

In order to access a subsetion in a paramfile this Function must be called with The apropriate label for the subsection.

Parameters

subsection

The name of the subsection to be used.

---

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

• /home/wollner/src/DOpE/ThingsForMaintainer/Releases/tmp/dopelib-3.0/DOpEsrc/include/parameterreader.h