MPMFluidConstitutiveModel.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_MPM_FLUID_CONSTITUTIVE_MODEL_HPP
#define CUBBYFLOW_MPM_FLUID_CONSTITUTIVE_MODEL_HPP
 
#include <Core/Matrix/Matrix.hpp>
#include <Core/Utils/Constants.hpp>
 
#include <cstddef>
 
namespace CubbyFlow
{
template <size_t N>
class MPMFluidConstitutiveModel final
{
 public:
    static_assert(N == 2 || N == 3,
                  "MPM fluid model supports only 2-D and 3-D.");
 
    using MatrixType = Matrix<double, N, N>;
 
    explicit MPMFluidConstitutiveModel(double targetDensity = WATER_DENSITY,
                                       double speedOfSound = 100.0,
                                       double eosExponent = 7.0,
                                       double negativePressureScale = 0.0);
 
    [[nodiscard]] double GetTargetDensity() const;
 
    [[nodiscard]] double GetSpeedOfSound() const;
 
    [[nodiscard]] double GetEosExponent() const;
 
    [[nodiscard]] double GetNegativePressureScale() const;
 
    [[nodiscard]] double ComputeDensity(double mass,
                                        double currentVolume) const;
 
    [[nodiscard]] double ComputePressure(double density) const;
 
    [[nodiscard]] MatrixType ComputeCauchyStress(double pressure) const;
 
 private:
    double m_targetDensity;
    double m_speedOfSound;
    double m_eosExponent;
    double m_negativePressureScale;
    double m_eosScale;
};
 
using MPMFluidConstitutiveModel2 = MPMFluidConstitutiveModel<2>;
using MPMFluidConstitutiveModel3 = MPMFluidConstitutiveModel<3>;
}  // namespace CubbyFlow
 
#include <Core/Particle/MPM/MPMFluidConstitutiveModel-Impl.hpp>
 
#endif