olb::parameters::Reader< PARAMETERS, TAG > Struct Template Reference

Base struct for reading parameters from files. More...

#include <solverParameters.h>

Inheritance diagram for olb::parameters::Reader< PARAMETERS, TAG >:

Collaboration diagram for olb::parameters::Reader< PARAMETERS, TAG >:

Public Member Functions
	Reader (std::shared_ptr< PARAMETERS > params_)
virtual void	read (XMLreader const &xml)
Public Member Functions inherited from olb::parameters::ReaderBase< PARAMETERS >
	ReaderBase (std::shared_ptr< PARAMETERS > params_)

Additional Inherited Members
Public Attributes inherited from olb::parameters::ReaderBase< PARAMETERS >
OstreamManager	clout {std::cout, "ParameterReader"}
std::shared_ptr< PARAMETERS >	params

Detailed Description

template<typename PARAMETERS, typename TAG>
struct olb::parameters::Reader< PARAMETERS, TAG >

Base struct for reading parameters from files.

So far, reading from xml is supported. If you want to let your own parameter struct read from xml, you may realize this as template specializations, similar to the syntax in the examples below. The default (with no specialization) does nothing. If you want to add your own interface, you may add read(...)-methods to the given structures which read the parameters from your file type.

Definition at line 238 of file solverParameters.h.

Constructor & Destructor Documentation

Reader()

template<typename PARAMETERS , typename TAG >

olb::parameters::Reader< PARAMETERS, TAG >::Reader ( std::shared_ptr< PARAMETERS > params_ )

inline

Definition at line 239 of file solverParameters.h.

                                            : Reader::ReaderBase(params_)
  { }

Member Function Documentation

read()

template<typename PARAMETERS , typename TAG >

virtual void olb::parameters::Reader< PARAMETERS, TAG >::read ( XMLreader const & xml )

inlinevirtual

Definition at line 242 of file solverParameters.h.

{ }

Here is the caller graph for this function:

---

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

• src/solver/solverParameters.h