FEDD::IO::ParameterList Class Reference

A wrapper of Teuchos::ParameterList from Trilinos that automatically includes additional parameter lists stored in files. More...

#include <IO_ParameterList_decl.hpp>

Public Member Functions
	ParameterList (const std::string &name, const std::string &fileName, const std::string &fileType="yaml")
	Read FEDD::IO::ParameterList from yaml or xml input file.
	ParameterList (const std::string &name, ParameterListPtr_Type &parameterList)
	Construct FEDD::IO::ParameterList from Teuchos::ParameterList.
std::ostream &	print (std::ostream &os, int indent=0, bool showTypes=false, bool showFlags=true, bool showDefault=true)
	Print parameter list.
ParameterListPtr_Type	operator() ()
	Access to the underlying Teuchos::ParamterList.

Protected Types
using	ParameterList_Type = Teuchos::ParameterList
using	ParameterListPtr_Type = Teuchos::RCP<ParameterList_Type>

Protected Attributes
const std::string	name_
	Name of the parameter list.
ParameterListPtr_Type	parameterList_
	Teuchos::RCP of the underlying Teuchos::ParameterList.

Detailed Description

A wrapper of Teuchos::ParameterList from Trilinos that automatically includes additional parameter lists stored in files.

This class is a leightweight interface to Teuchos::ParameterList from Trilinos. The main property is that parameters "ParameterLists File Names", "ParameterLists File Paths", and "ParameterLists File Types" may be specified in the parameter list. At construction time, those files are read and the corresponding parameter lists are included into the list itself.

Constructor & Destructor Documentation

ParameterList() [1/2]

FEDD::IO::ParameterList::ParameterList ( const std::string & name, const std::string & fileName, const std::string & fileType = "yaml" )

inline

Read FEDD::IO::ParameterList from yaml or xml input file.

Parameters

name	Name of the parameter list
fileName	File name
fileType	File type ("yaml" or "xml")

ParameterList() [2/2]

FEDD::IO::ParameterList::ParameterList ( const std::string & name, ParameterListPtr_Type & parameterList )

inline

Construct FEDD::IO::ParameterList from Teuchos::ParameterList.

Parameters

name	Name of the parameter list
parameterList	Teuchos::RCP of the underlying Teuchos::ParameterList

---

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

• feddlib/core/IO/IO_ParameterList_decl.hpp