PICSolver3.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_PIC_SOLVER3_HPP
#define CUBBYFLOW_PIC_SOLVER3_HPP

#include <Core/Emitter/ParticleEmitter3.hpp>
#include <Core/Particle/ParticleSystemData.hpp>
#include <Core/Solver/Grid/GridFluidSolver3.hpp>

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

    PICSolver3();

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

    PICSolver3(const PICSolver3&) = delete;

    PICSolver3(PICSolver3&&) noexcept = delete;

    ~PICSolver3() override = default;

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

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

    [[nodiscard]] ScalarGrid3Ptr GetSignedDistanceField() const;

    [[nodiscard]] const ParticleSystemData3Ptr& GetParticleSystemData() const;

    [[nodiscard]] const ParticleEmitter3Ptr& GetParticleEmitter() const;

    void SetParticleEmitter(const ParticleEmitter3Ptr& newEmitter);

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void OnInitialize() override;

    void OnBeginAdvanceTimeStep(double timeIntervalInSeconds) override;

    void ComputeAdvection(double timeIntervalInSeconds) override;

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

    virtual void TransferFromParticlesToGrids();

    virtual void TransferFromGridsToParticles();

    virtual void MoveParticles(double timeIntervalInSeconds);

    Array3<char> m_uMarkers;
    Array3<char> m_vMarkers;
    Array3<char> m_wMarkers;

 private:
    void ExtrapolateVelocityToAir();

    void BuildSignedDistanceField();

    void UpdateParticleEmitter(double timeIntervalInSeconds) const;

    size_t m_signedDistanceFieldID;
    ParticleSystemData3Ptr m_particles;
    ParticleEmitter3Ptr m_particleEmitter;
};

using PICSolver3Ptr = std::shared_ptr<PICSolver3>;

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

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

#endif