CubbyFlow::FDMCGSolver2 Class Referencefinal
2-D finite difference-type linear system solver using conjugate gradient. More...
#include <Core/Solver/FDM/FDMCGSolver2.hpp>
Inheritance diagram for CubbyFlow::FDMCGSolver2:
Public Member Functions | |
| FDMCGSolver2 (unsigned int maxNumberOfIterations, double tolerance) | |
| Constructs the solver with given parameters. More... | |
| bool | Solve (FDMLinearSystem2 *system) override |
| Solves the given linear system. More... | |
| bool | SolveCompressed (FDMCompressedLinearSystem2 *system) override |
| Solves the given compressed linear system. More... | |
| unsigned int | GetMaxNumberOfIterations () const |
| Returns the max number of Jacobi iterations. More... | |
| unsigned int | GetLastNumberOfIterations () const |
| Returns the last number of Jacobi iterations the solver made. More... | |
| double | GetTolerance () const |
| Returns the max residual tolerance for the Jacobi method. More... | |
| double | GetLastResidual () const |
| Returns the last residual after the Jacobi iterations. More... | |
 Public Member Functions inherited from CubbyFlow::FDMLinearSystemSolver2 | |
| FDMLinearSystemSolver2 ()=default | |
| Default constructor. More... | |
| FDMLinearSystemSolver2 (const FDMLinearSystemSolver2 &)=delete | |
| Deleted copy constructor. More... | |
| FDMLinearSystemSolver2 (FDMLinearSystemSolver2 &&) noexcept=delete | |
| Deleted move constructor. More... | |
| virtual | ~FDMLinearSystemSolver2 ()=default |
| Default virtual destructor. More... | |
| FDMLinearSystemSolver2 & | operator= (const FDMLinearSystemSolver2 &)=delete |
| Deleted copy assignment operator. More... | |
| FDMLinearSystemSolver2 & | operator= (FDMLinearSystemSolver2 &&) noexcept=delete |
| Deleted move assignment operator. More... | |
Detailed Description
2-D finite difference-type linear system solver using conjugate gradient.
Constructor & Destructor Documentation
◆ FDMCGSolver2()
| CubbyFlow::FDMCGSolver2::FDMCGSolver2 | ( | unsigned int | maxNumberOfIterations, |
| double | tolerance | ||
| ) |
Constructs the solver with given parameters.
Member Function Documentation
◆ GetLastNumberOfIterations()
| unsigned int CubbyFlow::FDMCGSolver2::GetLastNumberOfIterations | ( | ) | const |
Returns the last number of Jacobi iterations the solver made.
◆ GetLastResidual()
| double CubbyFlow::FDMCGSolver2::GetLastResidual | ( | ) | const |
Returns the last residual after the Jacobi iterations.
◆ GetMaxNumberOfIterations()
| unsigned int CubbyFlow::FDMCGSolver2::GetMaxNumberOfIterations | ( | ) | const |
Returns the max number of Jacobi iterations.
◆ GetTolerance()
| double CubbyFlow::FDMCGSolver2::GetTolerance | ( | ) | const |
Returns the max residual tolerance for the Jacobi method.
◆ Solve()
|
overridevirtual |
Solves the given linear system.
Implements CubbyFlow::FDMLinearSystemSolver2.
◆ SolveCompressed()
|
overridevirtual |
Solves the given compressed linear system.
Reimplemented from CubbyFlow::FDMLinearSystemSolver2.
The documentation for this class was generated from the following file:
- Core/Solver/FDM/FDMCGSolver2.hpp
