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

3-D finite difference-type linear system solver using incomplete Cholesky conjugate gradient (ICCG). More...

#include <jet/fdm_iccg_solver3.h>

Inheritance diagram for jet::FdmIccgSolver3:
jet::FdmLinearSystemSolver3

Public Member Functions

 FdmIccgSolver3 (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 ICCG iterations. More...
 
unsigned int lastNumberOfIterations () const
 Returns the last number of ICCG iterations the solver made. More...
 
double tolerance () const
 Returns the max residual tolerance for the ICCG method. More...
 
double lastResidual () const
 Returns the last residual after the ICCG 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 incomplete Cholesky conjugate gradient (ICCG).

Constructor & Destructor Documentation

◆ FdmIccgSolver3()

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

Constructs the solver with given parameters.

Member Function Documentation

◆ lastNumberOfIterations()

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

Returns the last number of ICCG iterations the solver made.

◆ lastResidual()

double jet::FdmIccgSolver3::lastResidual ( ) const

Returns the last residual after the ICCG iterations.

◆ maxNumberOfIterations()

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

Returns the max number of ICCG iterations.

◆ solve()

bool jet::FdmIccgSolver3::solve ( FdmLinearSystem3 system)
overridevirtual

Solves the given linear system.

Implements jet::FdmLinearSystemSolver3.

◆ solveCompressed()

bool jet::FdmIccgSolver3::solveCompressed ( FdmCompressedLinearSystem3 system)
overridevirtual

Solves the given compressed linear system.

Reimplemented from jet::FdmLinearSystemSolver3.

◆ tolerance()

double jet::FdmIccgSolver3::tolerance ( ) const

Returns the max residual tolerance for the ICCG method.


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