equation_of_state.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Copyright (C) 2023 by the ryujin authors
//
 
#pragma once
 
#include <compile_time_options.h>
 
#include "convenience_macros.h"
 
#include <deal.II/base/array_view.h>
#include <deal.II/base/exceptions.h>
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/tensor.h>
 
#include <string>
 
namespace ryujin
{
  namespace EquationOfStateLibrary
  {
    class EquationOfState : public dealii::ParameterAcceptor
    {
    public:
      EquationOfState(const std::string &name, const std::string &subsection)
          : ParameterAcceptor(subsection + "/" + name)
          , name_(name)
      {
        /*
         * If necessary derived EOS can override the covolume b that is
         * used in the interpolatory NASG eos.
         */
        interpolation_b_ = 0.;
 
        /*
         * If necessary derived EOS can override the reference pressure
         * that is used in the interpolatory NASG eos.
         */
        interpolation_pinfty_ = 0.;
 
        /*
         * If necessary derived EOS can override the reference specific
         * internal energy q that is used in the interpolatory NASG eos.
         */
        interpolation_q_ = 0.;
 
        /*
         * If necessary derived EOS can override this boolean to indicate
         * that the dealii::ArrayView<double> variants of the pressure()
         * function (etc.) should be preferred.
         */
        prefer_vector_interface_ = false;
      }
 
      virtual double pressure(double rho, double e) const = 0;
 
      virtual void pressure(const dealii::ArrayView<double> &p,
                            const dealii::ArrayView<double> &rho,
                            const dealii::ArrayView<double> &e) const
      {
        Assert(p.size() == rho.size() && rho.size() == e.size(),
               dealii::ExcMessage("vectors have different size"));
 
        std::transform(std::begin(rho),
                       std::end(rho),
                       std::begin(e),
                       std::begin(p),
                       [&](double rho, double e) { return pressure(rho, e); });
      }
 
      virtual double specific_internal_energy(double rho, double p) const = 0;
 
      virtual void
      specific_internal_energy(const dealii::ArrayView<double> &e,
                               const dealii::ArrayView<double> &rho,
                               const dealii::ArrayView<double> &p) const
      {
        Assert(p.size() == rho.size() && rho.size() == e.size(),
               dealii::ExcMessage("vectors have different size"));
 
        std::transform(std::begin(rho),
                       std::end(rho),
                       std::begin(p),
                       std::begin(e),
                       [&](double rho, double p) {
                         return specific_internal_energy(rho, p);
                       });
      }
 
      virtual double temperature(double rho, double e) const = 0;
 
      virtual void temperature(const dealii::ArrayView<double> &T,
                               const dealii::ArrayView<double> &rho,
                               const dealii::ArrayView<double> &e) const
      {
        Assert(T.size() == rho.size() && rho.size() == e.size(),
               dealii::ExcMessage("vectors have different size"));
 
        std::transform(
            std::begin(rho),
            std::end(rho),
            std::begin(e),
            std::begin(T),
            [&](double rho, double e) { return temperature(rho, e); });
      }
 
      virtual double speed_of_sound(double rho, double e) const = 0;
 
      virtual void speed_of_sound(const dealii::ArrayView<double> &c,
                                  const dealii::ArrayView<double> &rho,
                                  const dealii::ArrayView<double> &e) const
      {
        Assert(c.size() == rho.size() && rho.size() == e.size(),
               dealii::ExcMessage("vectors have different size"));
 
        std::transform(
            std::begin(rho),
            std::end(rho),
            std::begin(e),
            std::begin(c),
            [&](double rho, double e) { return speed_of_sound(rho, e); });
      }
 
      ACCESSOR_READ_ONLY(interpolation_b)
 
      
      ACCESSOR_READ_ONLY(interpolation_pinfty)
 
      
      ACCESSOR_READ_ONLY(interpolation_q)
 
      
      ACCESSOR_READ_ONLY(prefer_vector_interface)
 
      
      ACCESSOR_READ_ONLY(name)
 
    protected:
      double interpolation_b_;
      double interpolation_pinfty_;
      double interpolation_q_;
      bool prefer_vector_interface_;
 
    private:
      const std::string name_;
    };
 
  } // namespace EquationOfStateLibrary
} /* namespace ryujin */