FDMCGSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: FDMCGSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D finite difference-type linear system solver using conjugate gradient.
> Created Time: 2017/08/16
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_FDM_CG_SOLVER3_H
#define CUBBYFLOW_FDM_CG_SOLVER3_H

#include <Core/Solver/FDM/FDMLinearSystemSolver3.h>

namespace CubbyFlow
{
    class FDMCGSolver3 final : public FDMLinearSystemSolver3
    {
    public:
        FDMCGSolver3(unsigned int maxNumberOfIterations, double tolerance);

        bool Solve(FDMLinearSystem3* system) override;

        bool SolveCompressed(FDMCompressedLinearSystem3* system) override;

        unsigned int GetMaxNumberOfIterations() const;

        unsigned int GetLastNumberOfIterations() const;

        double GetTolerance() const;

        double GetLastResidual() const;

    private:
        unsigned int m_maxNumberOfIterations;
        unsigned int m_lastNumberOfIterations;
        double m_tolerance;
        double m_lastResidual;

        // Uncompressed vectors
        FDMVector3 m_r;
        FDMVector3 m_d;
        FDMVector3 m_q;
        FDMVector3 m_s;

        // Compressed vectors
        VectorND m_rComp;
        VectorND m_dComp;
        VectorND m_qComp;
        VectorND m_sComp;

        void ClearUncompressedVectors();
        void ClearCompressedVectors();
    };

    using FDMCGSolver3Ptr = std::shared_ptr<FDMCGSolver3>;
}

#endif