FDMGaussSeidelSolver3.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_GAUSS_SEIDEL_SOLVER3_HPP
#define CUBBYFLOW_FDM_GAUSS_SEIDEL_SOLVER3_HPP

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

namespace CubbyFlow
{
class FDMGaussSeidelSolver3 final : public FDMLinearSystemSolver3
{
 public:
    FDMGaussSeidelSolver3(unsigned int maxNumberOfIterations,
                          unsigned int residualCheckInterval, double tolerance,
                          double sorFactor = 1.0,
                          bool useRedBlackOrdering = false);

    bool Solve(FDMLinearSystem3* system) override;

    bool SolveCompressed(FDMCompressedLinearSystem3* system) override;

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

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

    [[nodiscard]] double GetTolerance() const;

    [[nodiscard]] double GetLastResidual() const;

    [[nodiscard]] double GetSORFactor() const;

    [[nodiscard]] bool GetUseRedBlackOrdering() const;

    static void Relax(const FDMMatrix3& A, const FDMVector3& b,
                      double sorFactor, FDMVector3* x);

    static void Relax(const MatrixCSRD& A, const VectorND& b, double sorFactor,
                      VectorND* x);

    static void RelaxRedBlack(const FDMMatrix3& A, const FDMVector3& b,
                              double sorFactor, FDMVector3* x);

 private:
    void ClearUncompressedVectors();
    void ClearCompressedVectors();

    // Uncompressed vectors
    FDMVector3 m_residual;

    // Compressed vectors
    VectorND m_residualComp;

    unsigned int m_maxNumberOfIterations;
    unsigned int m_lastNumberOfIterations;
    unsigned int m_residualCheckInterval;
    double m_tolerance;
    double m_lastResidual;
    double m_sorFactor;
    bool m_useRedBlackOrdering;
};

using FDMGaussSeidelSolver3Ptr = std::shared_ptr<FDMGaussSeidelSolver3>;
}  // namespace CubbyFlow

#endif