Jet  v1.3.3
Public Member Functions | List of all members
jet::FdmCgSolver2 Class Referencefinal

2-D finite difference-type linear system solver using conjugate gradient. More...

#include <jet/fdm_cg_solver2.h>

Inheritance diagram for jet::FdmCgSolver2:
jet::FdmLinearSystemSolver2

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 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::FdmLinearSystemSolver2
 FdmLinearSystemSolver2 ()=default
 
virtual ~FdmLinearSystemSolver2 ()=default
 

Detailed Description

2-D finite difference-type linear system solver using conjugate gradient.

Constructor & Destructor Documentation

◆ FdmCgSolver2()

jet::FdmCgSolver2::FdmCgSolver2 ( unsigned int  maxNumberOfIterations,
double  tolerance 
)

Constructs the solver with given parameters.

Member Function Documentation

◆ lastNumberOfIterations()

unsigned int jet::FdmCgSolver2::lastNumberOfIterations ( ) const

Returns the last number of CG iterations the solver made.

◆ lastResidual()

double jet::FdmCgSolver2::lastResidual ( ) const

Returns the last residual after the CG iterations.

◆ maxNumberOfIterations()

unsigned int jet::FdmCgSolver2::maxNumberOfIterations ( ) const

Returns the max number of CG iterations.

◆ solve()

bool jet::FdmCgSolver2::solve ( FdmLinearSystem2 system)
overridevirtual

Solves the given linear system.

Implements jet::FdmLinearSystemSolver2.

◆ solveCompressed()

bool jet::FdmCgSolver2::solveCompressed ( FdmCompressedLinearSystem2 system)
overridevirtual

Solves the given compressed linear system.

Reimplemented from jet::FdmLinearSystemSolver2.

◆ tolerance()

double jet::FdmCgSolver2::tolerance ( ) const

Returns the max residual tolerance for the CG method.


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