ISTL solver for GPU using the GPU ISTL backend. More...

#include <ISTLSolverGPUISTL.hpp>

Inheritance diagram for Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >:

Public Types
using	SparseMatrixAdapter = GetPropType< TypeTag, Properties::SparseMatrixAdapter >

using	Vector = GetPropType< TypeTag, Properties::GlobalEqVector >

using	Simulator = GetPropType< TypeTag, Properties::Simulator >

using	ElementMapper = GetPropType< TypeTag, Properties::ElementMapper >

using	Matrix = typename SparseMatrixAdapter::IstlMatrix

using	ThreadManager = GetPropType< TypeTag, Properties::ThreadManager >

using	GridView = GetPropType< TypeTag, Properties::GridView >

using	ElementContext = GetPropType< TypeTag, Properties::ElementContext >

using	ElementChunksType = Opm::ElementChunks< GridView, Dune::Partitions::All >

using	real_type = typename Vector::field_type

using	GPUMatrix = Opm::gpuistl::GpuSparseMatrixWrapper< real_type >

using	GPUVector = Opm::gpuistl::GpuVector< real_type >

using	GPUVectorInt = Opm::gpuistl::GpuVector< int >

using	CommunicationType = Dune::Communication< int >

using	SolverType = Opm::gpuistl::detail::FlexibleSolverWrapper< GPUMatrix, GPUVector, CommunicationType >

Public Types inherited from Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >
using	CommunicationType = Dune::Communication< int >

using	Matrix = typename GetPropType< TypeTag, Properties::SparseMatrixAdapter > ::IstlMatrix

Public Member Functions
	ISTLSolverGPUISTL (const Simulator &simulator, const FlowLinearSolverParameters &parameters, bool forceSerial=false)
	Construct a system solver. More...

	ISTLSolverGPUISTL (const Simulator &simulator)
	Construct a system solver. More...

void	eraseMatrix () override
	Signals that the memory for the matrix internally in the solver could be erased. More...

void	setActiveSolver (int num) override
	Set the active solver by its index. More...

int	numAvailableSolvers () const override
	Get the number of available solvers. More...

void	prepare (const SparseMatrixAdapter &M, Vector &b) override
	Prepare the solver with the given matrix and right-hand side vector. More...

void	prepare (const Matrix &M, Vector &b) override
	Prepare the solver with the given matrix and right-hand side vector. More...

void	setResidual (Vector &) override
	Set the residual vector. More...

void	getResidual (Vector &b) const override
	Get the residual vector. More...

void	setMatrix (const SparseMatrixAdapter &) override
	Set the matrix for the solver. More...

bool	solve (Vector &x) override
	Solve the system of linear equations Ax = b. More...

int	iterations () const override

const CommunicationType *	comm () const override
	Get the communication object used by the solver. More...

bool	isParallel () const
	Check if we are running in parallel mode. More...

int	getSolveCount () const override
	Get the count of how many times the solver has been called. More...

Public Member Functions inherited from Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >
virtual void	prepare (const Matrix &M, GetPropType< TypeTag, Properties::GlobalEqVector > &b)=0
	Prepare the solver with the given matrix and right-hand side vector. More...

virtual void	prepare (const GetPropType< TypeTag, Properties::SparseMatrixAdapter > &M, GetPropType< TypeTag, Properties::GlobalEqVector > &b)=0
	Prepare the solver with the given sparse matrix and right-hand side vector. More...

virtual void	setResidual (GetPropType< TypeTag, Properties::GlobalEqVector > &b)=0
	Set the residual vector. More...

virtual void	getResidual (GetPropType< TypeTag, Properties::GlobalEqVector > &b) const=0
	Get the residual vector. More...

virtual void	setMatrix (const GetPropType< TypeTag, Properties::SparseMatrixAdapter > &M)=0
	Set the matrix for the solver. More...

virtual bool	solve (GetPropType< TypeTag, Properties::GlobalEqVector > &x)=0
	Solve the system of equations Ax = b. More...

Static Public Attributes
static constexpr std::size_t	pressureIndex = GetPropType<TypeTag, Properties::Indices>::pressureSwitchIdx

Additional Inherited Members
Static Protected Member Functions inherited from Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >
static bool	checkConvergence (const Dune::InverseOperatorResult &result, const FlowLinearSolverParameters &parameters)
	Check the convergence of the linear solver. More...

Detailed Description

template<class TypeTag>
class Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >

ISTL solver for GPU using the GPU ISTL backend.

This class implements the AbstractISTLSolver interface and provides methods to prepare the solver, set and get residuals, solve the system, and manage communication.

Template Parameters

TypeTag The type tag for the properties used in this solver.

Note: This solver takes CPU matrices and vectors, but uses GPU matrices and vectors internally for computations.

Constructor & Destructor Documentation

◆ ISTLSolverGPUISTL() [1/2]

template<class TypeTag >

Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::ISTLSolverGPUISTL	(	const Simulator &	simulator,
		const FlowLinearSolverParameters &	parameters,
		bool	forceSerial = `false`
	)

inline

Construct a system solver.

Parameters

[in]	simulator	The opm-models simulator object
[in]	parameters	Explicit parameters for solver setup, do not read them from command line parameters.
[in]	forceSerial	If true, will set up a serial linear solver only, local to the current rank, instead of creating a parallel (MPI distributed) linear solver.

◆ ISTLSolverGPUISTL() [2/2]

template<class TypeTag >

Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::ISTLSolverGPUISTL ( const Simulator & simulator )

inlineexplicit

Construct a system solver.

Parameters

[in] simulator The opm-models simulator object

Member Function Documentation

◆ comm()

template<class TypeTag >

const CommunicationType* Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::comm ( ) const

inlineoverridevirtual

Get the communication object used by the solver.

This method returns a pointer to the communication object used by the solver.

Returns: A pointer to the communication object.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ eraseMatrix()

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::eraseMatrix ( )

inlineoverridevirtual

Signals that the memory for the matrix internally in the solver could be erased.

Note: This call could be ignored by the solver, but it is a hint that the solver does not need the matrix anymore.; This method will not do anything.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ getResidual()

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::getResidual ( Vector & b ) const

inlineoverride

Get the residual vector.

This method retrieves the current residual vector from the solver. It copies the data from the internal GPU vector to the provided vector.

Parameters

b	The vector to store the residual.

◆ getSolveCount()

template<class TypeTag >

int Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::getSolveCount ( ) const

inlineoverridevirtual

Get the count of how many times the solver has been called.

This method returns the number of times the solve() method has been called.

Returns: The count of solve calls.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ isParallel()

template<class TypeTag >

bool Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::isParallel ( ) const

inline

Check if we are running in parallel mode.

Returns: true if running with multiple MPI processes and not forced to serial, false otherwise.

◆ iterations()

template<class TypeTag >

int Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::iterations ( ) const

inlineoverridevirtual

Returns the actual number of iterations used in the last solve.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ numAvailableSolvers()

template<class TypeTag >

int Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::numAvailableSolvers ( ) const

inlineoverridevirtual

Get the number of available solvers.

Returns: The number of solvers that can be used.

Note: This method always returns 1, as only one solver is available for the GPU backend.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ prepare() [1/2]

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::prepare	(	const SparseMatrixAdapter &	M,
		Vector &	b
	)

inlineoverride

Prepare the solver with the given matrix and right-hand side vector.

This method initializes the solver with the provided matrix and right-hand side vector. It updates the internal GPU matrix and right-hand side vector.

Parameters

M	The matrix to be used in the solver.
b	The right-hand side vector.

◆ prepare() [2/2]

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::prepare	(	const Matrix &	M,
		Vector &	b
	)

inlineoverride

Prepare the solver with the given matrix and right-hand side vector.

This method initializes the solver with the provided matrix and right-hand side vector. It updates the internal GPU matrix and right-hand side vector.

Parameters

M	The matrix to be used in the solver.
b	The right-hand side vector.

◆ setActiveSolver()

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::setActiveSolver ( int num )

inlineoverridevirtual

Set the active solver by its index.

Parameters

num	The index of the solver to set as active.

Note: The index corresponds to the order in which solvers are registered.; This method will throw an exception if the solver number is not 0, as only one solver is available for the GPU backend.

Implements Opm::AbstractISTLSolver< GetPropType< TypeTag, Properties::SparseMatrixAdapter >, GetPropType< TypeTag, Properties::GlobalEqVector > >.

◆ setMatrix()

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::setMatrix ( const SparseMatrixAdapter & )

inlineoverride

Set the matrix for the solver.

This method sets the matrix that the solver will use to solve the system of equations.

Parameters

M	The sparse matrix adapter containing the matrix data.

Note: This method should be called in addition to prepare() and setResidual() before calling solve().; This method does not set the matrix directly, as it should be handled in prepare().

◆ setResidual()

template<class TypeTag >

void Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::setResidual ( Vector & )

inlineoverride

Set the residual vector.

This method sets the residual vector for the solver.

Parameters

b	The residual vector to set.

Note: This method should be called in addition to prepare() and setMatrix() before calling solve().; Unused in this implementation.

◆ solve()

template<class TypeTag >

bool Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >::solve ( Vector & x )

inlineoverride

Solve the system of linear equations Ax = b.

This method solves the linear system represented by the matrix A and the right-hand side vector b, storing the solution in vector x.

Parameters

x	The vector to store the solution.

Returns: true if the solver converged, false otherwise.

Before this function is called, prepare() should have been called with a valid matrix and right-hand side vector.

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

opm/simulators/linalg/gpuistl/ISTLSolverGPUISTL.hpp

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

template<class TypeTag> class Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >

Constructor & Destructor Documentation

◆ ISTLSolverGPUISTL() [1/2]

◆ ISTLSolverGPUISTL() [2/2]

Member Function Documentation

◆ comm()

◆ eraseMatrix()

◆ getResidual()

◆ getSolveCount()

◆ isParallel()

◆ iterations()

◆ numAvailableSolvers()

◆ prepare() [1/2]

◆ prepare() [2/2]

◆ setActiveSolver()

◆ setMatrix()

◆ setResidual()

◆ solve()

template<class TypeTag>
class Opm::gpuistl::ISTLSolverGPUISTL< TypeTag >