Branch data     Line data    Source code

       1                 :            : // *****************************************************************************
       2                 :            : /*!
       3                 :            :   \file      src/PDE/EoS/StiffenedGas.hpp
       4                 :            :   \copyright 2012-2015 J. Bakosi,
       5                 :            :              2016-2018 Los Alamos National Security, LLC.,
       6                 :            :              2019-2021 Triad National Security, LLC.
       7                 :            :              All rights reserved. See the LICENSE file for details.
       8                 :            :   \brief     Stiffened-gas equation of state
       9                 :            :   \details   This file declares functions for the stiffened gas equation of
      10                 :            :              state for the compressible flow equations.
      11                 :            : */
      12                 :            : // *****************************************************************************
      13                 :            : #ifndef StiffenedGas_h
      14                 :            : #define StiffenedGas_h
      15                 :            : 
      16                 :            : #include "Data.hpp"
      17                 :            : 
      18                 :            : namespace inciter {
      19                 :            : 
      20                 :            : class StiffenedGas {
      21                 :            : 
      22                 :            :   private:
      23                 :            :     tk::real m_gamma, m_pstiff, m_cv;
      24                 :            : 
      25                 :            :   public:
      26                 :            :     //! Default constructor
      27                 :            :     StiffenedGas() = default;
      28                 :            : 
      29                 :            :     //! Constructor
      30                 :            :     StiffenedGas(tk::real gamma, tk::real pstiff, tk::real cv );
      31                 :            : 
      32                 :            :     //! Set rho0 EOS parameter. No-op.
      33                 :            :     void setRho0(tk::real) {}
      34                 :            : 
      35                 :            :     //! Calculate density from the material pressure and temperature
      36                 :            :     tk::real density( tk::real pr,
      37                 :            :                       tk::real temp ) const;
      38                 :            : 
      39                 :            :     //! Calculate pressure from the material density, momentum and total energy
      40                 :            :     tk::real pressure( tk::real arho,
      41                 :            :                        tk::real u,
      42                 :            :                        tk::real v,
      43                 :            :                        tk::real w,
      44                 :            :                        tk::real arhoE,
      45                 :            :                        tk::real alpha=1.0,
      46                 :            :                        std::size_t imat=0,
      47                 :            :       const std::array< std::array< tk::real, 3 >, 3 >& defgrad={{}}) const;
      48                 :            : 
      49                 :            :     //! \brief Calculate the Cauchy stress tensor from the material density,
      50                 :            :     //!   momentum, and total energy
      51                 :            :     std::array< std::array< tk::real, 3 >, 3 >
      52                 :            :     CauchyStress(
      53                 :            :       tk::real,
      54                 :            :       tk::real,
      55                 :            :       tk::real,
      56                 :            :       tk::real,
      57                 :            :       tk::real,
      58                 :            :       tk::real,
      59                 :            :       std::size_t,
      60                 :            :       const std::array< std::array< tk::real, 3 >, 3 >& adefgrad={{}} ) const;
      61                 :            : 
      62                 :            :     //! Calculate speed of sound from the material density and material pressure
      63                 :            :     tk::real soundspeed( tk::real arho,
      64                 :            :                          tk::real apr,
      65                 :            :                          tk::real alpha=1.0,
      66                 :            :                          std::size_t imat=0,
      67                 :            :       const std::array< std::array< tk::real, 3 >, 3 >& adefgrad={{}},
      68                 :            :       const std::array< tk::real, 3 >& asigman={{}} ) const;
      69                 :            : 
      70                 :            :     //! Calculate speed of shear waves
      71                 :            :     tk::real shearspeed(
      72                 :            :       tk::real,
      73                 :            :       tk::real,
      74                 :            :       std::size_t ) const { return 0.0; }
      75                 :            : 
      76                 :            :     //! \brief Calculate material specific total energy from the material
      77                 :            :     //!   density, momentum and material pressure
      78                 :            :     tk::real totalenergy( tk::real rho,
      79                 :            :                           tk::real u,
      80                 :            :                           tk::real v,
      81                 :            :                           tk::real w,
      82                 :            :                           tk::real pr,
      83                 :            :       const std::array< std::array< tk::real, 3 >, 3 >& defgrad={{}} ) const;
      84                 :            : 
      85                 :            :     //! \brief Calculate material temperature from the material density, and
      86                 :            :     //!   material specific total energy
      87                 :            :     tk::real temperature( tk::real arho,
      88                 :            :                           tk::real u,
      89                 :            :                           tk::real v,
      90                 :            :                           tk::real w,
      91                 :            :                           tk::real arhoE,
      92                 :            :                           tk::real alpha=1.0,
      93                 :            :       const std::array< std::array< tk::real, 3 >, 3 >& defgrad={{}} ) const;
      94                 :            : 
      95                 :            :     //! Compute the minimum allowed pressure
      96                 :            :     tk::real min_eff_pressure(
      97                 :            :       tk::real min,
      98                 :            :       tk::real,
      99                 :            :       tk::real ) const;
     100                 :            : 
     101                 :            :     //! Compute the reference density
     102                 :            :     tk::real refDensity() const { return density(refPressure(), 300.0); }
     103                 :            : 
     104                 :            :     //! Compute the reference pressure
     105                 :            :     tk::real refPressure() const { return 1.0e5; }
     106                 :            : 
     107                 :            :     //! Return initial density
     108                 :          0 :     tk::real rho0() const { return density(1.0e5, 300.0); }
     109                 :            : 
     110                 :            :     /** @name Charm++ pack/unpack serializer member functions */
     111                 :            :     ///@{
     112                 :            :     //! \brief Pack/Unpack serialize member function
     113                 :            :     //! \param[in,out] p Charm++'s PUP::er serializer object reference
     114                 :            :     void pup( PUP::er &p ) /*override*/ {
     115                 :            :       p | m_gamma;
     116                 :            :       p | m_pstiff;
     117                 :            :       p | m_cv;
     118                 :            :     }
     119                 :            :     //! \brief Pack/Unpack serialize operator|
     120                 :            :     //! \param[in,out] p Charm++'s PUP::er serializer object reference
     121                 :            :     //! \param[in,out] i StiffenedGas object reference
     122                 :            :     friend void operator|( PUP::er& p, StiffenedGas& i ) { i.pup(p); }
     123                 :            :     //@}
     124                 :            : };
     125                 :            : 
     126                 :            : } //inciter::
     127                 :            : 
     128                 :            : #endif // StiffenedGas_h