Xpetra Version of the Day
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
Xpetra::ReorderedBlockedCrsMatrix::Xpetra::ParameterList Class Reference

Classes

class  PrintOptions
 

Public Types

enum  EValidateUsed
 
enum  EValidateDefaults
 
typedef params_t::ConstIterator ConstIterator
 
typedef params_t::ConstIterator ConstIterator
 

Public Member Functions

 ParameterList ()=default
 
 ParameterList (const std::string &name, RCP< const ParameterListModifier > const &modifier=null)
 
 ParameterList (const ParameterList &source)
 
 ParameterList ()=default
 
 ParameterList (const std::string &name, RCP< const ParameterListModifier > const &modifier=null)
 
 ParameterList (const ParameterList &source)
 
virtual ~ParameterList ()
 
virtual ~ParameterList ()
 
ParameterList & setName (const std::string &name)
 
ParameterList & setName (const std::string &name)
 
ParameterList & operator= (const ParameterList &source)
 
ParameterList & operator= (const ParameterList &source)
 
ParameterList & setParameters (const ParameterList &source)
 
ParameterList & setParameters (const ParameterList &source)
 
ParameterList & setParametersNotAlreadySet (const ParameterList &source)
 
ParameterList & setParametersNotAlreadySet (const ParameterList &source)
 
ParameterList & disableRecursiveValidation ()
 
ParameterList & disableRecursiveValidation ()
 
ParameterList & disableRecursiveModification ()
 
ParameterList & disableRecursiveModification ()
 
ParameterList & disableRecursiveReconciliation ()
 
ParameterList & disableRecursiveReconciliation ()
 
ParameterList & disableRecursiveAll ()
 
ParameterList & disableRecursiveAll ()
 
ParameterList & set (std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, char value[], std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, const char value[], std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, ParameterList const &value, std::string const &docString="")
 
ParameterList & set (std::string const &name, T const &value, std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, char value[], std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, const char value[], std::string const &docString="", RCP< const ParameterEntryValidator > const &validator=null)
 
ParameterList & set (std::string const &name, ParameterList const &value, std::string const &docString="")
 
ParameterList & setEntry (const std::string &name, const ParameterEntry &entry)
 
ParameterList & setEntry (const std::string &name, const ParameterEntry &entry)
 
void recursivelySetValidator (RCP< const ParameterEntryValidator > const &validator, int const depth=1000)
 
void recursivelySetValidator (RCP< const ParameterEntryValidator > const &validator, int const depth=1000)
 
T & get (const std::string &name, T def_value)
 
std::string & get (const std::string &name, char def_value[])
 
std::string & get (const std::string &name, const char def_value[])
 
T & get (const std::string &name)
 
const T & get (const std::string &name) const
 
T & get (ParameterList &l, const std::string &name)
 
T & get (const std::string &name, T def_value)
 
std::string & get (const std::string &name, char def_value[])
 
std::string & get (const std::string &name, const char def_value[])
 
T & get (const std::string &name)
 
const T & get (const std::string &name) const
 
T * getPtr (const std::string &name)
 
const T * getPtr (const std::string &name) const
 
T * getPtr (const std::string &name)
 
const T * getPtr (const std::string &name) const
 
ParameterEntry & getEntry (const std::string &name)
 
const ParameterEntry & getEntry (const std::string &name) const
 
ParameterEntry & getEntry (const std::string &name)
 
const ParameterEntry & getEntry (const std::string &name) const
 
ParameterEntry * getEntryPtr (const std::string &name)
 
const ParameterEntry * getEntryPtr (const std::string &name) const
 
ParameterEntry * getEntryPtr (const std::string &name)
 
const ParameterEntry * getEntryPtr (const std::string &name) const
 
RCP< ParameterEntry > getEntryRCP (const std::string &name)
 
RCP< const ParameterEntry > getEntryRCP (const std::string &name) const
 
RCP< ParameterEntry > getEntryRCP (const std::string &name)
 
RCP< const ParameterEntry > getEntryRCP (const std::string &name) const
 
RCP< const ParameterListModifier > getModifier () const
 
RCP< const ParameterListModifier > getModifier () const
 
bool remove (std::string const &name, bool throwIfNotExists=true)
 
bool remove (std::string const &name, bool throwIfNotExists=true)
 
ParameterList & sublist (const std::string &name, bool mustAlreadyExist=false, const std::string &docString="")
 
ParameterList & sublist (const std::string &name, RCP< const ParameterListModifier > const &modifier, const std::string &docString="")
 
const ParameterList & sublist (const std::string &name) const
 
RCP< ParameterList > sublist (const RCP< ParameterList > &paramList, const std::string &name, bool mustAlreadyExist=false, const std::string &docString="")
 
RCP< const ParameterList > sublist (const RCP< const ParameterList > &paramList, const std::string &name)
 
ParameterList & sublist (const std::string &name, bool mustAlreadyExist=false, const std::string &docString="")
 
ParameterList & sublist (const std::string &name, RCP< const ParameterListModifier > const &modifier, const std::string &docString="")
 
const ParameterList & sublist (const std::string &name) const
 
const std::string & name () const
 
const std::string & name (ConstIterator i) const
 
const std::string & name () const
 
const std::string & name (ConstIterator i) const
 
bool isParameter (const std::string &name) const
 
bool isParameter (const std::string &name) const
 
bool isSublist (const std::string &name) const
 
bool isSublist (const std::string &name) const
 
bool isType (const std::string &name) const
 
bool isType (const std::string &name) const
 
Ordinal numParams () const
 
Ordinal numParams () const
 
void print () const
 
std::ostream & print (std::ostream &os, const PrintOptions &printOptions) const
 
std::ostream & print (std::ostream &os, int indent=0, bool showTypes=false, bool showFlags=true, bool showDefault=true) const
 
void print () const
 
std::ostream & print (std::ostream &os, const PrintOptions &printOptions) const
 
std::ostream & print (std::ostream &os, int indent=0, bool showTypes=false, bool showFlags=true, bool showDefault=true) const
 
void unused (std::ostream &os) const
 
void unused (std::ostream &os) const
 
std::string currentParametersString () const
 
std::string currentParametersString () const
 
ConstIterator begin () const
 
ConstIterator begin () const
 
ConstIterator end () const
 
ConstIterator end () const
 
const ParameterEntry & entry (ConstIterator i) const
 
const ParameterEntry & entry (ConstIterator i) const
 
RCP< ParameterList > parameterList ()
 
RCP< ParameterList > parameterList (const std::string &name)
 
RCP< ParameterList > parameterList (const ParameterList &source)
 
RCP< ParameterList > createParameterList ()
 
RCP< ParameterList > createParameterList (const std::string &name)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT bool operator== (const ParameterList &list1, const ParameterList &list2)
 
bool operator!= (const ParameterList &list1, const ParameterList &list2)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT bool haveSameModifiers (const ParameterList &list1, const ParameterList &list2)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT bool haveSameValues (const ParameterList &list1, const ParameterList &list2, bool verbose=false)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT bool haveSameValuesSorted (const ParameterList &list1, const ParameterList &list2, bool verbose=false)
 
T & getParameter (ParameterList &l, const std::string &name)
 
const T & getParameter (const ParameterList &l, const std::string &name)
 
T * getParameterPtr (ParameterList &l, const std::string &name)
 
const T * getParameterPtr (const ParameterList &l, const std::string &name)
 
bool isParameterType (ParameterList &l, const std::string &name)
 
bool isParameterType (const ParameterList &l, const std::string &name)
 
void setStringParameterFromArray (const std::string &paramName, const Array< T > &array, ParameterList *paramList)
 
Array< T > getArrayFromStringParameter (const ParameterList &paramList, const std::string &paramName, const int arrayDim=-1, const bool mustExist=true)
 
bool replaceParameterWithArray (const std::string &paramName, const std::string &newName, ParameterList &pl)
 
std::ostream & operator<< (std::ostream &os, const ParameterList &l)
 
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, ArrayView< const std::string > const &strings, ParameterList *paramList)
 
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, ArrayView< const std::string > const &strings, ArrayView< const IntegralType > const &integralValues, ParameterList *paramList)
 
void setStringToIntegralParameter (std::string const &paramName, std::string const &defaultValue, std::string const &docString, ArrayView< const std::string > const &strings, ArrayView< const std::string > const &stringsDocs, ArrayView< const IntegralType > const &integralValues, ParameterList *paramList)
 
IntegralType getIntegralValue (ParameterList const &paramList, std::string const &paramName)
 
std::string getStringValue (ParameterList const &paramList, std::string const &paramName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setIntParameter (std::string const &paramName, int const value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes=AnyNumberParameterEntryValidator::AcceptedTypes())
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setLongLongParameter (std::string const &paramName, long long const value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes=AnyNumberParameterEntryValidator::AcceptedTypes())
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setDoubleParameter (std::string const &paramName, double const &value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes=AnyNumberParameterEntryValidator::AcceptedTypes())
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setNumericStringParameter (std::string const &paramName, std::string const &value, std::string const &docString, ParameterList *paramList, AnyNumberParameterEntryValidator::AcceptedTypes const &acceptedTypes=AnyNumberParameterEntryValidator::AcceptedTypes())
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT int getIntParameter (ParameterList const &paramList, std::string const &paramName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT long long getLongLongParameter (ParameterList const &paramList, std::string const &paramName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT double getDoubleParameter (ParameterList const &paramList, std::string const &paramName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT std::string getNumericStringParameter (ParameterList const &paramList, std::string const &paramName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlFile (const std::string &xmlFileName, const Ptr< ParameterList > &paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlFile (const std::string &xmlFileName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlFile (const std::string &xmlFileName, RCP< DependencySheet > depSheet)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromXmlString (const std::string &xmlStr, const Ptr< ParameterList > &paramList, bool overwrite=true)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlString (const std::string &xmlStr)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromXmlString (const std::string &xmlStr, RCP< DependencySheet > depSheet)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToXmlOStream (const ParameterList &paramList, std::ostream &xmlOut, RCP< const DependencySheet > depSheet=null)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToXmlFile (const ParameterList &paramList, const std::string &xmlFileName, RCP< const DependencySheet > depSheet=null)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromYamlFile (const std::string &yamlFileName, const Ptr< ParameterList > &paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromYamlFile (const std::string &yamlFileName)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void updateParametersFromYamlString (const std::string &yamlStr, const Ptr< ParameterList > &paramList, bool overwrite, const std::string &name="")
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< ParameterList > getParametersFromYamlString (const std::string &yamlStr)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToYamlOStream (const ParameterList &paramList, std::ostream &yamlOut)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void writeParameterListToYamlFile (const ParameterList &paramList, const std::string &yamlFileName)
 
TEUCHOSCOMM_LIB_DLL_EXPORT void updateParametersAndBroadcast (const Ptr< ParameterList > &inParamList, const Ptr< ParameterList > &ParamList, const Comm< int > &comm, int root, bool overwrite=true)
 
TEUCHOSCOMM_LIB_DLL_EXPORT void updateParametersFromXmlFileAndBroadcast (const std::string &xmlFileName, const Ptr< ParameterList > &paramList, const Comm< int > &comm, bool overwrite=true)
 
TEUCHOSCOMM_LIB_DLL_EXPORT void updateParametersFromYamlFileAndBroadcast (const std::string &yamlFileName, const Teuchos::Ptr< Teuchos::ParameterList > &paramList, const Teuchos::Comm< int > &comm, bool overwrite=true)
 
void validateParameters (ParameterList const &validParamList, int const depth=1000, EValidateUsed const validateUsed=VALIDATE_USED_ENABLED, EValidateDefaults const validateDefaults=VALIDATE_DEFAULTS_ENABLED) const
 
void validateParametersAndSetDefaults (ParameterList const &validParamList, int const depth=1000)
 
void modifyParameterList (ParameterList &validParamList, int const depth=1000)
 
void reconcileParameterList (ParameterList &validParamList, const bool left_to_right=true)
 
The documentation for this class was generated from the following files: