GridSmokeSolver3.h

Go to the documentation of this file.

/*************************************************************************
> File Name: GridSmokeSolver3.h
> Project Name: CubbyFlow
> Author: Dongmin Kim
> Purpose: 3-D grid-based smoke solver.
> Created Time: 2017/08/18
> Copyright (c) 2018, Dongmin Kim
*************************************************************************/
#ifndef CUBBYFLOW_GRID_SMOKE_SOLVER3_H
#define CUBBYFLOW_GRID_SMOKE_SOLVER3_H

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

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

        GridSmokeSolver3();

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

        virtual ~GridSmokeSolver3();

        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);

        ScalarGrid3Ptr GetSmokeDensity() const;

        ScalarGrid3Ptr 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 GridSmokeSolver3Ptr = std::shared_ptr<GridSmokeSolver3>;

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

        GridSmokeSolver3Ptr MakeShared() const;
    };
}

#endif