FDMMGSolver3.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_MG_SOLVER3_HPP
#define CUBBYFLOW_FDM_MG_SOLVER3_HPP

#include <Core/FDM/FDMMGLinearSystem3.hpp>
#include <Core/Solver/FDM/FDMLinearSystemSolver3.hpp>
#include <Core/Utils/MG.hpp>

namespace CubbyFlow
{
class FDMMGSolver3 : public FDMLinearSystemSolver3
{
 public:
    FDMMGSolver3(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);

    [[nodiscard]] const MGParameters<FDMBLAS3>& GetParams() const;

    [[nodiscard]] double GetSORFactor() const;

    [[nodiscard]] bool GetUseRedBlackOrdering() const;

    bool Solve(FDMLinearSystem3* system) final;

    virtual bool Solve(FDMMGLinearSystem3* system);

 private:
    MGParameters<FDMBLAS3> m_mgParams;
    double m_sorFactor;
    bool m_useRedBlackOrdering;
};

using FDMMGSolver3Ptr = std::shared_ptr<FDMMGSolver3>;
}  // namespace CubbyFlow

#endif