FLIPSolver3.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_SOLVER3_HPP
#define CUBBYFLOW_FLIP_SOLVER3_HPP

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

namespace CubbyFlow
{
class FLIPSolver3 : public PICSolver3
{
 public:
    class Builder;

    FLIPSolver3();

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

    FLIPSolver3(const FLIPSolver3&) = delete;

    FLIPSolver3(FLIPSolver3&&) noexcept = delete;

    ~FLIPSolver3() override = default;

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

    FLIPSolver3& operator=(FLIPSolver3&&) 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;
    Array3<double> m_uDelta;
    Array3<double> m_vDelta;
    Array3<double> m_wDelta;
};

using FLIPSolver3Ptr = std::shared_ptr<FLIPSolver3>;

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

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

#endif