MueLu  Version of the Day
MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <MueLu_Facade_Simple_decl.hpp>

Inheritance diagram for MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >:
MueLu::FacadeClassBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > MueLu::BaseClass MueLu::VerboseObject MueLu::Describable Teuchos::VerboseObject< VerboseObject > Teuchos::Describable Teuchos::VerboseObjectBase Teuchos::LabeledObject

Public Member Functions

Teuchos::RCP< Teuchos::ParameterListSetParameterList (const Teuchos::ParameterList &paramList)
 Set parameter list for FacadeClass interpreter. More...
 
- Public Member Functions inherited from MueLu::FacadeClassBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
 FacadeClassBase ()
 Constructor. More...
 
virtual ~FacadeClassBase ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::BaseClass
virtual ~BaseClass ()
 Destructor. More...
 
- Public Member Functions inherited from MueLu::VerboseObject
VerbLevel GetVerbLevel () const
 Get the verbosity level. More...
 
void SetVerbLevel (const VerbLevel verbLevel)
 Set the verbosity level of this object. More...
 
int GetProcRankVerbose () const
 Get proc rank used for printing. Do not use this information for any other purpose. More...
 
int SetProcRankVerbose (int procRank) const
 Set proc rank used for printing. More...
 
bool IsPrint (MsgType type, int thisProcRankOnly=-1) const
 Find out whether we need to print out information for a specific message type. More...
 
Teuchos::FancyOStreamGetOStream (MsgType type, int thisProcRankOnly=0) const
 Get an output stream for outputting the input message type. More...
 
Teuchos::FancyOStreamGetBlackHole () const
 
 VerboseObject ()
 
virtual ~VerboseObject ()
 Destructor. More...
 
- Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
 VerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual const VerboseObjectsetOverridingVerbLevel (const EVerbosityLevel verbLevel) const
 
virtual EVerbosityLevel getVerbLevel () const
 
virtual EVerbosityLevel getVerbLevel () const
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterListgetValidVerboseObjectSublist ()
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void setupVerboseObjectSublist (ParameterList *paramList)
 
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT void readVerboseObjectSublist (ParameterList *paramList, RCP< FancyOStream > *oStream, EVerbosityLevel *verbLevel)
 
void readVerboseObjectSublist (ParameterList *paramList, VerboseObject< ObjectType > *verboseObject)
 
- Public Member Functions inherited from Teuchos::VerboseObjectBase
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
virtual ~VerboseObjectBase ()
 
 VerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual const VerboseObjectBasesetOStream (const RCP< FancyOStream > &oStream) const
 
virtual const VerboseObjectBasesetOverridingOStream (const RCP< FancyOStream > &oStream) const
 
virtual VerboseObjectBasesetLinePrefix (const std::string &linePrefix)
 
virtual RCP< FancyOStreamgetOStream () const
 
virtual RCP< FancyOStreamgetOverridingOStream () const
 
virtual std::string getLinePrefix () const
 
virtual OSTab getOSTab (const int tabs=1, const std::string &linePrefix="") const
 
- Public Member Functions inherited from MueLu::Describable
virtual ~Describable ()
 Destructor. More...
 
virtual std::string ShortClassName () const
 Return the class name of the object, without template parameters and without namespace. More...
 
virtual void describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const
 
virtual std::string description () const
 Return a simple one-line description of this object. More...
 
void describe (Teuchos::FancyOStream &out, const Teuchos::EVerbosityLevel verbLevel=Teuchos::Describable::verbLevel_default) const
 Print the object with some verbosity level to an FancyOStream object. More...
 
- Public Member Functions inherited from Teuchos::Describable
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 

Static Private Attributes

static const std::string stringTemplate_
 String equivalent of preconditioner layout. More...
 
static const std::string defaultParams_
 @ brief String defining default parameter list for facade input More...
 

Constructors/Destructors

 FacadeSimple ()
 Constructor. More...
 
virtual ~FacadeSimple ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from MueLu::VerboseObject
static void SetDefaultOStream (const Teuchos::RCP< Teuchos::FancyOStream > &defaultOStream)
 
static Teuchos::RCP< Teuchos::FancyOStreamGetDefaultOStream ()
 
static void SetDefaultVerbLevel (const VerbLevel defaultVerbLevel)
 Set the default (global) verbosity level. More...
 
static VerbLevel GetDefaultVerbLevel ()
 Get the default (global) verbosity level. More...
 
- Static Public Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static void setDefaultVerbLevel (const EVerbosityLevel defaultVerbLevel)
 
static EVerbosityLevel getDefaultVerbLevel ()
 
static EVerbosityLevel getDefaultVerbLevel ()
 
- Static Public Member Functions inherited from Teuchos::VerboseObjectBase
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
static void setDefaultOStream (const RCP< FancyOStream > &defaultOStream)
 
static RCP< FancyOStreamgetDefaultOStream ()
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 
- Protected Member Functions inherited from MueLu::FacadeClassBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >
std::string ReplaceString (std::string &subject, const std::string &search, const std::string &replace)
 Replace all occurrences of search string "search" by the string in "replace" given the string "subject". More...
 
- Protected Member Functions inherited from Teuchos::VerboseObject< VerboseObject >
void initializeVerboseObject (const EVerbosityLevel verbLevel=VERB_DEFAULT, const RCP< FancyOStream > &oStream=Teuchos::null)
 
- Protected Member Functions inherited from Teuchos::VerboseObjectBase
void initializeVerboseObjectBase (const RCP< FancyOStream > &oStream=Teuchos::null)
 
virtual void informUpdatedVerbosityState () const
 

Detailed Description

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 59 of file MueLu_Facade_Simple_decl.hpp.

Constructor & Destructor Documentation

◆ FacadeSimple()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >::FacadeSimple ( )

Constructor.

Definition at line 61 of file MueLu_Facade_Simple_def.hpp.

◆ ~FacadeSimple()

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
virtual MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >::~FacadeSimple ( )
inlinevirtual

Destructor.

Definition at line 70 of file MueLu_Facade_Simple_decl.hpp.

Member Function Documentation

◆ SetParameterList()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Teuchos::RCP< Teuchos::ParameterList > MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >::SetParameterList ( const Teuchos::ParameterList paramList)
virtual

Set parameter list for FacadeClass interpreter.

Parameters
[in]paramListParameterList containing the MueLu parameters for chosen facade class.

Implements MueLu::FacadeClassBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.

Definition at line 66 of file MueLu_Facade_Simple_def.hpp.

Member Data Documentation

◆ stringTemplate_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
const std::string MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >::stringTemplate_
staticprivate

String equivalent of preconditioner layout.

Definition at line 82 of file MueLu_Facade_Simple_decl.hpp.

◆ defaultParams_

template<class Scalar = double, class LocalOrdinal = int, class GlobalOrdinal = LocalOrdinal, class Node = KokkosClassic::DefaultNode::DefaultNodeType>
const std::string MueLu::FacadeSimple< Scalar, LocalOrdinal, GlobalOrdinal, Node >::defaultParams_
staticprivate
Initial value:
=
"<ParameterList name=\"Input\">"
"<Parameter name=\"MueLu preconditioner\" type=\"string\" value=\"undefined\"/>"
"<Parameter name=\"Block 1: dofs per node\" type=\"int\" value=\"1\"/>"
"<Parameter name=\"Block 2: dofs per node\" type=\"int\" value=\"1\"/>"
"<Parameter name=\"Block 1: smoother\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
"<Parameter name=\"Block 1: level-of-fill\" type=\"int\" value=\"0\"/>"
"<Parameter name=\"Block 1: relaxation: sweeps\" type=\"int\" value=\"1\"/>"
"<Parameter name=\"Block 1: relaxation: damping factor\" type=\"double\" value=\"1.0\"/>"
"<Parameter name=\"Block 1: transfer smoothing\" type=\"bool\" value=\"true\"/>"
"<Parameter name=\"Block 2: smoother\" type=\"string\" value=\"Symmetric Gauss-Seidel\"/>"
"<Parameter name=\"Block 2: level-of-fill\" type=\"int\" value=\"0\"/>"
"<Parameter name=\"Block 2: relaxation: sweeps\" type=\"int\" value=\"1\"/>"
"<Parameter name=\"Block 2: relaxation: damping factor\" type=\"double\" value=\"1.0\"/>"
"<Parameter name=\"Block 2: transfer smoothing\" type=\"bool\" value=\"true\"/>"
"<Parameter name=\"Simple: damping factor\" type=\"double\" value=\"1.0\"/>"
"<Parameter name=\"max levels\" type=\"int\" value=\"5\"/>"
"<Parameter name=\"coarse: max size\" type=\"int\" value=\"25000\"/>"
"<Parameter name=\"verbosity\" type=\"string\" value=\"High\"/>"
"</ParameterList>"

@ brief String defining default parameter list for facade input

Definition at line 85 of file MueLu_Facade_Simple_decl.hpp.


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