FDMGaussSeidelSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: FDMGaussSeidelSolver3.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 3-D finite difference-type linear system solver using Gauss-Seidel method.
> Created Time: 2017/08/17
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_FDM_GAUSS_SEIDEL_SOLVER3_H
#define CUBBYFLOW_FDM_GAUSS_SEIDEL_SOLVER3_H

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

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;

        unsigned int GetMaxNumberOfIterations() const;

        unsigned int GetLastNumberOfIterations() const;

        double GetTolerance() const;

        double GetLastResidual() const;

        double GetSORFactor() const;

        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:
        unsigned int m_maxNumberOfIterations;
        unsigned int m_lastNumberOfIterations;
        unsigned int m_residualCheckInterval;
        double m_tolerance;
        double m_lastResidual;
        double m_sorFactor;
        bool m_useRedBlackOrdering;

        // Uncompressed vectors
        FDMVector3 m_residual;

        // Compressed vectors
        VectorND m_residualComp;

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

    using FDMGaussSeidelSolver3Ptr = std::shared_ptr<FDMGaussSeidelSolver3>;
}

#endif