MueLu Version of the Day
|
Class that encapsulates Belos smoothers. More...
#include <MueLu_BelosSmoother_decl.hpp>
Overridden from Teuchos::Describable | |
typedef Tpetra::MultiVector< SC, LO, GO, NO > | tMV |
typedef Tpetra::Operator< SC, LO, GO, NO > | tOP |
std::string | type_ |
RCP< Belos::LinearProblem< Scalar, tMV, tOP > > | tBelosProblem_ |
RCP< Belos::SolverManager< Scalar, tMV, tOP > > | tSolver_ |
RCP< Matrix > | A_ |
matrix, used in apply if solving residual equation | |
std::string | description () const |
Return a simple one-line description of this object. | |
void | print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const |
Print the object with some verbosity level to an FancyOStream object. | |
size_t | getNodeSmootherComplexity () const |
For diagnostic purposes. | |
void | SetupBelos (Level ¤tLevel) |
Constructors / destructors | |
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 > | |
class | BelosSmoother |
Constructor. | |
BelosSmoother (const std::string type, const Teuchos::ParameterList ¶mList=Teuchos::ParameterList()) | |
virtual | ~BelosSmoother ()=default |
Destructor. | |
void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. | |
void | DeclareInput (Level ¤tLevel) const |
Input. | |
Computational methods. | |
void | Setup (Level ¤tLevel) |
Set up the smoother. | |
void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the preconditioner. | |
Utilities | |
RCP< SmootherPrototype > | Copy () const |
Additional Inherited Members | |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
![]() | |
SmootherPrototype () | |
@nameConstructors/Destructors. | |
virtual | ~SmootherPrototype () |
virtual void | DeclareInput (Level ¤tLevel) const =0 |
Input. | |
virtual void | CallBuild (Level &) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
bool | IsSetup () const |
Get the state of a smoother prototype. | |
void | IsSetup (bool const &ToF) |
Set the state of a smoother prototype. | |
![]() | |
SmootherBase () | |
virtual | ~SmootherBase () |
void | declareConstructionOutcome (bool fail, std::string msg) |
bool | constructionSuccessful () |
std::string | constructionErrorMsg () |
![]() | |
virtual | ~BaseClass () |
Destructor. | |
![]() | |
VerboseObject () | |
virtual | ~VerboseObject () |
Destructor. | |
VerbLevel | GetVerbLevel () const |
Get the verbosity level. | |
void | SetVerbLevel (const VerbLevel verbLevel) |
Set the verbosity level of this object. | |
int | GetProcRankVerbose () const |
Get proc rank used for printing. Do not use this information for any other purpose. | |
int | SetProcRankVerbose (int procRank) const |
Set proc rank used for printing. | |
bool | IsPrint (MsgType type, int thisProcRankOnly=-1) const |
Find out whether we need to print out information for a specific message type. | |
Teuchos::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. | |
Teuchos::FancyOStream & | GetBlackHole () const |
![]() | |
virtual | ~Describable () |
Destructor. | |
virtual void | describe (Teuchos::FancyOStream &out_arg, const VerbLevel verbLevel=Default) const |
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. | |
virtual std::string | ShortClassName () const |
Return the class name of the object, without template parameters and without namespace. | |
![]() | |
Factory () | |
Constructor. | |
virtual | ~Factory () |
Destructor. | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() | |
RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. | |
void | EnableMultipleCallCheck () const |
void | DisableMultipleCallCheck () const |
void | ResetDebugData () const |
![]() | |
FactoryBase () | |
Constructor. | |
virtual | ~FactoryBase () |
Destructor. | |
int | GetID () const |
return unique factory id | |
![]() | |
virtual | ~FactoryAcceptor () |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory)=0 |
Configuration. | |
virtual const RCP< const FactoryBase > | GetFactory (const std::string &varName) const =0 |
![]() | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. | |
virtual const Teuchos::ParameterList & | GetParameterList () const |
void | SetParameter (const std::string &name, const ParameterEntry &entry) |
Set a parameter directly as a ParameterEntry. | |
const ParameterEntry & | GetParameter (const std::string &name) const |
Retrieves a const entry with the name name. | |
virtual void | GetDocumentation (std::ostream &os) const |
![]() | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
![]() | |
static void | SetDefaultVerbLevel (const VerbLevel defaultVerbLevel) |
Set the default (global) verbosity level. | |
static VerbLevel | GetDefaultVerbLevel () |
Get the default (global) verbosity level. | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP< Teuchos::FancyOStream > | GetMueLuOStream () |
![]() | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
![]() | |
void | Input (Level &level, const std::string &varName) const |
void | Input (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName) const |
template<class T > | |
T | Get (Level &level, const std::string &varName, const std::string &varParamName) const |
template<class T > | |
void | Set (Level &level, const std::string &varName, const T &data) const |
bool | IsAvailable (Level &level, const std::string &varName) const |
![]() | |
static bool | timerSync_ = false |
Class that encapsulates Belos smoothers.
This class creates an Belos preconditioner factory. The factory creates a smoother based on the type and ParameterList passed into the constructor. See the constructor for more information.
Definition at line 91 of file MueLu_BelosSmoother_decl.hpp.
|
private |
Definition at line 187 of file MueLu_BelosSmoother_decl.hpp.
|
private |
Definition at line 188 of file MueLu_BelosSmoother_decl.hpp.
MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::BelosSmoother | ( | const std::string | type, |
const Teuchos::ParameterList & | paramList = Teuchos::ParameterList() |
||
) |
Definition at line 76 of file MueLu_BelosSmoother_def.hpp.
|
virtualdefault |
Destructor.
|
virtual |
Set parameters from a parameter list and return with default values.
Reimplemented from MueLu::ParameterListAcceptorImpl.
Definition at line 105 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 110 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
Set up the smoother.
This creates the underlying Belos smoother object, copies any parameter list options supplied to the constructor to the Belos object, and computes the preconditioner.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 117 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
Apply the preconditioner.
Solves the linear system AX=B
using the constructed smoother.
X | initial guess |
B | right-hand side |
InitialGuessIsZero | (optional) If false, some work can be avoided. Whether this actually saves any work depends on the underlying Belos implementation. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 148 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 185 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 192 of file MueLu_BelosSmoother_def.hpp.
void MueLu::BelosSmoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::print | ( | Teuchos::FancyOStream & | out, |
const VerbLevel | verbLevel = Default |
||
) | const |
Print the object with some verbosity level to an FancyOStream object.
Definition at line 207 of file MueLu_BelosSmoother_def.hpp.
|
virtual |
For diagnostic purposes.
Get a rough estimate of cost per iteration
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 237 of file MueLu_BelosSmoother_def.hpp.
|
private |
Definition at line 128 of file MueLu_BelosSmoother_def.hpp.
|
friend |
Constructor.
The options passed into BelosSmoother are those given in the Belos user's manual.
type | smoother type |
list | options for the particular smoother (e.g., fill factor or damping parameter) |
Definition at line 112 of file MueLu_BelosSmoother_decl.hpp.
|
private |
Definition at line 184 of file MueLu_BelosSmoother_decl.hpp.
|
private |
Definition at line 189 of file MueLu_BelosSmoother_decl.hpp.
|
private |
Definition at line 190 of file MueLu_BelosSmoother_decl.hpp.
|
private |
matrix, used in apply if solving residual equation
Definition at line 194 of file MueLu_BelosSmoother_decl.hpp.