Simple interface for linear solvers that allows to extract solution results. More...
#include <LinearSolverBase.hpp>
Inheritance diagram for geos::LinearSolverBase< LAI >:
Public Types | |
| 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 | |
| LinearSolverBase (LinearSolverParameters params) | |
| Constructor. More... | |
| virtual void | solve (Vector const &rhs, Vector &sol) const =0 |
| Solve preconditioned system. More... | |
| const LinearSolverParameters & | parameters () const |
| const LinearSolverResult & | result () const |
| Public Member Functions inherited from geos::PreconditionerBase< LAI > | |
| virtual void | setup (Matrix const &mat) |
| Compute the preconditioner from a matrix. More... | |
| virtual void | clear () |
| Clean up the preconditioner setup. 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... | |
| const Matrix & | 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 const Matrix & | 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... | |
| virtual globalIndex | numGlobalRows () const=0 |
| Get the number of global rows. More... | |
| virtual globalIndex | numGlobalCols () const=0 |
| Get the number of global columns. More... | |
| virtual localIndex | numLocalRows () const=0 |
| Get the number of local rows. More... | |
| virtual localIndex | numLocalCols () const=0 |
| Get the number of local columns. More... | |
| virtual MPI_Comm | comm () const=0 |
| Get the MPI communicator the matrix was created with. More... | |
Protected Attributes | |
| LinearSolverParameters | m_params |
| Parameters for the solver. | |
| LinearSolverResult | m_result |
| Result of most recent solve (status, timings) | |
Detailed Description
template<typename LAI>
class geos::LinearSolverBase< LAI >
Simple interface for linear solvers that allows to extract solution results.
- Template Parameters
-
LAI linear algebra interface type
Definition at line 34 of file LinearSolverBase.hpp.
Constructor & Destructor Documentation
◆ LinearSolverBase()
template<typename LAI >
|
inlineexplicit |
Member Function Documentation
◆ parameters()
template<typename LAI >
|
inline |
- Returns
- parameters of the solver.
Definition at line 65 of file LinearSolverBase.hpp.
◆ result()
template<typename LAI >
|
inline |
- Returns
- result of the most recent solve.
Definition at line 73 of file LinearSolverBase.hpp.
◆ solve()
template<typename LAI >
|
pure virtual |
Solve preconditioned system.
- Parameters
-
[in] rhs system right hand side. [in,out] sol system solution (input = initial guess, output = solution).
Implemented in geos::SuiteSparse< LAI >, and geos::SuperLUDist< LAI >.
The documentation for this class was generated from the following file:
- coreComponents/linearAlgebra/common/LinearSolverBase.hpp
