FDMMGPCGSolver3.hpp

Go to the documentation of this file.

// This code is based on Jet framework.
// Copyright (c) 2018 Doyub Kim
// CubbyFlow is voxel-based fluid simulation engine for computer games.
// Copyright (c) 2020 CubbyFlow Team
// Core Part: Chris Ohk, Junwoo Hwang, Jihong Sin, Seungwoo Yoo
// AI Part: Dongheon Cho, Minseo Kim
// We are making my contributions/submissions to this project solely in our
// personal capacity and are not conveying any rights to any intellectual
// property of any third parties.

#ifndef CUBBYFLOW_FDM_MGPCG_SOLVER3_HPP
#define CUBBYFLOW_FDM_MGPCG_SOLVER3_HPP

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

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;

    [[nodiscard]] unsigned int GetMaxNumberOfIterations() const;

    [[nodiscard]] unsigned int GetLastNumberOfIterations() const;

    [[nodiscard]] double GetTolerance() const;

    [[nodiscard]] double GetLastResidual() const;

 private:
    struct Preconditioner final
    {
        void Build(FDMMGLinearSystem3* system, MGParameters<FDMBLAS3> mgParams);

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

        FDMMGLinearSystem3* system = nullptr;
        MGParameters<FDMBLAS3> mgParams;
    };

    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>;
}  // namespace CubbyFlow

#endif