GEOSX
Public Member Functions | List of all members
geosx::HypreSolver Class Reference

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

#include <HypreSolver.hpp>

Public Member Functions

 HypreSolver (LinearSolverParameters parameters)
 Solver constructor, with parameter list reference. More...
 
virtual ~HypreSolver ()=default
 Virtual destructor.
 
void solve (HypreMatrix &mat, HypreVector &sol, HypreVector &rhs, DofManager const *const dofManager=nullptr)
 Solve system with an iterative solver (HARD CODED PARAMETERS, GMRES). More...
 
LinearSolverResult const & result ()
 Get the result of previous solve. More...
 

Detailed Description

This class creates and provides basic support for Hypre solvers.

Definition at line 35 of file HypreSolver.hpp.

Constructor & Destructor Documentation

◆ HypreSolver()

geosx::HypreSolver::HypreSolver ( LinearSolverParameters  parameters)

Solver constructor, with parameter list reference.

Parameters
[in]parametersstructure containing linear solver parameters

Member Function Documentation

◆ result()

LinearSolverResult const& geosx::HypreSolver::result ( )
inline

Get the result of previous solve.

Returns
struct with last solve stats

Definition at line 68 of file HypreSolver.hpp.

◆ solve()

void geosx::HypreSolver::solve ( HypreMatrix mat,
HypreVector sol,
HypreVector rhs,
DofManager const *const  dofManager = nullptr 
)

Solve system with an iterative solver (HARD CODED PARAMETERS, GMRES).

Parameters
[in,out]matthe matrix
[in,out]solthe solution
[in,out]rhsthe right-hand side
dofManagerthe Degree-of-Freedom manager associated with matrix

Solve Ax=b with A an HypreMatrix, x and b HypreVector.


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