This class creates and provides basic support for Hypre solvers. More...

#include <HypreSolver.hpp>

Inheritance diagram for geos::HypreSolver:

[legend]

Public Types
using	Base = LinearSolverBase< HypreInterface >
	Alias for base type.

Public Types inherited from geos::LinearSolverBase< HypreInterface >
using	Base = PreconditionerBase< HypreInterface >
	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< 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
	HypreSolver (LinearSolverParameters parameters)
	Solver constructor, with parameter list reference. More...

virtual	~HypreSolver () override
	Destructor.

virtual void	setup (HypreMatrix const &mat) override
	Compute the preconditioner from a matrix. More...

virtual void	apply (HypreVector const &src, HypreVector &dst) const override
	Apply operator to a vector, `dst = this(src)`. More...

virtual void	solve (HypreVector const &rhs, HypreVector &sol) const override
	Solve preconditioned system. More...

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

Public Member Functions inherited from geos::LinearSolverBase< HypreInterface >
	LinearSolverBase (LinearSolverParameters params)
	Constructor. More...

virtual void	solve (Vector const &rhs, Vector &sol) const=0
	Solve preconditioned system. More...

LinearSolverParameters const &	parameters () const

LinearSolverResult const &	result () const

Public Member Functions inherited from geos::PreconditionerBase< HypreInterface >
virtual void	setup (Matrix const &mat)
	Compute the preconditioner from a matrix. 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...

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

Additional Inherited Members
Protected Attributes inherited from geos::LinearSolverBase< HypreInterface >
LinearSolverParameters	m_params
	Parameters for the solver.

LinearSolverResult	m_result
	Result of most recent solve (status, timings)

Detailed Description

This class creates and provides basic support for Hypre solvers.

Definition at line 38 of file HypreSolver.hpp.

Constructor & Destructor Documentation

◆ HypreSolver()

geos::HypreSolver::HypreSolver ( LinearSolverParameters parameters )

explicit

Solver constructor, with parameter list reference.

Parameters

[in] parameters structure containing linear solver parameters

Member Function Documentation

◆ apply()

virtual void geos::HypreSolver::apply	(	HypreVector const &	src,
		HypreVector &	dst
	)		const

overridevirtual

Apply operator to a vector, dst = this(src).

Parameters

src	input vector
dst	output vector

Warning: src and dst cannot alias the same vector (some implementations may allow this).

◆ clear()

virtual void geos::HypreSolver::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::HypreSolver::setup ( HypreMatrix const & mat )

overridevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

◆ solve()

virtual void geos::HypreSolver::solve	(	HypreVector const &	rhs,
		HypreVector &	sol
	)		const

overridevirtual

Solve preconditioned system.

Parameters

[in]	rhs	system right hand side.
[in,out]	sol	system solution (input = initial guess, output = solution).

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

coreComponents/linearAlgebra/interfaces/hypre/HypreSolver.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HypreSolver()

Member Function Documentation

◆ apply()

◆ clear()

◆ setup()

◆ solve()