|
MueLu Version of the Day
|
Class that encapsulates Amesos2 direct solvers. More...
#include <MueLu_Amesos2Smoother_decl.hpp>
Overridden from Teuchos::Describable | |
| typedef Tpetra::CrsMatrix< Scalar, LocalOrdinal, GlobalOrdinal, Node > | Tpetra_CrsMatrix |
| typedef Tpetra::MultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > | Tpetra_MultiVector |
| std::string | type_ |
| amesos2-specific key phrase that denote smoother type More... | |
| RCP< Amesos2::Solver< Tpetra_CrsMatrix, Tpetra_MultiVector > > | prec_ |
| pointer to Amesos2 solver object More... | |
| bool | useTransformation_ |
| RCP< MultiVector > | X_ |
| RCP< MultiVector > | B_ |
| 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... | |
| size_t | getNodeSmootherComplexity () const |
| Get a rough estimate of cost per iteration. More... | |
Constructors / destructors | |
| Amesos2Smoother (const std::string &type="", const Teuchos::ParameterList ¶mList=Teuchos::ParameterList()) | |
| Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default. More... | |
| virtual | ~Amesos2Smoother () |
| Destructor. More... | |
| RCP< const ParameterList > | GetValidParameterList () const |
| Return a const parameter list of valid parameters that setParameterList() will accept. More... | |
| void | DeclareInput (Level ¤tLevel) const |
| Input. More... | |
Setup and Apply methods. | |
| void | Setup (Level ¤tLevel) |
| Set up the direct solver. This creates the underlying Amesos2 solver object according to the parameter list options passed into the Amesos2Smoother constructor. This includes doing a numeric factorization of the matrix. More... | |
| void | Apply (MultiVector &X, const MultiVector &B, bool InitialGuessIsZero=false) const |
Apply the direct solver. Solves the linear system AX=B using the constructed solver. More... | |
| RCP< SmootherPrototype > | Copy () const |
Class that encapsulates Amesos2 direct solvers.
This class creates an Amesos2 preconditioner factory. The factory is capable of generating direct solvers based on the type and ParameterList passed into the constructor. See the constructor for more information.
Definition at line 77 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
Definition at line 142 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
Definition at line 143 of file MueLu_Amesos2Smoother_decl.hpp.
| MueLu::Amesos2Smoother< Scalar, LocalOrdinal, GlobalOrdinal, Node >::Amesos2Smoother | ( | const std::string & | type = "", |
| const Teuchos::ParameterList & | paramList = Teuchos::ParameterList() |
||
| ) |
Constructor Creates a MueLu interface to the direct solvers in the Amesos2 package. If you are using type=="", then either SuperLU or KLU2 are used by default.
Definition at line 66 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Destructor.
Definition at line 109 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Return a const parameter list of valid parameters that setParameterList() will accept.
Also define the default values of parameters according to the input parameter list.
Reimplemented from MueLu::Factory.
Definition at line 112 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Input.
Definition at line 121 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Set up the direct solver. This creates the underlying Amesos2 solver object according to the parameter list options passed into the Amesos2Smoother constructor. This includes doing a numeric factorization of the matrix.
Definition at line 130 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Apply the direct solver. Solves the linear system AX=B using the constructed solver.
| X | initial guess |
| B | right-hand side |
| InitialGuessIsZero | This option has no effect. |
Definition at line 251 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Definition at line 299 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Return a simple one-line description of this object.
Reimplemented from MueLu::Describable.
Definition at line 306 of file MueLu_Amesos2Smoother_def.hpp.
| void MueLu::Amesos2Smoother< 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 320 of file MueLu_Amesos2Smoother_def.hpp.
|
virtual |
Get a rough estimate of cost per iteration.
Definition at line 344 of file MueLu_Amesos2Smoother_def.hpp.
|
private |
amesos2-specific key phrase that denote smoother type
Definition at line 146 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
pointer to Amesos2 solver object
Definition at line 149 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
Definition at line 151 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
Definition at line 152 of file MueLu_Amesos2Smoother_decl.hpp.
|
private |
Definition at line 152 of file MueLu_Amesos2Smoother_decl.hpp.