Common interface for identity preconditioning operator. More...

#include <PreconditionerBlockJacobi.hpp>

Inheritance diagram for geos::PreconditionerBlockJacobi< 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
	PreconditionerBlockJacobi (localIndex const &blockSize=0)
	Constructor. More...

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 void	apply (Vector const &src, Vector &dst) const override
	Apply operator to a vector. More...

virtual bool	hasPreconditionerMatrix () const override
	Whether the preconditioner is available in matrix form. More...

virtual const Matrix &	preconditionerMatrix () const override
	Access the preconditioner in matrix form. More...

Public Member Functions inherited from geos::PreconditionerBase< LAI >
virtual globalIndex	numGlobalRows () const override
	Get the number of global rows. More...

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

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...

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::PreconditionerBlockJacobi< LAI >

Common interface for identity preconditioning operator.

Template Parameters

LAI	linear algebra interface providing vectors, matrices and solvers

Definition at line 30 of file PreconditionerBlockJacobi.hpp.

Constructor & Destructor Documentation

◆ PreconditionerBlockJacobi()

template<typename LAI >

geos::PreconditionerBlockJacobi< LAI >::PreconditionerBlockJacobi ( localIndex const & blockSize = 0 )

inline

Constructor.

Parameters

blockSize the size of block diagonal matrices.

Definition at line 47 of file PreconditionerBlockJacobi.hpp.

Member Function Documentation

◆ apply()

template<typename LAI >

virtual void geos::PreconditionerBlockJacobi< 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 122 of file PreconditionerBlockJacobi.hpp.

◆ clear()

template<typename LAI >

virtual void geos::PreconditionerBlockJacobi< 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).