GridSmokeSolver3.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_GRID_SMOKE_SOLVER3_HPP
#define CUBBYFLOW_GRID_SMOKE_SOLVER3_HPP

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

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

    GridSmokeSolver3();

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

    GridSmokeSolver3(const GridSmokeSolver3&) = delete;

    GridSmokeSolver3(GridSmokeSolver3&&) noexcept = delete;

    ~GridSmokeSolver3() override = default;

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

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

    [[nodiscard]] double GetSmokeDiffusionCoefficient() const;

    void SetSmokeDiffusionCoefficient(double newValue);

    [[nodiscard]] double GetTemperatureDiffusionCoefficient() const;

    void SetTemperatureDiffusionCoefficient(double newValue);

    [[nodiscard]] double GetBuoyancySmokeDensityFactor() const;

    void SetBuoyancySmokeDensityFactor(double newValue);

    [[nodiscard]] double GetBuoyancyTemperatureFactor() const;

    void SetBuoyancyTemperatureFactor(double newValue);

    [[nodiscard]] double GetSmokeDecayFactor() const;

    void SetSmokeDecayFactor(double newValue);

    [[nodiscard]] double GetTemperatureDecayFactor() const;

    void SetTemperatureDecayFactor(double newValue);

    [[nodiscard]] ScalarGrid3Ptr GetSmokeDensity() const;

    [[nodiscard]] ScalarGrid3Ptr GetTemperature() const;

    [[nodiscard]] static Builder GetBuilder();

 protected:
    void OnEndAdvanceTimeStep(double timeIntervalInSeconds) override;

    void ComputeExternalForces(double timeIntervalInSeconds) override;

 private:
    void ComputeDiffusion(double timeIntervalInSeconds);

    void ComputeBuoyancyForce(double timeIntervalInSeconds);

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

using GridSmokeSolver3Ptr = std::shared_ptr<GridSmokeSolver3>;

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

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

#endif