MueLu Version of the Day
Loading...
Searching...
No Matches
Static Public Member Functions | Private Member Functions | Static Private Attributes | List of all members
MueLu::MasterList Class Reference

Static class that holds the complete list of valid MueLu parameters. More...

#include <MueLu_MasterList.hpp>

Static Public Member Functions

static Teuchos::RCP< const Teuchos::ParameterList > List ()
 Return a "master" list of all valid parameters and their default values.
 
static Teuchos::RCP< Teuchos::ParameterList > GetProblemSpecificList (std::string const &problemType)
 Return default parameter settings for the specified problem type.
 
template<typename T >
static const T & getDefault (const std::string &name)
 Returns default value on the "master" list for a parameter with the specified name and type.
 
static const Teuchos::ParameterEntry & getEntry (const std::string &name)
 Returns default entry from the "master" list corresponding to the specified name.
 
template<typename T >
static std::string generateXMLParameterString (const std::string &name, T data)
 Create xml string for given MueLu parameter (easy xml input format)
 
static std::string ML2MueLu (const std::string &name)
 Translate ML parameter to corresponding MueLu parameter.
 
static std::string interpretParameterName (const std::string &name, const std::string &value)
 

Private Member Functions

 MasterList ()
 
 MasterList (const MasterList &)
 
MasterList & operator= (const MasterList &)
 

Static Private Attributes

static Teuchos::RCP< Teuchos::ParameterList > masterList_ = Teuchos::null
 A ParameterList that holds all valid parameters and their default values.
 
static const std::string stringList_
 String equivalent of the masterList_.
 
static Teuchos::RCP< Teuchos::ParameterList > problemSpecificList_ = Teuchos::null
 A ParameterList that holds all valid parameters and their default values for a particular problem type.
 
static std::string problemType_ = "unknown"
 The problem type associated with the current problem-specific ParameterList.
 
static std::map< std::string, std::string > DefaultProblemTypeLists_
 Map of string equivalents of the problemSpecificList_. The first entry is the problem type, the second is the string equivalent.
 
static std::map< std::string, std::string > ML2MueLuLists_
 Map of ML parameter strings to corresponding MueLu parametes.
 

Detailed Description

Static class that holds the complete list of valid MueLu parameters.

This class creates a ParameterList that is used to validate user-supplied ParameterLists. This same list is the source of default values if a parameter does not appear in the user ParameterList. This class also provides ParameterLists for certain common problem types, such as 2D and 3D isotropic Poisson.

Todo:
Add method to register user-defined problem type. This will need both string identifier and ParameterList (or string version of parameter list).

Definition at line 37 of file MueLu_MasterList.hpp.

Constructor & Destructor Documentation

◆ MasterList() [1/2]

MueLu::MasterList::MasterList ( )
private

◆ MasterList() [2/2]

MueLu::MasterList::MasterList ( const MasterList &  )
private

Member Function Documentation

◆ List()

Teuchos::RCP< const Teuchos::ParameterList > MueLu::MasterList::List ( )
static

Return a "master" list of all valid parameters and their default values.

Definition at line 18 of file MueLu_MasterList.cpp.

◆ GetProblemSpecificList()

Teuchos::RCP< Teuchos::ParameterList > MueLu::MasterList::GetProblemSpecificList ( std::string const &  problemType)
static

Return default parameter settings for the specified problem type.

Definition at line 26 of file MueLu_MasterList.cpp.

◆ getDefault()

template<typename T >
static const T & MueLu::MasterList::getDefault ( const std::string &  name)
inlinestatic

Returns default value on the "master" list for a parameter with the specified name and type.

Definition at line 46 of file MueLu_MasterList.hpp.

◆ getEntry()

static const Teuchos::ParameterEntry & MueLu::MasterList::getEntry ( const std::string &  name)
inlinestatic

Returns default entry from the "master" list corresponding to the specified name.

Definition at line 51 of file MueLu_MasterList.hpp.

◆ generateXMLParameterString()

template<typename T >
static std::string MueLu::MasterList::generateXMLParameterString ( const std::string &  name,
T  data 
)
inlinestatic

Create xml string for given MueLu parameter (easy xml input format)

Note
: We should check whether template type T is the same as the expected parameter type in the parameter list

Definition at line 59 of file MueLu_MasterList.hpp.

◆ ML2MueLu()

static std::string MueLu::MasterList::ML2MueLu ( const std::string &  name)
inlinestatic

Translate ML parameter to corresponding MueLu parameter.

Definition at line 69 of file MueLu_MasterList.hpp.

◆ interpretParameterName()

std::string MueLu::MasterList::interpretParameterName ( const std::string &  name,
const std::string &  value 
)
static

Definition at line 40 of file MueLu_MasterList.cpp.

◆ operator=()

MasterList & MueLu::MasterList::operator= ( const MasterList &  )
private

Member Data Documentation

◆ masterList_

Teuchos::RCP< Teuchos::ParameterList > MueLu::MasterList::masterList_ = Teuchos::null
staticprivate

A ParameterList that holds all valid parameters and their default values.

Definition at line 86 of file MueLu_MasterList.hpp.

◆ stringList_

const std::string MueLu::MasterList::stringList_
staticprivate

String equivalent of the masterList_.

Definition at line 88 of file MueLu_MasterList.hpp.

◆ problemSpecificList_

Teuchos::RCP< Teuchos::ParameterList > MueLu::MasterList::problemSpecificList_ = Teuchos::null
staticprivate

A ParameterList that holds all valid parameters and their default values for a particular problem type.

Definition at line 90 of file MueLu_MasterList.hpp.

◆ problemType_

std::string MueLu::MasterList::problemType_ = "unknown"
staticprivate

The problem type associated with the current problem-specific ParameterList.

Definition at line 92 of file MueLu_MasterList.hpp.

◆ DefaultProblemTypeLists_

std::map< std::string, std::string > MueLu::MasterList::DefaultProblemTypeLists_
staticprivate

Map of string equivalents of the problemSpecificList_. The first entry is the problem type, the second is the string equivalent.

Definition at line 94 of file MueLu_MasterList.hpp.

◆ ML2MueLuLists_

std::map< std::string, std::string > MueLu::MasterList::ML2MueLuLists_
staticprivate

Map of ML parameter strings to corresponding MueLu parametes.

Definition at line 96 of file MueLu_MasterList.hpp.

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