MueLu
Version of the Day
|
Class that encapsulates Ifpack2 smoothers. More...
#include <MueLu_Ifpack2Smoother_decl.hpp>
Public Member Functions | |
void | SetParameterList (const Teuchos::ParameterList ¶mList) |
Set parameters from a parameter list and return with default values. More... | |
RCP< Ifpack2::Preconditioner < Scalar, LocalOrdinal, GlobalOrdinal, Node > > | getPreconditioner () |
For diagnostic purposes. More... | |
size_t | getNodeSmootherComplexity () const |
Get a rough estimate of cost per iteration. More... | |
Public Member Functions inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
SmootherPrototype () | |
/Destructors. More... | |
virtual | ~SmootherPrototype () |
bool | IsSetup () const |
Get the state of a smoother prototype. More... | |
void | IsSetup (bool const &ToF) |
Set the state of a smoother prototype. More... | |
virtual void | CallBuild (Level &) const |
virtual void | CallDeclareInput (Level &requestedLevel) const |
Public Member Functions inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
SmootherBase () | |
virtual | ~SmootherBase () |
void | declareConstructionOutcome (bool fail, std::string msg) |
bool | constructionSuccessful () |
std::string | constructionErrorMsg () |
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::FancyOStream & | GetOStream (MsgType type, int thisProcRankOnly=0) const |
Get an output stream for outputting the input message type. More... | |
Teuchos::FancyOStream & | GetBlackHole () 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) | |
virtual const VerboseObject & | setVerbLevel (const EVerbosityLevel verbLevel) const |
virtual const VerboseObject & | setOverridingVerbLevel (const EVerbosityLevel verbLevel) const |
virtual EVerbosityLevel | getVerbLevel () const |
TEUCHOSPARAMETERLIST_LIB_DLL_EXPORT RCP< const ParameterList > | getValidVerboseObjectSublist () |
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 VerboseObjectBase & | setOStream (const RCP< FancyOStream > &oStream) const |
virtual const VerboseObjectBase & | setOverridingOStream (const RCP< FancyOStream > &oStream) const |
virtual VerboseObjectBase & | setLinePrefix (const std::string &linePrefix) |
virtual RCP< FancyOStream > | getOStream () const |
virtual RCP< FancyOStream > | getOverridingOStream () 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 |
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 |
LabeledObject () | |
virtual | ~LabeledObject () |
virtual void | setObjectLabel (const std::string &objectLabel) |
virtual std::string | getObjectLabel () const |
DescribableStreamManipulatorState | describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default) |
std::ostream & | operator<< (std::ostream &os, const DescribableStreamManipulatorState &d) |
Public Member Functions inherited from MueLu::Factory | |
virtual RCP< const ParameterList > | GetValidParameterList () const |
Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
void | EnableMultipleCallCheck () const |
void | DisableMultipleCallCheck () const |
void | ResetDebugData () const |
Factory () | |
Constructor. More... | |
virtual | ~Factory () |
Destructor. More... | |
virtual void | SetFactory (const std::string &varName, const RCP< const FactoryBase > &factory) |
Configuration. More... | |
const RCP< const FactoryBase > | GetFactory (const std::string &varName) const |
Default implementation of FactoryAcceptor::GetFactory() More... | |
RCP< ParameterList > | RemoveFactoriesFromList (const ParameterList &list) const |
Public Member Functions inherited from MueLu::FactoryBase | |
FactoryBase () | |
Constructor. More... | |
virtual | ~FactoryBase () |
Destructor. More... | |
int | GetID () const |
return unique factory id More... | |
Public Member Functions inherited from MueLu::FactoryAcceptor | |
virtual | ~FactoryAcceptor () |
Public Member Functions inherited from MueLu::ParameterListAcceptorImpl | |
ParameterListAcceptorImpl () | |
virtual | ~ParameterListAcceptorImpl ()=default |
virtual const Teuchos::ParameterList & | GetParameterList () const |
void | SetParameter (const std::string &name, const ParameterEntry &entry) |
Set a parameter directly as a ParameterEntry. More... | |
const ParameterEntry & | GetParameter (const std::string &name) const |
Retrieves a const entry with the name name. More... | |
virtual void | GetDocumentation (std::ostream &os) const |
Public Member Functions inherited from MueLu::ParameterListAcceptor | |
ParameterListAcceptor () | |
virtual | ~ParameterListAcceptor ()=default |
Private Member Functions | |
void | SetPrecParameters (const Teuchos::ParameterList &list=Teuchos::ParameterList()) const |
void | SetupSchwarz (Level ¤tLevel) |
void | SetupChebyshev (Level ¤tLevel) |
void | SetupLineSmoothing (Level ¤tLevel) |
void | SetupBlockRelaxation (Level ¤tLevel) |
void | SetupTopological (Level ¤tLevel) |
void | SetupAggregate (Level ¤tLevel) |
void | SetupHiptmair (Level ¤tLevel) |
void | SetupGeneric (Level ¤tLevel) |
Scalar | SetupChebyshevEigenvalues (Level ¤tLevel, const std::string &matrixName, const std::string &label, Teuchos::ParameterList ¶mList) const |
Private Attributes | |
bool | constructionSuccessful_ |
std::string | type_ |
ifpack2-specific key phrase that denote smoother type More... | |
LO | overlap_ |
overlap when using the smoother in additive Schwarz mode More... | |
RCP< Ifpack2::Preconditioner < Scalar, LocalOrdinal, GlobalOrdinal, Node > > | prec_ |
pointer to Ifpack2 preconditioner object More... | |
RCP< Operator > | A_ |
matrix, used in apply if solving residual equation More... | |
Constructors / destructors | |
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 > | |
class | Ifpack2Smoother |
Constructor. More... | |
Ifpack2Smoother (const std::string &type, const Teuchos::ParameterList ¶mList=Teuchos::ParameterList(), const LO &overlap=0) | |
virtual | ~Ifpack2Smoother () |
Destructor. More... | |
void | DeclareInput (Level ¤tLevel) const |
Input. More... | |
Computational methods. | |
void | Setup (Level ¤tLevel) |
Set up the smoother. More... | |
void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the preconditioner. More... | |
Utilities | |
RCP< SmootherPrototype > | Copy () const |
Overridden from Teuchos::Describable | |
std::string | description () const |
Return a simple one-line description of this object. More... | |
void | print (Teuchos::FancyOStream &out, const VerbLevel verbLevel=Default) const |
Print the object with some verbosity level to an FancyOStream object. More... | |
Additional Inherited Members | |
Public Types inherited from MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Public Types inherited from MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node > | |
typedef Scalar | scalar_type |
typedef LocalOrdinal | local_ordinal_type |
typedef GlobalOrdinal | global_ordinal_type |
typedef Node | node_type |
Static Public Member Functions inherited from MueLu::VerboseObject | |
static void | SetMueLuOStream (const Teuchos::RCP< Teuchos::FancyOStream > &mueluOStream) |
static void | SetMueLuOFileStream (const std::string &filename) |
static Teuchos::RCP < Teuchos::FancyOStream > | GetMueLuOStream () |
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 EVerbosityLevel | getDefaultVerbLevel () |
Static Public Member Functions inherited from Teuchos::VerboseObjectBase | |
static void | setDefaultOStream (const RCP< FancyOStream > &defaultOStream) |
static RCP< FancyOStream > | getDefaultOStream () |
Static Public Member Functions inherited from MueLu::Factory | |
static void | EnableTimerSync () |
static void | DisableTimerSync () |
static void | EnableMultipleCheckGlobally () |
static void | DisableMultipleCheckGlobally () |
Static Public Attributes inherited from Teuchos::Describable | |
static const EVerbosityLevel | verbLevel_default |
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 |
Protected Member Functions inherited from MueLu::Factory | |
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 |
template<class T > | |
bool | IsType (Level &level, const std::string &varName) const |
bool | IsAvailable (Level &level, const std::string &varName) const |
Static Protected Attributes inherited from MueLu::Factory | |
static bool | timerSync_ = false |
Class that encapsulates Ifpack2 smoothers.
This class creates an Ifpack2 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 55 of file MueLu_Ifpack2Smoother_decl.hpp.
MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Ifpack2Smoother | ( | const std::string & | type, |
const Teuchos::ParameterList & | paramList = Teuchos::ParameterList() , |
||
const LO & | overlap = 0 |
||
) |
Definition at line 57 of file MueLu_Ifpack2Smoother_def.hpp.
|
inlinevirtual |
Destructor.
Definition at line 107 of file MueLu_Ifpack2Smoother_decl.hpp.
|
virtual |
Set parameters from a parameter list and return with default values.
Reimplemented from MueLu::ParameterListAcceptorImpl.
Definition at line 81 of file MueLu_Ifpack2Smoother_def.hpp.
|
virtual |
Input.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 122 of file MueLu_Ifpack2Smoother_def.hpp.
|
virtual |
Set up the smoother.
This creates the underlying Ifpack2 smoother object, copies any parameter list options supplied to the constructor to the Ifpack2 object, and computes the preconditioner.
TODO The eigenvalue estimate should come from A_, not the Ifpack2 parameter list.
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 173 of file MueLu_Ifpack2Smoother_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 Ifpack2 implementation. |
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 934 of file MueLu_Ifpack2Smoother_def.hpp.
|
virtual |
Implements MueLu::SmootherPrototype< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 993 of file MueLu_Ifpack2Smoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 1000 of file MueLu_Ifpack2Smoother_def.hpp.
void MueLu::Ifpack2Smoother< 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 1012 of file MueLu_Ifpack2Smoother_def.hpp.
|
inline |
For diagnostic purposes.
Definition at line 165 of file MueLu_Ifpack2Smoother_decl.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Implements MueLu::SmootherBase< Scalar, LocalOrdinal, GlobalOrdinal, Node >.
Definition at line 1039 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 92 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 270 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 657 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 512 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 605 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
|
private |
Definition at line 387 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 720 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 900 of file MueLu_Ifpack2Smoother_def.hpp.
|
private |
Definition at line 802 of file MueLu_Ifpack2Smoother_def.hpp.
|
friend |
Constructor.
The options passed into Ifpack2Smoother are those given in the Ifpack2 user's manual.
type | smoother type |
list | options for the particular smoother (e.g., fill factor or damping parameter) |
Here is how to select some of the most common smoothers.
type
= point relaxation stand-alone
relaxation: type
= Gauss-Seidel
relaxation: damping factor
type
= point relaxation stand-alone
relaxation: type
= symmetric Gauss-Seidel
relaxation: damping factor
type
= Chebyshev
chebyshev: ratio eigenvalue
chebyshev: min eigenvalue
chebyshev: max eigenvalue
chebyshev: degree
chebyshev: zero starting solution
(defaults to true
)type
= ILU
fact: level-of-fill
See also Ifpack2::Relaxation, Ifpack2::Chebyshev, or Ifpack2::ILUT.
Definition at line 101 of file MueLu_Ifpack2Smoother_decl.hpp.
|
private |
Definition at line 185 of file MueLu_Ifpack2Smoother_decl.hpp.
|
private |
ifpack2-specific key phrase that denote smoother type
Definition at line 188 of file MueLu_Ifpack2Smoother_decl.hpp.
|
private |
overlap when using the smoother in additive Schwarz mode
Definition at line 191 of file MueLu_Ifpack2Smoother_decl.hpp.
|
private |
pointer to Ifpack2 preconditioner object
Definition at line 194 of file MueLu_Ifpack2Smoother_decl.hpp.
|
private |
matrix, used in apply if solving residual equation
Definition at line 197 of file MueLu_Ifpack2Smoother_decl.hpp.