PICSolver2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: PICSolver2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 2-D Particle-in-Cell (PIC) implementation.
> Created Time: 2017/09/12
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_PIC_SOLVER2_H
#define CUBBYFLOW_PIC_SOLVER2_H

#include <Core/Emitter/ParticleEmitter2.h>
#include <Core/Particle/ParticleSystemData2.h>
#include <Core/Solver/Grid/GridFluidSolver2.h>

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

        PICSolver2();

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

        virtual ~PICSolver2();

        ScalarGrid2Ptr GetSignedDistanceField() const;

        const ParticleSystemData2Ptr& GetParticleSystemData() const;

        const ParticleEmitter2Ptr& GetParticleEmitter() const;

        void SetParticleEmitter(const ParticleEmitter2Ptr& newEmitter);

        static Builder GetBuilder();

    protected:
        Array2<char> m_uMarkers;
        Array2<char> m_vMarkers;

        void OnInitialize() override;

        void OnBeginAdvanceTimeStep(double timeIntervalInSeconds) override;

        void ComputeAdvection(double timeIntervalInSeconds) override;

        ScalarField2Ptr GetFluidSDF() const override;

        virtual void TransferFromParticlesToGrids();

        virtual void TransferFromGridsToParticles();

        virtual void MoveParticles(double timeIntervalInSeconds);

    private:
        size_t m_signedDistanceFieldID;
        ParticleSystemData2Ptr m_particles;
        ParticleEmitter2Ptr m_particleEmitter;

        void ExtrapolateVelocityToAir() const;

        void BuildSignedDistanceField();

        void UpdateParticleEmitter(double timeIntervalInSeconds) const;
    };

    using PICSolver2Ptr = std::shared_ptr<PICSolver2>;

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

        PICSolver2Ptr MakeShared() const;
    };
}

#endif