FLIPSolver2.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_FLIP_SOLVER2_HPP
#define CUBBYFLOW_FLIP_SOLVER2_HPP

#include <Core/Solver/Hybrid/PIC/PICSolver2.hpp>

namespace CubbyFlow
{
class FLIPSolver2 : public PICSolver2
{
 public:
    class Builder;

    FLIPSolver2();

    FLIPSolver2(const Vector2UZ& resolution, const Vector2D& gridSpacing,
                const Vector2D& gridOrigin);

    FLIPSolver2(const FLIPSolver2&) = delete;

    FLIPSolver2(FLIPSolver2&&) noexcept = delete;

    ~FLIPSolver2() override = default;

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

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

    [[nodiscard]] double GetPICBlendingFactor() const;

    void SetPICBlendingFactor(double factor);

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void TransferFromParticlesToGrids() override;

    void TransferFromGridsToParticles() override;

 private:
    double m_picBlendingFactor = 0.0;
    Array2<double> m_uDelta;
    Array2<double> m_vDelta;
};

using FLIPSolver2Ptr = std::shared_ptr<FLIPSolver2>;

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

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

#endif