Wrapper for UMFPACK direct solver from SuiteSparse package. More...

#include <SuiteSparse.hpp>

Inheritance diagram for geos::SuiteSparse< LAI >:

[legend]

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

using	Vector = typename PreconditionerBase< LAI >::Vector
	Alias for vector type.

using	Matrix = typename PreconditionerBase< LAI >::Matrix
	Alias for matrix type.

Public Types inherited from geos::LinearSolverBase< LAI >
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
	SuiteSparse (LinearSolverParameters params)
	Constructor with parameters. More...

virtual	~SuiteSparse () 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, `dst = this(src)`. More...

void	applyTranspose (Vector const &src, Vector &dst) const
	Apply transpose operator to a vector, `dst = this^T(src)`. More...

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

virtual void	solve (Vector const &rhs, Vector &sol) const override
	Solve the system with a particular rhs. 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...

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

LinearSolverParameters const &	parameters () const

LinearSolverResult const &	result () const

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

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< LAI >
LinearSolverParameters	m_params
	Parameters for the solver.

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

Detailed Description

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

Wrapper for UMFPACK direct solver from SuiteSparse package.

Template Parameters

LAI	type of linear algebra interface

Definition at line 42 of file SuiteSparse.hpp.

Constructor & Destructor Documentation

◆ SuiteSparse()

template<typename LAI >

geos::SuiteSparse< LAI >::SuiteSparse ( LinearSolverParameters params )

Constructor with parameters.

Parameters

[in] params the linear solver parameters

Member Function Documentation

◆ apply()

template<typename LAI >

virtual void geos::SuiteSparse< LAI >::apply	(	Vector const &	src,
		Vector &	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.

◆ applyTranspose()

template<typename LAI >

void geos::SuiteSparse< LAI >::applyTranspose	(	Vector const &	src,
		Vector &	dst
	)		const

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

Parameters

src	input vector
dst	output vector

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

◆ matrix()

template<typename LAI >

Matrix const& geos::PreconditionerBase< LAI >::matrix

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 137 of file PreconditionerBase.hpp.

◆ ready()

template<typename LAI >

bool geos::PreconditionerBase< LAI >::ready

inline

Chech if preconditioner is ready to use.

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

Definition at line 128 of file PreconditionerBase.hpp.

◆ setup()

template<typename LAI >

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

overridevirtual

Compute the preconditioner from a matrix.

Parameters

mat	the matrix to precondition.

Reimplemented from geos::PreconditionerBase< LAI >.

◆ solve()

template<typename LAI >

virtual void geos::SuiteSparse< LAI >::solve	(	Vector const &	rhs,
		Vector &	sol
	)		const

overridevirtual

Solve the system with a particular rhs.

Parameters

[in]	rhs	system right hand side
[out]	sol	system solution

Implements geos::LinearSolverBase< LAI >.

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

coreComponents/linearAlgebra/interfaces/direct/SuiteSparse.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

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

Constructor & Destructor Documentation

◆ SuiteSparse()

Member Function Documentation

◆ apply()

◆ applyTranspose()

◆ matrix()

◆ ready()

◆ setup()

◆ solve()

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