GridFractionalBoundaryConditionSolver2.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_FRACTIONAL_BOUNDARY_CONDITION_SOLVER2_HPP
#define CUBBYFLOW_GRID_FRACTIONAL_BOUNDARY_CONDITION_SOLVER2_HPP

#include <Core/Field/CustomVectorField.hpp>
#include <Core/Grid/CellCenteredScalarGrid.hpp>
#include <Core/Solver/Grid/GridBoundaryConditionSolver2.hpp>

namespace CubbyFlow
{
class GridFractionalBoundaryConditionSolver2
    : public GridBoundaryConditionSolver2
{
 public:
    GridFractionalBoundaryConditionSolver2() = default;

    GridFractionalBoundaryConditionSolver2(
        const GridFractionalBoundaryConditionSolver2&) = delete;

    GridFractionalBoundaryConditionSolver2(
        GridFractionalBoundaryConditionSolver2&&) noexcept = delete;

    ~GridFractionalBoundaryConditionSolver2() override = default;

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

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

    void ConstrainVelocity(FaceCenteredGrid2* velocity,
                           unsigned int extrapolationDepth = 5) override;

    [[nodiscard]] ScalarField2Ptr GetColliderSDF() const override;

    [[nodiscard]] VectorField2Ptr GetColliderVelocityField() const override;

 protected:
    void OnColliderUpdated(const Vector2UZ& gridSize,
                           const Vector2D& gridSpacing,
                           const Vector2D& gridOrigin) override;

 private:
    CellCenteredScalarGrid2Ptr m_colliderSDF;
    CustomVectorField2Ptr m_colliderVel;
};

using GridFractionalBoundaryConditionSolver2Ptr =
    std::shared_ptr<GridFractionalBoundaryConditionSolver2>;
}  // namespace CubbyFlow

#endif