Base class for Krylov solvers. More...

#include <KrylovSolver.hpp>

Inheritance diagram for geos::KrylovSolver< VECTOR >:

[legend]

Public Types
using	Base = LinearOperator< VECTOR >
	Base type.

using	Vector = typename Base::Vector
	Alias for template parameter.

Public Types inherited from geos::LinearOperator< VECTOR >
using	Vector = VECTOR
	Alias for template parameter.

Public Member Functions
	KrylovSolver (LinearSolverParameters params, LinearOperator< Vector > const &matrix, LinearOperator< Vector > const &precond)
	Constructor. More...

virtual	~KrylovSolver () override=default
	Virtual destructor.

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

virtual void	apply (Vector const &src, Vector &dst) const override final
	Apply operator to a vector. 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 localIndex	numLocalRows () const override final
	Get the number of local rows. More...

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

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

const LinearSolverParameters &	parameters () const

const LinearSolverResult &	result () const

arrayView1d< real64 const >	history () const
	Get convergence history of a linear solve. More...

virtual string	methodName () const =0
	Get name of the Krylov subspace method. More...

Public Member Functions inherited from geos::LinearOperator< VECTOR >
	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...

Static Public Member Functions
static std::unique_ptr< KrylovSolver< VECTOR > >	create (LinearSolverParameters const &parameters, LinearOperator< VECTOR > const &matrix, LinearOperator< VECTOR > const &precond)
	Factory method for instantiating Krylov solver objects. More...

Protected Types
using	VectorTemp = typename VectorStorageHelper< VECTOR >::type
	Alias for vector type that can be used for temporaries.

Protected Member Functions
void	logProgress () const
	Output iteration progress (called by implementations). More...

void	logResult () const
	Output convergence result (called by implementations).

Static Protected Member Functions
static VectorTemp	createTempVector (Vector const &src)
	Helper function to create temporary vectors based on a source vector. More...

Protected Attributes
LinearSolverParameters	m_params
	parameters of the solver

const LinearOperator< Vector > &	m_operator
	reference to the operator to be solved

const LinearOperator< Vector > &	m_precond
	reference to the preconditioning operator

LinearSolverResult	m_result
	results of a solve

array1d< real64 >	m_residualNorms
	Absolute residual norms at each iteration (if available)

Detailed Description

template<typename VECTOR>
class geos::KrylovSolver< VECTOR >

Base class for Krylov solvers.

Template Parameters

VECTOR type of vector handled by this solver

Definition at line 32 of file KrylovSolver.hpp.

Constructor & Destructor Documentation

◆ KrylovSolver()

template<typename VECTOR >

geos::KrylovSolver< VECTOR >::KrylovSolver	(	LinearSolverParameters	params,
		LinearOperator< Vector > const &	matrix,
		LinearOperator< Vector > const &	precond
	)

Constructor.

Parameters

[in]	params	parameters solver parameters
[in]	matrix	reference to the system matrix
[in]	precond	reference to the preconditioning operator

Member Function Documentation

◆ apply()

template<typename VECTOR >

virtual void geos::KrylovSolver< VECTOR >::apply	(	Vector const &	src,
		Vector &	dst
	)		const

inlinefinaloverridevirtual

Apply operator to a vector.

Parameters

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

Definition at line 82 of file KrylovSolver.hpp.

◆ comm()

template<typename VECTOR >

virtual MPI_Comm geos::KrylovSolver< VECTOR >::comm ( ) const

inlinefinaloverridevirtual

Get the MPI communicator the matrix was created with.

Returns: MPI communicator passed in create...()

Note: when build without MPI, may return anything (MPI_Comm will be a mock type defined in MpiWrapper)

Implements geos::LinearOperator< VECTOR >.

Definition at line 107 of file KrylovSolver.hpp.

◆ create()

template<typename VECTOR >

static std::unique_ptr< KrylovSolver< VECTOR > > geos::KrylovSolver< VECTOR >::create	(	LinearSolverParameters const &	parameters,
		LinearOperator< VECTOR > const &	matrix,
		LinearOperator< VECTOR > const &	precond
	)

static

Factory method for instantiating Krylov solver objects.

Parameters

parameters	solver parameters
matrix	linear operator to solve (can be a matrix or a matrix-free operator)
precond	preconditioning operator (must be set up by the user prior to calling solve()/apply())

Returns: an owning pointer to the newly instantiated solver

◆ createTempVector()

template<typename VECTOR >

static VectorTemp geos::KrylovSolver< VECTOR >::createTempVector ( Vector const & src )

inlinestaticprotected

Helper function to create temporary vectors based on a source vector.

Parameters

src	the source vector, whose size and parallel distribution will be used

Returns: the new vector

The main purpose is to deal with BlockVector/View/Wrapper hierarchy.

Definition at line 190 of file KrylovSolver.hpp.

◆ history()

template<typename VECTOR >

arrayView1d< real64 const > geos::KrylovSolver< VECTOR >::history ( ) const

inline

Get convergence history of a linear solve.

Returns: array containing residual norms of every iteration (including initial)

Definition at line 132 of file KrylovSolver.hpp.

◆ logProgress()

template<typename VECTOR >

void geos::KrylovSolver< VECTOR >::logProgress ( ) const

protected

Output iteration progress (called by implementations).

Note: must be called after pushing the most recent residual into m_residualNorms

◆ methodName()

template<typename VECTOR >

virtual string geos::KrylovSolver< VECTOR >::methodName ( ) const

pure virtual

Get name of the Krylov subspace method.

Returns: the abbreviated name of the method

Implemented in geos::BicgstabSolver< VECTOR >, geos::CgSolver< VECTOR >, and geos::GmresSolver< VECTOR >.

◆ numGlobalCols()

template<typename VECTOR >

virtual globalIndex geos::KrylovSolver< VECTOR >::numGlobalCols ( ) const

inlinefinaloverridevirtual

Get the number of global columns.

Returns: Number of global columns in the operator.

Implements geos::LinearOperator< VECTOR >.

Definition at line 92 of file KrylovSolver.hpp.

◆ numGlobalRows()

template<typename VECTOR >

virtual globalIndex geos::KrylovSolver< VECTOR >::numGlobalRows ( ) const

inlinefinaloverridevirtual

Get the number of global rows.

Returns: Number of global rows in the operator.

Implements geos::LinearOperator< VECTOR >.

Definition at line 87 of file KrylovSolver.hpp.

◆ numLocalCols()

template<typename VECTOR >

virtual localIndex geos::KrylovSolver< VECTOR >::numLocalCols ( ) const

inlinefinaloverridevirtual

Get the number of local columns.

Returns: Number of local columns in the operator.

Note: The use of term "local columns" refers not to physical partitioning of columns across ranks (as e.g. matrices are partitioned by rows and typically physically store all column entries), but to the partitioning of a compatible vector object that this operator can be applied to.

Implements geos::LinearOperator< VECTOR >.

Definition at line 102 of file KrylovSolver.hpp.

◆ numLocalRows()

template<typename VECTOR >

virtual localIndex geos::KrylovSolver< VECTOR >::numLocalRows ( ) const

inlinefinaloverridevirtual

Get the number of local rows.

Returns: Number of local rows in the operator.

Implements geos::LinearOperator< VECTOR >.

Definition at line 97 of file KrylovSolver.hpp.

◆ parameters()

template<typename VECTOR >

const LinearSolverParameters& geos::KrylovSolver< VECTOR >::parameters ( ) const

inline

Returns: parameters of the solver.

Definition at line 115 of file KrylovSolver.hpp.

◆ result()

template<typename VECTOR >

const LinearSolverResult& geos::KrylovSolver< VECTOR >::result ( ) const

inline

Returns: the result of a linear solve.

Definition at line 123 of file KrylovSolver.hpp.

◆ solve()

template<typename VECTOR >

virtual void geos::KrylovSolver< VECTOR >::solve	(	Vector const &	b,
		Vector &	x
	)		const

pure virtual

Solve preconditioned system.

Parameters

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

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

coreComponents/linearAlgebra/solvers/KrylovSolver.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

template<typename VECTOR> class geos::KrylovSolver< VECTOR >

Constructor & Destructor Documentation

◆ KrylovSolver()

Member Function Documentation

◆ apply()

◆ comm()

◆ create()

◆ createTempVector()

◆ history()

◆ logProgress()

◆ methodName()

◆ numGlobalCols()

◆ numGlobalRows()

◆ numLocalCols()

◆ numLocalRows()

◆ parameters()

◆ result()

◆ solve()

template<typename VECTOR>
class geos::KrylovSolver< VECTOR >