IterativeLevelSetSolver2.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_ITERATIVE_LEVEL_SET_SOLVER2_HPP
#define CUBBYFLOW_ITERATIVE_LEVEL_SET_SOLVER2_HPP

#include <Core/Solver/LevelSet/LevelSetSolver2.hpp>

namespace CubbyFlow
{
class IterativeLevelSetSolver2 : public LevelSetSolver2
{
 public:
    IterativeLevelSetSolver2() = default;

    IterativeLevelSetSolver2(const IterativeLevelSetSolver2&) = delete;

    IterativeLevelSetSolver2(IterativeLevelSetSolver2&&) noexcept = delete;

    ~IterativeLevelSetSolver2() override = default;

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

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

    void Reinitialize(const ScalarGrid2& inputSDF, double maxDistance,
                      ScalarGrid2* outputSDF) override;

    void Extrapolate(const ScalarGrid2& input, const ScalarField2& sdf,
                     double maxDistance, ScalarGrid2* output) override;

    void Extrapolate(const CollocatedVectorGrid2& input,
                     const ScalarField2& sdf, double maxDistance,
                     CollocatedVectorGrid2* output) override;

    void Extrapolate(const FaceCenteredGrid2& input, const ScalarField2& sdf,
                     double maxDistance, FaceCenteredGrid2* output) override;

    [[nodiscard]] double GetMaxCFL() const;

    void SetMaxCFL(double newMaxCfl);

 protected:
    virtual void GetDerivatives(ConstArrayView2<double> grid,
                                const Vector2D& gridSpacing, size_t i, size_t j,
                                std::array<double, 2>* dx,
                                std::array<double, 2>* dy) const = 0;

 private:
    void Extrapolate(const ConstArrayView2<double>& input,
                     const ConstArrayView2<double>& sdf,
                     const Vector2D& gridSpacing, double maxDistance,
                     ArrayView2<double> output);

    [[nodiscard]] static unsigned int DistanceToNumberOfIterations(
        double distance, double dtau);

    [[nodiscard]] static double Sign(const ConstArrayView2<double>& sdf,
                                     const Vector2D& gridSpacing, size_t i,
                                     size_t j);

    [[nodiscard]] double PseudoTimeStep(const ConstArrayView2<double>& sdf,
                                        const Vector2D& gridSpacing) const;

    double m_maxCFL = 0.5;
};

using IterativeLevelSetSolver2Ptr = std::shared_ptr<IterativeLevelSetSolver2>;
}  // namespace CubbyFlow

#endif