Ifpack2 Templated Preconditioning Package
Version 1.0
|
"Factory" for creating Ifpack2 preconditioners. More...
#include <Ifpack2_Factory_decl.hpp>
Static Public Member Functions | |
template<class MatrixType > | |
static Teuchos::RCP < Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > | create (const std::string &precType, const Teuchos::RCP< const MatrixType > &matrix) |
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type. More... | |
template<class MatrixType > | |
static Teuchos::RCP < Preconditioner< typename MatrixType::scalar_type, typename MatrixType::local_ordinal_type, typename MatrixType::global_ordinal_type, typename MatrixType::node_type > > | create (const std::string &precType, const Teuchos::RCP< const MatrixType > &matrix, const int overlap) |
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type. More... | |
"Factory" for creating Ifpack2 preconditioners.
This class' create() method lets users create an instance of any Ifpack2 preconditioner.
The create() method has three arguments:
The first argument can assume the following values:
The following fragment of code shows the basic usage of this class.
|
inlinestatic |
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type.
precType | [in] Name of preconditioner type to be created. |
matrix | [in] Matrix used to define the preconditioner |
Throw an exception if the preconditioner with that input name does not exist. Otherwise, return a newly created preconditioner object.
|
inlinestatic |
Create an instance of Ifpack2_Preconditioner given the string name of the preconditioner type.
precType | [in] Name of preconditioner type to be created. |
matrix | [in] Matrix used to define the preconditioner |
overlap | (in) Specified overlap; defaults to 0. |
Throw an exception if the preconditioner with that input name does not exist. Otherwise, return a newly created preconditioner object.