GridSinglePhasePressureSolver3.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_SINGLE_PHASE_PRESSURE_SOLVER3_HPP
#define CUBBYFLOW_SINGLE_PHASE_PRESSURE_SOLVER3_HPP

#include <Core/FDM/FDMMGLinearSystem3.hpp>
#include <Core/Solver/FDM/FDMLinearSystemSolver3.hpp>
#include <Core/Solver/FDM/FDMMGSolver3.hpp>
#include <Core/Solver/Grid/GridPressureSolver3.hpp>

namespace CubbyFlow
{
class GridSinglePhasePressureSolver3 : public GridPressureSolver3
{
 public:
    GridSinglePhasePressureSolver3();

    GridSinglePhasePressureSolver3(const GridSinglePhasePressureSolver3&) =
        delete;

    GridSinglePhasePressureSolver3(GridSinglePhasePressureSolver3&&) noexcept =
        delete;

    ~GridSinglePhasePressureSolver3() override = default;

    GridSinglePhasePressureSolver3& operator=(
        const GridSinglePhasePressureSolver3&) = delete;

    GridSinglePhasePressureSolver3& operator=(
        GridSinglePhasePressureSolver3&&) noexcept = delete;

    void Solve(const FaceCenteredGrid3& input, double timeIntervalInSeconds,
               FaceCenteredGrid3* output,
               const ScalarField3& boundarySDF =
                   ConstantScalarField3{ std::numeric_limits<double>::max() },
               const VectorField3& boundaryVelocity =
                   ConstantVectorField3{ { 0, 0, 0 } },
               const ScalarField3& fluidSDF =
                   ConstantScalarField3{ -std::numeric_limits<double>::max() },
               bool useCompressed = false) override;

    [[nodiscard]] GridBoundaryConditionSolver3Ptr
    SuggestedBoundaryConditionSolver() const override;

    [[nodiscard]] const FDMLinearSystemSolver3Ptr& GetLinearSystemSolver()
        const;

    void SetLinearSystemSolver(const FDMLinearSystemSolver3Ptr& solver);

    [[nodiscard]] const FDMVector3& GetPressure() const;

 private:
    void BuildMarkers(
        const Vector3UZ& size,
        const std::function<Vector3D(size_t, size_t, size_t)>& pos,
        const ScalarField3& boundarySDF, const ScalarField3& fluidSDF);

    void DecompressSolution();

    virtual void BuildSystem(const FaceCenteredGrid3& input,
                             bool useCompressed);

    virtual void ApplyPressureGradient(const FaceCenteredGrid3& input,
                                       FaceCenteredGrid3* output);

    FDMLinearSystem3 m_system;
    FDMCompressedLinearSystem3 m_compSystem;
    FDMLinearSystemSolver3Ptr m_systemSolver;

    FDMMGLinearSystem3 m_mgSystem;
    FDMMGSolver3Ptr m_mgSystemSolver;

    std::vector<Array3<char>> m_markers;
};

using GridSinglePhasePressureSolver3Ptr =
    std::shared_ptr<GridSinglePhasePressureSolver3>;
}  // namespace CubbyFlow

#endif