CubbyFlow::FDMCGSolver3 Class Referencefinal

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

#include <Core/Solver/FDM/FDMCGSolver3.hpp>

Inheritance diagram for CubbyFlow::FDMCGSolver3:
CubbyFlow::FDMLinearSystemSolver3

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 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::FDMLinearSystemSolver3
 FDMLinearSystemSolver3 ()=default
 Default constructor. More...
 
 FDMLinearSystemSolver3 (const FDMLinearSystemSolver3 &)=delete
 Deleted copy constructor. More...
 
 FDMLinearSystemSolver3 (FDMLinearSystemSolver3 &&) noexcept=delete
 Deleted move constructor. More...
 
virtual ~FDMLinearSystemSolver3 ()=default
 Default virtual destructor. More...
 
FDMLinearSystemSolver3operator= (const FDMLinearSystemSolver3 &)=delete
 Deleted copy assignment operator. More...
 
FDMLinearSystemSolver3operator= (FDMLinearSystemSolver3 &&) noexcept=delete
 Deleted move assignment operator. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ FDMCGSolver3()

CubbyFlow::FDMCGSolver3::FDMCGSolver3 ( unsigned int  maxNumberOfIterations,
double  tolerance 
)

Constructs the solver with given parameters.

Member Function Documentation

◆ GetLastNumberOfIterations()

unsigned int CubbyFlow::FDMCGSolver3::GetLastNumberOfIterations ( ) const

Returns the last number of Jacobi iterations the solver made.

◆ GetLastResidual()

double CubbyFlow::FDMCGSolver3::GetLastResidual ( ) const

Returns the last residual after the Jacobi iterations.

◆ GetMaxNumberOfIterations()

unsigned int CubbyFlow::FDMCGSolver3::GetMaxNumberOfIterations ( ) const

Returns the max number of Jacobi iterations.

◆ GetTolerance()

double CubbyFlow::FDMCGSolver3::GetTolerance ( ) const

Returns the max residual tolerance for the Jacobi method.

◆ Solve()

bool CubbyFlow::FDMCGSolver3::Solve ( FDMLinearSystem3 system)
overridevirtual

Solves the given linear system.

Implements CubbyFlow::FDMLinearSystemSolver3.

◆ SolveCompressed()

bool CubbyFlow::FDMCGSolver3::SolveCompressed ( FDMCompressedLinearSystem3 system)
overridevirtual

Solves the given compressed linear system.

Reimplemented from CubbyFlow::FDMLinearSystemSolver3.


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