LevelSetLiquidSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: LevelSetLiquidSolver3.h
> Project Name: CubbyFlow
> Author: Dongmin Kim
> Purpose: Level set based 3-D liquid solver.
> Created Time: 2017/09/06
> Copyright (c) 2018, Dongmin Kim
*************************************************************************/
#ifndef CUBBYFLOW_LEVEL_SET_LIQUID_SOLVER3_H
#define CUBBYFLOW_LEVEL_SET_LIQUID_SOLVER3_H

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

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

        LevelSetLiquidSolver3();

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

        virtual ~LevelSetLiquidSolver3();

        ScalarGrid3Ptr GetSignedDistanceField() const;

        LevelSetSolver3Ptr GetLevelSetSolver() const;

        void SetLevelSetSolver(const LevelSetSolver3Ptr& 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;

        ScalarField3Ptr GetFluidSDF() const override;

    private:
        size_t m_signedDistanceFieldId;
        LevelSetSolver3Ptr 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 LevelSetLiquidSolver3Ptr = std::shared_ptr<LevelSetLiquidSolver3>;

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

        LevelSetLiquidSolver3Ptr MakeShared() const;
    };
}

#endif