GridPressureSolver3.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_GRID_PRESSURE_SOLVER3_HPP
#define CUBBYFLOW_GRID_PRESSURE_SOLVER3_HPP

#include <Core/Field/ConstantScalarField.hpp>
#include <Core/Field/ConstantVectorField.hpp>
#include <Core/Grid/FaceCenteredGrid.hpp>
#include <Core/Solver/Grid/GridBoundaryConditionSolver3.hpp>

namespace CubbyFlow
{
class GridPressureSolver3
{
 public:
    GridPressureSolver3() = default;

    GridPressureSolver3(const GridPressureSolver3&) = delete;

    GridPressureSolver3(GridPressureSolver3&&) noexcept = delete;

    virtual ~GridPressureSolver3() = default;

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

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

    virtual 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) = 0;

    [[nodiscard]] virtual GridBoundaryConditionSolver3Ptr
    SuggestedBoundaryConditionSolver() const = 0;
};

using GridPressureSolver3Ptr = std::shared_ptr<GridPressureSolver3>;
}  // namespace CubbyFlow

#endif