LevelSetLiquidSolver3.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_LEVEL_SET_LIQUID_SOLVER3_HPP
#define CUBBYFLOW_LEVEL_SET_LIQUID_SOLVER3_HPP

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

namespace CubbyFlow
{
class LevelSetLiquidSolver3 : public GridFluidSolver3
{
 public:
    class Builder;

    LevelSetLiquidSolver3();

    LevelSetLiquidSolver3(const Vector3UZ& resolution,
                          const Vector3D& gridSpacing,
                          const Vector3D& gridOrigin);

    LevelSetLiquidSolver3(const LevelSetLiquidSolver3&) = delete;

    LevelSetLiquidSolver3(LevelSetLiquidSolver3&&) noexcept = delete;

    ~LevelSetLiquidSolver3() override = default;

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

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

    [[nodiscard]] ScalarGrid3Ptr GetSignedDistanceField() const;

    [[nodiscard]] LevelSetSolver3Ptr GetLevelSetSolver() const;

    void SetLevelSetSolver(const LevelSetSolver3Ptr& newSolver);

    void SetMinReinitializeDistance(double distance);

    void SetIsGlobalCompensationEnabled(bool isEnabled);

    [[nodiscard]] double ComputeVolume() const;

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void OnBeginAdvanceTimeStep(double timeIntervalInSeconds) override;

    void OnEndAdvanceTimeStep(double timeIntervalInSeconds) override;

    void ComputeAdvection(double timeIntervalInSeconds) override;

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

 private:
    void Reinitialize(double currentCFL);

    void ExtrapolateVelocityToAir(double currentCFL);

    void AddVolume(double volDiff);

    size_t m_signedDistanceFieldId;
    LevelSetSolver3Ptr m_levelSetSolver;
    double m_minReinitializeDistance = 10.0;
    bool m_isGlobalCompensationEnabled = false;
    double m_lastKnownVolume = 0.0;
};

using LevelSetLiquidSolver3Ptr = std::shared_ptr<LevelSetLiquidSolver3>;

class LevelSetLiquidSolver3::Builder final
    : public GridFluidSolverBuilderBase3<Builder>
{
 public:
    [[nodiscard]] LevelSetLiquidSolver3 Build() const;

    [[nodiscard]] LevelSetLiquidSolver3Ptr MakeShared() const;
};
}  // namespace CubbyFlow

#endif