|
| bool | constructionSuccessful_ |
| |
| std::string | type_ |
| | ifpack2-specific key phrase that denote smoother type
|
| |
| LO | overlap_ |
| | overlap when using the smoother in additive Schwarz mode
|
| |
| RCP< Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | prec_ |
| | pointer to Ifpack2 preconditioner object
|
| |
| RCP< Operator > | 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.
|
| |
| RCP< Ifpack2::Preconditioner< Scalar, LocalOrdinal, GlobalOrdinal, Node > > | getPreconditioner () |
| | For diagnostic purposes.
|
| |
| size_t | getNodeSmootherComplexity () const |
| | Get a rough estimate of cost per iteration.
|
| |
| 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 |
| |
|
| 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 | 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 () |
| |
| | ParameterListAcceptorImpl () |
| |
| virtual | ~ParameterListAcceptorImpl ()=default |
| |
| virtual const Teuchos::ParameterList & | GetParameterList () const |
| |
| virtual const Teuchos::ParameterList & | GetParameterListWithoutValidation () 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 |
| |
| template<class T > |
| bool | IsType (Level &level, const std::string &varName) const |
| |
| bool | IsAvailable (Level &level, const std::string &varName) const |
| |
| static bool | timerSync_ = false |
| |
template<class
Scalar = SmootherPrototype<>::scalar_type, class
LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class
GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class
Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
class MueLu::Ifpack2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >
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.
template<class
Scalar = SmootherPrototype<>::scalar_type, class
LocalOrdinal = typename SmootherPrototype<Scalar>::local_ordinal_type, class
GlobalOrdinal = typename SmootherPrototype<Scalar, LocalOrdinal>::global_ordinal_type, class
Node = typename SmootherPrototype<Scalar, LocalOrdinal, GlobalOrdinal>::node_type>
template<class Scalar2 , class LocalOrdinal2 , class GlobalOrdinal2 , class Node2 >
Constructor.
The options passed into Ifpack2Smoother are those given in the Ifpack2 user's manual.
- Parameters
-
| 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.
- Gauss-Seidel
type = point relaxation stand-alone
- parameter list options
relaxation: type = Gauss-Seidel
relaxation: damping factor
- symmetric Gauss-Seidel
type = point relaxation stand-alone
- parameter list options
relaxation: type = symmetric Gauss-Seidel
relaxation: damping factor
- Chebyshev
type = Chebyshev
- parameter list options
chebyshev: ratio eigenvalue
chebyshev: min eigenvalue
chebyshev: max eigenvalue
chebyshev: degree
chebyshev: zero starting solution (defaults to true)
- ILU
type = ILU
- parameter list options
See also Ifpack2::Relaxation, Ifpack2::Chebyshev, or Ifpack2::ILUT.
Definition at line 101 of file MueLu_Ifpack2Smoother_decl.hpp.