geosx::PreconditionerBase< LAI > Class Template Reference

Common interface for preconditioning operators. More...

#include <PreconditionerBase.hpp>

Inheritance diagram for geosx::PreconditionerBase< LAI >:

Public Types
using	Base = LinearOperator< typename LAI::ParallelVector >
	Alias for base type.
using	Vector = typename Base::Vector
	Alias for vector type.
using	Matrix = typename LAI::ParallelMatrix
	Alias for matrix type.
Public Types inherited from geosx::LinearOperator< LAI::ParallelVector >
using	Vector = LAI::ParallelVector
	Alias for template parameter.

Public Member Functions
virtual void	compute (Matrix const &mat)
	Compute the preconditioner from a matrix. More...
virtual void	compute (Matrix const &mat, DofManager const &dofManager)
	Compute the preconditioner from a matrix. More...
virtual void	clear ()
	Clean up the preconditioner setup. More...
virtual globalIndex	numGlobalRows () const override
	Get the number of global rows. More...
virtual globalIndex	numGlobalCols () const override
	Get the number of global columns. More...
bool	ready () const
	Chech if preconditioner is ready to use. More...
Matrix const &	matrix () const
	Access the matrix the preconditioner was computed from. More...
virtual bool	hasPreconditionerMatrix () const
	Check whether the preconditioner is available in matrix (explicit) form. More...
virtual Matrix const &	preconditionerMatrix () const
	Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner. More...
Public Member Functions inherited from geosx::LinearOperator< LAI::ParallelVector >
	LinearOperator ()=default
	Constructor.
virtual	~LinearOperator ()=default
	Destructor.
virtual void	apply (Vector const &src, Vector &dst) const=0
	Apply operator to a vector. More...
virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual r = Ax - b. More...

Detailed Description

template<typename LAI>
class geosx::PreconditionerBase< LAI >

Common interface for preconditioning operators.

Template Parameters

LAI	linear algebra interface providing vectors, matrices and solvers

Definition at line 31 of file PreconditionerBase.hpp.

Member Function Documentation

clear()

template<typename LAI>

virtual void geosx::PreconditionerBase< LAI >::clear ( )

inlinevirtual

Clean up the preconditioner setup.

Releases memory used and allows the matrix to be deleted cleanly. This method should be called before the matrix used to compute the preconditioner goes out of scope or is re-created. Some implementations require the matrix to outlive the preconditioner (for example, Trilinos/ML may crash the program if deleted after the matrix).

Note

Should be properly overridden in derived classes, which may call this method.

Reimplemented in geosx::BlockPreconditioner< LAI >, geosx::PreconditionerBlockJacobi< LAI >, geosx::HyprePreconditioner, geosx::PetscPreconditioner, geosx::TrilinosPreconditioner, geosx::PreconditionerJacobi< LAI >, and geosx::SeparateComponentPreconditioner< LAI >.

Definition at line 83 of file PreconditionerBase.hpp.

compute() [1/2]

template<typename LAI>

virtual void geosx::PreconditionerBase< LAI >::compute ( Matrix const &  mat )

inlinevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

Reimplemented in geosx::PreconditionerBlockJacobi< LAI >, and geosx::PreconditionerJacobi< LAI >.

Definition at line 54 of file PreconditionerBase.hpp.

compute() [2/2]

template<typename LAI>

virtual void geosx::PreconditionerBase< LAI >::compute ( Matrix const &  mat, DofManager const &  dofManager  )

inlinevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition
dofManager	the Degree-of-Freedom manager associated with matrix

Reimplemented in geosx::PreconditionerBlockJacobi< LAI >, geosx::SeparateComponentPreconditioner< LAI >, and geosx::PreconditionerJacobi< LAI >.

Definition at line 65 of file PreconditionerBase.hpp.

hasPreconditionerMatrix()

template<typename LAI>

virtual bool geosx::PreconditionerBase< LAI >::hasPreconditionerMatrix ( ) const

inlinevirtual

Check whether the preconditioner is available in matrix (explicit) form.

Returns

if the preconditioner is available in explicit form

Reimplemented in geosx::PreconditionerBlockJacobi< LAI >.

Definition at line 129 of file PreconditionerBase.hpp.

matrix()

template<typename LAI>

Matrix const& geosx::PreconditionerBase< LAI >::matrix ( ) const

inline

Access the matrix the preconditioner was computed from.

Returns

reference to the matrix (user's repsonsibility to ensure it's still valid)

Definition at line 119 of file PreconditionerBase.hpp.

numGlobalCols()

template<typename LAI>

virtual globalIndex geosx::PreconditionerBase< LAI >::numGlobalCols ( ) const

inlineoverridevirtual

Get the number of global columns.

Returns

Number of global columns in the operator.

Implements geosx::LinearOperator< LAI::ParallelVector >.

Reimplemented in geosx::PreconditionerJacobi< LAI >.

Definition at line 101 of file PreconditionerBase.hpp.

numGlobalRows()

template<typename LAI>

virtual globalIndex geosx::PreconditionerBase< LAI >::numGlobalRows ( ) const

inlineoverridevirtual

Get the number of global rows.

Returns

Number of global rows in the operator.

Implements geosx::LinearOperator< LAI::ParallelVector >.

Reimplemented in geosx::PreconditionerJacobi< LAI >.

Definition at line 92 of file PreconditionerBase.hpp.

preconditionerMatrix()

template<typename LAI>

virtual Matrix const& geosx::PreconditionerBase< LAI >::preconditionerMatrix ( ) const

inlinevirtual

Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner.

Returns

reference to the preconditioner matrix

Reimplemented in geosx::PreconditionerBlockJacobi< LAI >.

Definition at line 139 of file PreconditionerBase.hpp.

ready()

template<typename LAI>

bool geosx::PreconditionerBase< LAI >::ready ( ) const

inline

Chech if preconditioner is ready to use.

Returns

true if compute() has been called but not clear().

Definition at line 110 of file PreconditionerBase.hpp.

---

The documentation for this class was generated from the following file:

• coreComponents/linearAlgebra/solvers/PreconditionerBase.hpp