GridFractionalBoundaryConditionSolver3.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_SOLVER3_HPP
#define CUBBYFLOW_GRID_FRACTIONAL_BOUNDARY_CONDITION_SOLVER3_HPP

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

namespace CubbyFlow
{
class GridFractionalBoundaryConditionSolver3
    : public GridBoundaryConditionSolver3
{
 public:
    GridFractionalBoundaryConditionSolver3() = default;

    GridFractionalBoundaryConditionSolver3(
        const GridFractionalBoundaryConditionSolver3&) = delete;

    GridFractionalBoundaryConditionSolver3(
        GridFractionalBoundaryConditionSolver3&&) noexcept = delete;

    ~GridFractionalBoundaryConditionSolver3() override = default;

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

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

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

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

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

 protected:
    void OnColliderUpdated(const Vector3UZ& gridSize,
                           const Vector3D& gridSpacing,
                           const Vector3D& gridOrigin) override;

 private:
    CellCenteredScalarGrid3Ptr m_colliderSDF;
    CustomVectorField3Ptr m_colliderVel;
};

using GridFractionalBoundaryConditionSolver3Ptr =
    std::shared_ptr<GridFractionalBoundaryConditionSolver3>;
}  // namespace CubbyFlow

#endif