3-D finite difference-type linear system solver using conjugate gradient. More...
#include <jet/fdm_cg_solver3.h>
Inheritance diagram for jet::FdmCgSolver3:
Public Member Functions | |
| FdmCgSolver3 (unsigned int maxNumberOfIterations, double tolerance) | |
| Constructs the solver with given parameters. More... | |
| bool | solve (FdmLinearSystem3 *system) override |
| Solves the given linear system. More... | |
| bool | solveCompressed (FdmCompressedLinearSystem3 *system) override |
| Solves the given compressed linear system. More... | |
| unsigned int | maxNumberOfIterations () const |
| Returns the max number of CG iterations. More... | |
| unsigned int | lastNumberOfIterations () const |
| Returns the last number of CG iterations the solver made. More... | |
| double | tolerance () const |
| Returns the max residual tolerance for the CG method. More... | |
| double | lastResidual () const |
| Returns the last residual after the CG iterations. More... | |
 Public Member Functions inherited from jet::FdmLinearSystemSolver3 | |
| FdmLinearSystemSolver3 ()=default | |
| virtual | ~FdmLinearSystemSolver3 ()=default |
Detailed Description
3-D finite difference-type linear system solver using conjugate gradient.
Constructor & Destructor Documentation
◆ FdmCgSolver3()
| jet::FdmCgSolver3::FdmCgSolver3 | ( | unsigned int | maxNumberOfIterations, |
| double | tolerance | ||
| ) |
Constructs the solver with given parameters.
Member Function Documentation
◆ lastNumberOfIterations()
| unsigned int jet::FdmCgSolver3::lastNumberOfIterations | ( | ) | const |
Returns the last number of CG iterations the solver made.
◆ lastResidual()
| double jet::FdmCgSolver3::lastResidual | ( | ) | const |
Returns the last residual after the CG iterations.
◆ maxNumberOfIterations()
| unsigned int jet::FdmCgSolver3::maxNumberOfIterations | ( | ) | const |
Returns the max number of CG iterations.
◆ solve()
|
overridevirtual |
Solves the given linear system.
Implements jet::FdmLinearSystemSolver3.
◆ solveCompressed()
|
overridevirtual |
Solves the given compressed linear system.
Reimplemented from jet::FdmLinearSystemSolver3.
◆ tolerance()
| double jet::FdmCgSolver3::tolerance | ( | ) | const |
Returns the max residual tolerance for the CG method.
The documentation for this class was generated from the following file:
- jet/fdm_cg_solver3.h
