PICSolver3.h

Go to the documentation of this file.

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

#include <Core/Emitter/ParticleEmitter3.h>
#include <Core/Particle/ParticleSystemData3.h>
#include <Core/Solver/Grid/GridFluidSolver3.h>

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

        PICSolver3();

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

        virtual ~PICSolver3();

        ScalarGrid3Ptr GetSignedDistanceField() const;

        const ParticleSystemData3Ptr& GetParticleSystemData() const;

        const ParticleEmitter3Ptr& GetParticleEmitter() const;

        void SetParticleEmitter(const ParticleEmitter3Ptr& newEmitter);

        static Builder GetBuilder();

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

        void OnInitialize() override;

        void OnBeginAdvanceTimeStep(double timeIntervalInSeconds) override;

        void ComputeAdvection(double timeIntervalInSeconds) override;

        ScalarField3Ptr GetFluidSDF() const override;

        virtual void TransferFromParticlesToGrids();

        virtual void TransferFromGridsToParticles();

        virtual void MoveParticles(double timeIntervalInSeconds);

    private:
        size_t m_signedDistanceFieldID;
        ParticleSystemData3Ptr m_particles;
        ParticleEmitter3Ptr m_particleEmitter;

        void ExtrapolateVelocityToAir() const;

        void BuildSignedDistanceField();

        void UpdateParticleEmitter(double timeIntervalInSeconds) const;
    };

    using PICSolver3Ptr = std::shared_ptr<PICSolver3>;

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

        PICSolver3Ptr MakeShared() const;
    };
}

#endif