GridSmokeSolver2.h

Go to the documentation of this file.

/*************************************************************************
> File Name: GridSmokeSolver2.h
> Project Name: CubbyFlow
> Author: Chan-Ho Chris Ohk
> Purpose: 2-D grid-based smoke solver.
> Created Time: 2017/08/17
> Copyright (c) 2018, Chan-Ho Chris Ohk
*************************************************************************/
#ifndef CUBBYFLOW_GRID_SMOKE_SOLVER2_H
#define CUBBYFLOW_GRID_SMOKE_SOLVER2_H

#include <Core/Solver/Grid/GridFluidSolver2.h>

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

        GridSmokeSolver2();

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

        virtual ~GridSmokeSolver2();

        double GetSmokeDiffusionCoefficient() const;

        void SetSmokeDiffusionCoefficient(double newValue);

        double GetTemperatureDiffusionCoefficient() const;

        void SetTemperatureDiffusionCoefficient(double newValue);

        double GetBuoyancySmokeDensityFactor() const;

        void SetBuoyancySmokeDensityFactor(double newValue);

        double GetBuoyancyTemperatureFactor() const;

        void SetBuoyancyTemperatureFactor(double newValue);

        double GetSmokeDecayFactor() const;

        void SetSmokeDecayFactor(double newValue);

        double GetTemperatureDecayFactor() const;

        void SetTemperatureDecayFactor(double newValue);

        ScalarGrid2Ptr GetSmokeDensity() const;

        ScalarGrid2Ptr GetTemperature() const;

        static Builder GetBuilder();

    protected:
        void OnEndAdvanceTimeStep(double timeIntervalInSeconds) override;

        void ComputeExternalForces(double timeIntervalInSeconds) override;

    private:
        size_t m_smokeDensityDataID = 0;
        size_t m_temperatureDataID = 0;
        double m_smokeDiffusionCoefficient = 0.0;
        double m_temperatureDiffusionCoefficient = 0.0;
        double m_buoyancySmokeDensityFactor = -0.000625;
        double m_buoyancyTemperatureFactor = 5.0;
        double m_smokeDecayFactor = 0.001;
        double m_temperatureDecayFactor = 0.001;

        void ComputeDiffusion(double timeIntervalInSeconds);

        void ComputeBuoyancyForce(double timeIntervalInSeconds);
    };

    using GridSmokeSolver2Ptr = std::shared_ptr<GridSmokeSolver2>;
    
    class GridSmokeSolver2::Builder final : public GridFluidSolverBuilderBase2<GridSmokeSolver2::Builder>
    {
    public:
        GridSmokeSolver2 Build() const;

        GridSmokeSolver2Ptr MakeShared() const;
    };
}

#endif