GridBoundaryConditionSolver3.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_BOUNDARY_CONDITION_SOLVER3_HPP
#define CUBBYFLOW_GRID_BOUNDARY_CONDITION_SOLVER3_HPP

#include <Core/Field/ScalarField.hpp>
#include <Core/Geometry/Collider.hpp>
#include <Core/Grid/FaceCenteredGrid.hpp>

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

    GridBoundaryConditionSolver3(const GridBoundaryConditionSolver3&) = delete;

    GridBoundaryConditionSolver3(GridBoundaryConditionSolver3&&) noexcept =
        delete;

    virtual ~GridBoundaryConditionSolver3() = default;

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

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

    [[nodiscard]] const Collider3Ptr& GetCollider() const;

    void UpdateCollider(const Collider3Ptr& newCollider,
                        const Vector3UZ& gridSize, const Vector3D& gridSpacing,
                        const Vector3D& gridOrigin);

    [[nodiscard]] int GetClosedDomainBoundaryFlag() const;

    void SetClosedDomainBoundaryFlag(int flag);

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

    [[nodiscard]] virtual ScalarField3Ptr GetColliderSDF() const = 0;

    [[nodiscard]] virtual VectorField3Ptr GetColliderVelocityField() const = 0;

 protected:
    virtual void OnColliderUpdated(const Vector3UZ& gridSize,
                                   const Vector3D& gridSpacing,
                                   const Vector3D& gridOrigin) = 0;

    [[nodiscard]] const Vector3UZ& GetGridSize() const;

    [[nodiscard]] const Vector3D& GetGridSpacing() const;

    [[nodiscard]] const Vector3D& GetGridOrigin() const;

 private:
    Collider3Ptr m_collider;
    Vector3UZ m_gridSize;
    Vector3D m_gridSpacing;
    Vector3D m_gridOrigin;
    int m_closedDomainBoundaryFlag = DIRECTION_ALL;
};

using GridBoundaryConditionSolver3Ptr =
    std::shared_ptr<GridBoundaryConditionSolver3>;
}  // namespace CubbyFlow

#endif