IterativeLevelSetSolver3.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_SOLVER3_HPP
#define CUBBYFLOW_ITERATIVE_LEVEL_SET_SOLVER3_HPP

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

namespace CubbyFlow
{
class IterativeLevelSetSolver3 : public LevelSetSolver3
{
 public:
    IterativeLevelSetSolver3() = default;

    IterativeLevelSetSolver3(const IterativeLevelSetSolver3&) = delete;

    IterativeLevelSetSolver3(IterativeLevelSetSolver3&&) noexcept = delete;

    ~IterativeLevelSetSolver3() override = default;

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

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

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

    void Extrapolate(const ScalarGrid3& input, const ScalarField3& sdf,
                     double maxDistance, ScalarGrid3* output) override;

    void Extrapolate(const CollocatedVectorGrid3& input,
                     const ScalarField3& sdf, double maxDistance,
                     CollocatedVectorGrid3* output) override;

    void Extrapolate(const FaceCenteredGrid3& input, const ScalarField3& sdf,
                     double maxDistance, FaceCenteredGrid3* output) override;

    [[nodiscard]] double GetMaxCFL() const;

    void SetMaxCFL(double newMaxCFL);

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

 private:
    void Extrapolate(const ConstArrayView3<double>& input,
                     const ConstArrayView3<double>& sdf,
                     const Vector3D& gridSpacing, double maxDistance,
                     ArrayView3<double> output);

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

    [[nodiscard]] static double Sign(const ConstArrayView3<double>& sdf,
                                     const Vector3D& gridSpacing, size_t i,
                                     size_t j, size_t k);

    [[nodiscard]] double PseudoTimeStep(const ConstArrayView3<double>& sdf,
                                        const Vector3D& gridSpacing) const;

    double m_maxCFL = 0.5;
};

using IterativeLevelSetSolver3Ptr = std::shared_ptr<IterativeLevelSetSolver3>;
}  // namespace CubbyFlow

#endif