FDMMGSolver3.h

Go to the documentation of this file.

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

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

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);

        const MGParameters<FDMBLAS3>& GetParams() const;

        double GetSORFactor() const;

        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>;
}

#endif