FDMMGPCGSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: FDMMGPCGSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D finite difference-type linear system solver using Multigrid
>          Preconditioned conjugate gradient (MGPCG).
> Created Time: 2017/11/05
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_FDM_MGPCG_SOLVER3_H
#define CUBBYFLOW_FDM_MGPCG_SOLVER3_H

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

namespace CubbyFlow
{
    class FDMMGPCGSolver3 final : public FDMMGSolver3
    {
    public:
        FDMMGPCGSolver3(
            unsigned int numberOfCGIter,
            size_t maxNumberOfLevels,
            unsigned int numberOfRestrictionIter = 5,
            unsigned int numberOfCorrectionIter = 5,
            unsigned int numberOfCoarsestIter = 20,
            unsigned int numberOfFinalIter = 20,
            double maxTolerance = 1e-9,
            double sorFactor = 1.5,
            bool useRedBlackOrdering = false);

        bool Solve(FDMMGLinearSystem3* system) override;

        unsigned int GetMaxNumberOfIterations() const;

        unsigned int GetLastNumberOfIterations() const;

        double GetTolerance() const;

        double GetLastResidual() const;

    private:
        struct Preconditioner final
        {
            FDMMGLinearSystem3* system;
            MGParameters<FDMBLAS3> mgParams;

            void Build(FDMMGLinearSystem3* system, MGParameters<FDMBLAS3> mgParams);

            void Solve(const FDMVector3& b, FDMVector3* x) const;
        };

        unsigned int m_maxNumberOfIterations;
        unsigned int m_lastNumberOfIterations;
        double m_tolerance;
        double m_lastResidualNorm;

        FDMVector3 m_r;
        FDMVector3 m_d;
        FDMVector3 m_q;
        FDMVector3 m_s;
        Preconditioner m_precond;
    };

    using FDMMGPCGSolver3Ptr = std::shared_ptr<FDMMGPCGSolver3>;
}

#endif