Ifpack2 Templated Preconditioning Package
Version 1.0
|
Wrapper for iterative linear solvers (e.g., CG or GMRES). More...
#include <Ifpack2_Krylov_decl.hpp>
Public Types | |
typedef MatrixType::scalar_type | scalar_type |
The type of the entries of the input MatrixType. More... | |
typedef BelosScalarType< scalar_type >::type | belos_scalar_type |
The scalar type used by Belos (which may not be scalar_type) More... | |
typedef MatrixType::local_ordinal_type | local_ordinal_type |
The type of local indices in the input MatrixType. More... | |
typedef MatrixType::global_ordinal_type | global_ordinal_type |
The type of global indices in the input MatrixType. More... | |
typedef MatrixType::node_type | node_type |
The Node type used by the input MatrixType. More... | |
typedef Teuchos::ScalarTraits< scalar_type >::magnitudeType | magnitude_type |
The type of the magnitude (absolute value) of a matrix entry. More... | |
typedef Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > | row_matrix_type |
Type of the Tpetra::RowMatrix specialization that this class uses. More... | |
typedef Ifpack2::Preconditioner< scalar_type, local_ordinal_type, global_ordinal_type, node_type > | prec_type |
Type of the Ifpack2::Preconditioner specialization from which this class inherits. More... | |
![]() | |
typedef Teuchos::ScalarTraits< MatrixType::scalar_type >::magnitudeType | magnitude_type |
The type of the magnitude (absolute value) of a matrix entry. More... | |
Public Member Functions | |
Krylov (const Teuchos::RCP< const row_matrix_type > &A) | |
Constructor that takes a Tpetra::RowMatrix. More... | |
virtual | ~Krylov () |
Destructor. More... | |
Methods for setting parameters and initialization | |
void | setParameters (const Teuchos::ParameterList ¶ms) |
Set the preconditioner's parameters. More... | |
void | initialize () |
Do any initialization that depends on the input matrix's structure. More... | |
bool | isInitialized () const |
Return true if initialize() completed successfully, else false . More... | |
void | compute () |
Do any initialization that depends on the input matrix's values. More... | |
bool | isComputed () const |
Return true if compute() completed successfully, else false . More... | |
Implementation of Ifpack2::Details::CanChangeMatrix | |
virtual void | setMatrix (const Teuchos::RCP< const row_matrix_type > &A) |
Change the matrix to be preconditioned. More... | |
Implementation of Tpetra::Operator | |
void | apply (const Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &X, Tpetra::MultiVector< scalar_type, local_ordinal_type, global_ordinal_type, node_type > &Y, Teuchos::ETransp mode=Teuchos::NO_TRANS, scalar_type alpha=Teuchos::ScalarTraits< scalar_type >::one(), scalar_type beta=Teuchos::ScalarTraits< scalar_type >::zero()) const |
Apply the preconditioner to X, putting the result in Y. More... | |
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > | getDomainMap () const |
Tpetra::Map representing the domain of this operator. More... | |
Teuchos::RCP< const Tpetra::Map< local_ordinal_type, global_ordinal_type, node_type > > | getRangeMap () const |
Tpetra::Map representing the range of this operator. More... | |
bool | hasTransposeApply () const |
Whether this object's apply() method can apply the transpose (or conjugate transpose, if applicable). More... | |
Mathematical functions. | |
Teuchos::RCP< const Teuchos::Comm< int > > | getComm () const |
Return the operator's communicator. More... | |
Teuchos::RCP< const Tpetra::RowMatrix< scalar_type, local_ordinal_type, global_ordinal_type, node_type > > | getMatrix () const |
Returns a reference to the matrix to be preconditioned. More... | |
int | getNumInitialize () const |
Returns the number of calls to Initialize(). More... | |
int | getNumCompute () const |
Returns the number of calls to Compute(). More... | |
int | getNumApply () const |
Returns the number of calls to apply(). More... | |
double | getInitializeTime () const |
Returns the time spent in Initialize(). More... | |
double | getComputeTime () const |
Returns the time spent in Compute(). More... | |
double | getApplyTime () const |
Returns the time spent in apply(). More... | |
Overridden from Teuchos::Describable | |
std::string | description () const |
Return a simple one-line description of this object. More... | |
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... | |
![]() | |
virtual | ~Preconditioner () |
Destructor. More... | |
![]() | |
virtual void | setMatrix (const Teuchos::RCP< const Tpetra::RowMatrix< MatrixType::scalar_type, MatrixType::local_ordinal_type, MatrixType::global_ordinal_type, MatrixType::node_type > > &A)=0 |
Set the new matrix. More... | |
virtual | ~CanChangeMatrix () |
Destructor. More... | |
Wrapper for iterative linear solvers (e.g., CG or GMRES).
MatrixType | A specialization of Tpetra::RowMatrix. |
Krylov computes a few iterations of CG or GMRES with zero initial guess as a smoother for a given Tpetra::RowMatrix.
For a list of all run-time parameters that this class accepts, see the documentation of setParameters().
typedef MatrixType::scalar_type Ifpack2::Krylov< MatrixType >::scalar_type |
The type of the entries of the input MatrixType.
typedef BelosScalarType<scalar_type>::type Ifpack2::Krylov< MatrixType >::belos_scalar_type |
The scalar type used by Belos (which may not be scalar_type)
typedef MatrixType::local_ordinal_type Ifpack2::Krylov< MatrixType >::local_ordinal_type |
The type of local indices in the input MatrixType.
typedef MatrixType::global_ordinal_type Ifpack2::Krylov< MatrixType >::global_ordinal_type |
The type of global indices in the input MatrixType.
typedef MatrixType::node_type Ifpack2::Krylov< MatrixType >::node_type |
The Node type used by the input MatrixType.
typedef Teuchos::ScalarTraits<scalar_type>::magnitudeType Ifpack2::Krylov< MatrixType >::magnitude_type |
The type of the magnitude (absolute value) of a matrix entry.
typedef Tpetra::RowMatrix<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Krylov< MatrixType >::row_matrix_type |
Type of the Tpetra::RowMatrix specialization that this class uses.
typedef Ifpack2::Preconditioner<scalar_type, local_ordinal_type, global_ordinal_type, node_type> Ifpack2::Krylov< MatrixType >::prec_type |
Type of the Ifpack2::Preconditioner specialization from which this class inherits.
|
explicit |
Constructor that takes a Tpetra::RowMatrix.
|
virtual |
Destructor.
|
virtual |
Set the preconditioner's parameters.
This preconditioner accepts the following parameters:
std::string
)int
)magnitude_type
)The "krylov: iteration type" parameter specifies the name of the iterative linear solver to use.
Note: Because some of the iterative solvers in Belos are not currently supported for complex types, the BelosSolverFactory is not used; Ifpack2::Krylov either uses Block GMRES or Block CG.
|
virtual |
Do any initialization that depends on the input matrix's structure.
|
inlinevirtual |
Return true
if initialize() completed successfully, else false
.
|
virtual |
Do any initialization that depends on the input matrix's values.
|
inlinevirtual |
Return true
if compute() completed successfully, else false
.
|
virtual |
Change the matrix to be preconditioned.
[in] | A | The new matrix. |
! isInitialized ()
! isComputed ()
Calling this method resets the preconditioner's state. After calling this method with a nonnull input, you must first call initialize() and compute() (in that order) before you may call apply().
You may call this method with a null input. If A is null, then you may not call initialize() or compute() until you first call this method again with a nonnull input. This method invalidates any previous factorization whether or not A is null, so calling setMatrix() with a null input is one way to clear the preconditioner's state (and free any memory that it may be using).
The new matrix A need not necessarily have the same Maps or even the same communicator as the original matrix.
|
virtual |
Apply the preconditioner to X, putting the result in Y.
|
virtual |
Tpetra::Map representing the domain of this operator.
|
virtual |
Tpetra::Map representing the range of this operator.
bool Ifpack2::Krylov< MatrixType >::hasTransposeApply | ( | ) | const |
Whether this object's apply() method can apply the transpose (or conjugate transpose, if applicable).
Teuchos::RCP< const Teuchos::Comm< int > > Ifpack2::Krylov< MatrixType >::getComm | ( | ) | const |
Return the operator's communicator.
|
virtual |
Returns a reference to the matrix to be preconditioned.
|
virtual |
Returns the number of calls to Initialize().
|
virtual |
Returns the number of calls to Compute().
|
virtual |
Returns the number of calls to apply().
|
virtual |
Returns the time spent in Initialize().
|
virtual |
Returns the time spent in Compute().
|
virtual |
Returns the time spent in apply().
std::string Ifpack2::Krylov< MatrixType >::description | ( | ) | const |
Return a simple one-line description of this object.
void Ifpack2::Krylov< MatrixType >::describe | ( | Teuchos::FancyOStream & | out, |
const Teuchos::EVerbosityLevel | verbLevel = Teuchos::Describable::verbLevel_default |
||
) | const |
Print the object with some verbosity level to an FancyOStream object.