geos::HyprePreconditioner Class Reference

Wrapper around hypre-based preconditioners. More...

#include <HyprePreconditioner.hpp>

Inheritance diagram for geos::HyprePreconditioner:

Public Types
using	Base = PreconditionerBase< HypreInterface >
	Alias for base type.
Public Types inherited from geos::PreconditionerBase< HypreInterface >
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
	HyprePreconditioner (LinearSolverParameters params)
	Constructor. More...
	HyprePreconditioner (LinearSolverParameters params, arrayView1d< HypreVector > const &nearNullKernel)
	Constructor. More...
virtual	~HyprePreconditioner () override
	Destructor.
virtual void	setup (Matrix const &mat) override
	Compute the preconditioner from a matrix. More...
virtual void	apply (Vector const &src, Vector &dst) const override
	Apply operator to a vector. More...
virtual void	clear () override
	Clean up the preconditioner setup. More...
HyprePrecWrapper const &	unwrapped () const
	Access the underlying implementation. More...
Public Member Functions inherited from geos::PreconditionerBase< HypreInterface >
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...
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 geos::LinearOperator< LAI::ParallelVector >
	LinearOperator ()=default
	Constructor.
virtual	~LinearOperator ()=default
	Destructor.
virtual void	residual (Vector const &x, Vector const &b, Vector &r) const
	Compute residual r = b - this(x). More...

Detailed Description

Wrapper around hypre-based preconditioners.

Definition at line 44 of file HyprePreconditioner.hpp.

Constructor & Destructor Documentation

HyprePreconditioner() [1/2]

geos::HyprePreconditioner::HyprePreconditioner ( LinearSolverParameters  params )

explicit

Constructor.

Parameters

params

preconditioner parameters

HyprePreconditioner() [2/2]

geos::HyprePreconditioner::HyprePreconditioner	(	LinearSolverParameters	params,
		arrayView1d< HypreVector > const &	nearNullKernel
	)

Constructor.

Parameters

params	preconditioner parameters
nearNullKernel	the user-provided near null kernel

Member Function Documentation

apply()

virtual void geos::HyprePreconditioner::apply ( Vector const &  src, Vector &  dst  ) const

overridevirtual

Apply operator to a vector.

Parameters

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

Warning

src and dst cannot alias the same vector.

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

clear()

virtual void geos::HyprePreconditioner::clear ( )

overridevirtual

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

setup()

virtual void geos::HyprePreconditioner::setup ( Matrix const &  mat )

overridevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

Reimplemented from geos::PreconditionerBase< HypreInterface >.

unwrapped()

HyprePrecWrapper const& geos::HyprePreconditioner::unwrapped

(

)

const

Access the underlying implementation.

Returns

reference to container of preconditioner functions.

Intended for use by HypreSolver.

---

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

• coreComponents/linearAlgebra/interfaces/hypre/HyprePreconditioner.hpp