LevelSetLiquidSolver2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: LevelSetLiquidSolver2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: Level set based 2-D liquid solver.
> Created Time: 2017/08/30
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_LEVEL_SET_LIQUID_SOLVER2_H
#define CUBBYFLOW_LEVEL_SET_LIQUID_SOLVER2_H

#include <Core/Solver/Grid/GridFluidSolver2.h>
#include <Core/Solver/LevelSet/LevelSetSolver2.h>

namespace CubbyFlow
{
    class LevelSetLiquidSolver2 : public GridFluidSolver2
    {
    public:
        class Builder;

        LevelSetLiquidSolver2();

        LevelSetLiquidSolver2(
            const Size2& resolution,
            const Vector2D& gridSpacing,
            const Vector2D& gridOrigin);

        virtual ~LevelSetLiquidSolver2();

        ScalarGrid2Ptr GetSignedDistanceField() const;

        LevelSetSolver2Ptr GetLevelSetSolver() const;

        void SetLevelSetSolver(const LevelSetSolver2Ptr& newSolver);

        void SetMinReinitializeDistance(double distance);

        void SetIsGlobalCompensationEnabled(bool isEnabled);

        double ComputeVolume() const;

        static Builder GetBuilder();

    protected:
        void OnBeginAdvanceTimeStep(double timeIntervalInSeconds) override;

        void OnEndAdvanceTimeStep(double timeIntervalInSeconds) override;

        void ComputeAdvection(double timeIntervalInSeconds) override;

        ScalarField2Ptr GetFluidSDF() const override;

    private:
        size_t m_signedDistanceFieldId;
        LevelSetSolver2Ptr m_levelSetSolver;
        double m_minReinitializeDistance = 10.0;
        bool m_isGlobalCompensationEnabled = false;
        double m_lastKnownVolume = 0.0;

        void Reinitialize(double currentCFL);

        void ExtrapolateVelocityToAir(double currentCFL);

        void AddVolume(double volDiff);
    };

    using LevelSetLiquidSolver2Ptr = std::shared_ptr<LevelSetLiquidSolver2>;

    class LevelSetLiquidSolver2::Builder final : public GridFluidSolverBuilderBase2<LevelSetLiquidSolver2::Builder>
    {
    public:
        LevelSetLiquidSolver2 Build() const;

        LevelSetLiquidSolver2Ptr MakeShared() const;
    };
}

#endif