Common interface for identity preconditioning operator. More...

#include <PreconditionerJacobi.hpp>

Inheritance diagram for geos::PreconditionerJacobi< LAI >:

Public Types
using	Base = PreconditionerBase< LAI >
	Alias for base type.

using	Vector = typename Base::Vector
	Alias for vector type.

using	Matrix = typename Base::Matrix
	Alias for matrix type.

Public Types inherited from geos::PreconditionerBase< LAI >
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 geos::LinearOperator< LAI::ParallelVector >
using	Vector = LAI::ParallelVector
	Alias for template parameter.

Public Member Functions
virtual void	setup (Matrix const &mat) override
	Compute the preconditioner from a matrix. More...

virtual void	clear () override
	Clean up the preconditioner setup. More...

virtual globalIndex	numGlobalRows () const override final
	Get the number of global rows. More...

virtual globalIndex	numGlobalCols () const override final
	Get the number of global columns. More...

virtual void	apply (Vector const &src, Vector &dst) const override
	Apply operator to a vector. More...

Public Member Functions inherited from geos::PreconditionerBase< LAI >
virtual localIndex	numLocalRows () const override
	Get the number of local rows. More...

virtual localIndex	numLocalCols () const override
	Get the number of local columns. More...

virtual MPI_Comm	comm () const override
	Get the MPI communicator the matrix was created with. More...

bool	ready () const
	Chech if preconditioner is ready to use. More...

const Matrix &	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 const Matrix &	preconditionerMatrix () const
	Access the preconditioner in matrix form (whenever available). It must be overridden by the specific preconditioner. More...

Public Member Functions inherited from geos::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, `dst = this(src)`. More...

virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual `r = b - this(x)`. More...

virtual globalIndex	numGlobalRows () const=0
	Get the number of global rows. More...

virtual globalIndex	numGlobalCols () const=0
	Get the number of global columns. More...

virtual localIndex	numLocalRows () const=0
	Get the number of local rows. More...

virtual localIndex	numLocalCols () const=0
	Get the number of local columns. More...

virtual MPI_Comm	comm () const=0
	Get the MPI communicator the matrix was created with. More...

Detailed Description

template<typename LAI>
class geos::PreconditionerJacobi< LAI >

Common interface for identity preconditioning operator.

Template Parameters

LAI	linear algebra interface providing vectors, matrices and solvers

Definition at line 29 of file PreconditionerJacobi.hpp.

Member Function Documentation

◆ apply()

template<typename LAI >

virtual void geos::PreconditionerJacobi< LAI >::apply	(	Vector const &	src,
		Vector &	dst
	)		const

inlineoverridevirtual

Apply operator to a vector.

Parameters

src	Input vector (src).
dst	Output vector (dst).

Definition at line 96 of file PreconditionerJacobi.hpp.

◆ clear()

template<typename LAI >

virtual void geos::PreconditionerJacobi< LAI >::clear ( )

inlineoverridevirtual

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 from geos::PreconditionerBase< LAI >.

Definition at line 65 of file PreconditionerJacobi.hpp.

◆ numGlobalCols()

template<typename LAI >

virtual globalIndex geos::PreconditionerJacobi< LAI >::numGlobalCols ( ) const

inlinefinaloverridevirtual

Get the number of global columns.

Returns: Number of global columns in the operator.

Reimplemented from geos::PreconditionerBase< LAI >.

Definition at line 84 of file PreconditionerJacobi.hpp.

◆ numGlobalRows()

template<typename LAI >

virtual globalIndex geos::PreconditionerJacobi< LAI >::numGlobalRows ( ) const

inlinefinaloverridevirtual

Get the number of global rows.

Returns: Number of global rows in the operator.

Reimplemented from geos::PreconditionerBase< LAI >.

Definition at line 74 of file PreconditionerJacobi.hpp.

◆ setup()

template<typename LAI >

virtual void geos::PreconditionerJacobi< LAI >::setup ( Matrix const & mat )

inlineoverridevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

Reimplemented from geos::PreconditionerBase< LAI >.

Definition at line 46 of file PreconditionerJacobi.hpp.

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

coreComponents/linearAlgebra/solvers/PreconditionerJacobi.hpp

Public Types

Public Member Functions

Detailed Description

template<typename LAI> class geos::PreconditionerJacobi< LAI >

Member Function Documentation

◆ apply()

◆ clear()

◆ numGlobalCols()

◆ numGlobalRows()

◆ setup()

template<typename LAI>
class geos::PreconditionerJacobi< LAI >