CFluidModel.hpp

Go to the documentation of this file.

/*!
 * \file CFluidModel.hpp
 * \brief Defines the main fluid model class for thermophysical properties.
 * \author S. Vitale, G. Gori, M. Pini, A. Guardone, P. Colonna, T. Economon
 * \version 8.5.0 "Harrier"
 *
 * SU2 Project Website: https://su2code.github.io
 *
 * The SU2 Project is maintained by the SU2 Foundation
 * (http://su2foundation.org)
 *
 * Copyright 2012-2026, SU2 Contributors (cf. AUTHORS.md)
 *
 * SU2 is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * SU2 is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with SU2. If not, see <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <cmath>
#include <memory>
 
#include "../../../Common/include/CConfig.hpp"
#include "../../../Common/include/basic_types/datatype_structure.hpp"
#include "CConductivityModel.hpp"
#include "CViscosityModel.hpp"
#include "CDiffusivityModel.hpp"
 
using namespace std;
 
class CLookUpTable;
/*!
 * \class CFluidModel
 * \brief Main class for defining the Thermo-Physical Model
 * \author: S.Vitale, G.Gori, M.Pini, T. Economon
 */
class CFluidModel {
 protected:
  su2double StaticEnergy{0.0};     /*!< \brief Internal Energy. */
  su2double Enthalpy{0.0};         /*!<*\brief Enthalpy. */
  su2double Entropy{0.0};          /*!< \brief Entropy. */
  su2double Density{0.0};          /*!< \brief Density. */
  su2double Pressure{0.0};         /*!< \brief Pressure. */
  su2double SoundSpeed2{0.0};      /*!< \brief SpeedSound. */
  su2double Temperature{0.0};      /*!< \brief Temperature. */
  su2double dPdrho_e{0.0};         /*!< \brief DpDd_e. */
  su2double dPde_rho{0.0};         /*!< \brief DpDe_d. */
  su2double dTdrho_e{0.0};         /*!< \brief DTDd_e. */
  su2double dTde_rho{0.0};         /*!< \brief DTDe_d. */
  su2double dhdrho_P{0.0};         /*!< \brief DhDrho_p. */
  su2double dhdP_rho{0.0};         /*!< \brief DhDp_rho. */
  su2double dsdrho_P{0.0};         /*!< \brief DsDrho_p. */
  su2double dsdP_rho{0.0};         /*!< \brief DsDp_rho. */
  su2double Cp{0.0};               /*!< \brief Specific Heat Capacity at constant pressure. */
  su2double Cv{0.0};               /*!< \brief Specific Heat Capacity at constant volume. */
  su2double Mu{0.0};               /*!< \brief Laminar viscosity. */
  su2double Mu_Turb{0.0};          /*!< \brief Eddy viscosity provided by a turbulence model. */
  su2double dmudrho_T{0.0};        /*!< \brief Partial derivative of viscosity w.r.t. density. */
  su2double dmudT_rho{0.0};        /*!< \brief Partial derivative of viscosity w.r.t. temperature. */
  su2double Kt{0.0};               /*!< \brief Thermal conductivity. */
  su2double dktdrho_T{0.0};        /*!< \brief Partial derivative of conductivity w.r.t. density. */
  su2double dktdT_rho{0.0};        /*!< \brief Partial derivative of conductivity w.r.t. temperature. */
  su2double mass_diffusivity{0.0}; /*!< \brief Mass Diffusivity */
 
  unique_ptr<CViscosityModel> LaminarViscosity;       /*!< \brief Laminar Viscosity Model */
  unique_ptr<CConductivityModel> ThermalConductivity; /*!< \brief Thermal Conductivity Model */
  unique_ptr<CDiffusivityModel> MassDiffusivity;      /*!< \brief Mass Diffusivity Model */
 
  /*!
   * \brief Instantiate the right type of viscosity model based on config.
   */
  static unique_ptr<CViscosityModel> MakeLaminarViscosityModel(const CConfig* config, unsigned short iSpecies);
 
  /*!
   * \brief Instantiate the right type of conductivity model based on config.
   */
  static unique_ptr<CConductivityModel> MakeThermalConductivityModel(const CConfig* config, unsigned short iSpecies);
 
  /*!
   * \brief Instantiate the right type of mass diffusivity model based on config.
   */
  static unique_ptr<CDiffusivityModel> MakeMassDiffusivityModel(const CConfig* config, unsigned short iSpecies);
 
 public:
  virtual ~CFluidModel() {}
 
  /*!
   * \brief Get fluid pressure.
   */
  su2double GetPressure() const { return Pressure; }
 
  /*!
   * \brief Get fluid temperature.
   */
  su2double GetTemperature() const { return Temperature; }
 
  /*!
   * \brief Get fluid entropy.
   */
  su2double GetEntropy() const { return Entropy; }
 
  /*!
   * \brief Get fluid internal energy.
   */
  su2double GetStaticEnergy() const { return StaticEnergy; }
 
  /*!
   * \brief Get fluid enthalpy.
   */
  su2double GetEnthalpy() const { return Enthalpy; }
 
  /*!
   * \brief Get fluid density.
   */
  su2double GetDensity() const { return Density; }
 
  /*!
   * \brief Get fluid speed of sound.
   */
  su2double GetSoundSpeed() const { return sqrt(SoundSpeed2); }
 
  /*!
   * \brief Get fluid speed of sound squared.
   */
  su2double GetSoundSpeed2() const { return SoundSpeed2; }
 
  /*!
   * \brief Get fluid specific heat at constant pressure.
   */
  su2double GetCp() const { return Cp; }
 
  /*!
   * \brief Get fluid specific heat at constant volume.
   */
  su2double GetCv() const { return Cv; }
 
  /*!
   * \brief Flamelet LUT - Get the number of transported scalars.
   */
  virtual inline unsigned short GetNScalars() const { return 0; }
 
  /*!
   * \brief Evaluate data-set for flamelet or data-driven fluid simulations.
   * \param[in] input_scalar - data manifold query data.
   * \param[in] lookup_type - look-up operation to be performed.
   * \param[in] output_refs - output variables where interpolated results are stored.
   * \param[out] Extrapolation - query data is within manifold bounds (0) or out of bounds (1).
   */
  virtual unsigned long EvaluateDataSet(const vector<su2double>& input_scalar, unsigned short lookup_type,
                                        vector<su2double>& output_refs) {
    return 0;
  }
 
  /*!
   * \brief Get fluid dynamic viscosity.
   */
  inline virtual su2double GetLaminarViscosity() {
    LaminarViscosity->SetViscosity(Temperature, Density);
    Mu = LaminarViscosity->GetViscosity();
    dmudrho_T = LaminarViscosity->Getdmudrho_T();
    dmudT_rho = LaminarViscosity->GetdmudT_rho();
    return Mu;
  }
 
  /*!
   * \brief Get fluid thermal conductivity.
   */
  inline virtual su2double GetThermalConductivity() {
    ThermalConductivity->SetConductivity(Temperature, Density, Mu, Mu_Turb, Cp, dmudrho_T, dmudT_rho);
    Kt = ThermalConductivity->GetConductivity();
    dktdrho_T = ThermalConductivity->Getdktdrho_T();
    dktdT_rho = ThermalConductivity->GetdktdT_rho();
    return Kt;
  }
 
  /*!
   * \brief Get fluid mass diffusivity.
   */
  inline virtual su2double GetMassDiffusivity(int iVar) {
    MassDiffusivity->SetDiffusivity(Density, Mu, Cp, Kt);
    mass_diffusivity = MassDiffusivity->GetDiffusivity();
    return mass_diffusivity;
  }
 
  /*!
   * \brief Get the enthalpy diffusivity terms for all species being solved.
   *
   * This function computes and retrieves the enthalpy diffusion terms required in the energy equation
   * for multicomponent flows.
   *
   * \param[in,out] enthalpy_diffusions - Array containing the enthalpy diffusion terms for all
   * species to be solved. The size of \p enthalpy_diffusions must be at least (n_species_mixture - 1),
   * corresponding to the number of species transport equations in the system.
   */
  virtual void GetEnthalpyDiffusivity(su2double* enthalpy_diffusions = nullptr) const {}
 
  /*!
   * \brief Get the gradient of enthalpy diffusivity terms for all species being solved.
   *
   * This function computes and retrieves the gradient of the enthalpy diffusion terms with respect to temperature.
   * These terms are required for implicit computations when solving the energy equation for multicomponent flows.
   *
   * \param[in,out] grad_enthalpy_diffusions - Array containing the gradient of enthalpy diffusion terms for all
   * species to be solved. The size of \p grad_enthalpy_diffusions must be at least (n_species_mixture - 1),
   * corresponding to the number of species transport equations in the system.
   */
  virtual void GetGradEnthalpyDiffusivity(su2double* grad_enthalpy_diffusions = nullptr) const {}
 
  /*!
   * \brief Get fluid pressure partial derivative.
   */
  su2double GetdPdrho_e() const { return dPdrho_e; }
 
  /*!
   * \brief Get fluid pressure partial derivative.
   */
  su2double GetdPde_rho() const { return dPde_rho; }
 
  /*!
   * \brief Get fluid temperature partial derivative.
   */
  su2double GetdTdrho_e() const { return dTdrho_e; }
 
  /*!
   * \brief Get fluid temperature partial derivative.
   */
  su2double GetdTde_rho() const { return dTde_rho; }
 
  /*!
   * \brief Get fluid enthalpy partial derivative.
   */
  su2double Getdhdrho_P() const { return dhdrho_P; }
 
  /*!
   * \brief Get fluid enthalpy partial derivative.
   */
  su2double GetdhdP_rho() const { return dhdP_rho; }
 
  /*!
   * \brief Get fluid entropy partial derivative.
   */
  su2double Getdsdrho_P() const { return dsdrho_P; }
 
  /*!
   * \brief Get fluid entropy partial derivative.
   */
  su2double GetdsdP_rho() const { return dsdP_rho; }
 
  /*!
   * \brief Get fluid dynamic viscosity partial derivative.
   */
  su2double Getdmudrho_T() { return LaminarViscosity->Getdmudrho_T(); }
 
  /*!
   * \brief Get fluid dynamic viscosity partial derivative.
   */
  su2double GetdmudT_rho() { return LaminarViscosity->GetdmudT_rho(); }
 
  /*!
   * \brief Get fluid thermal conductivity partial derivative.
   */
  su2double Getdktdrho_T() const { return dktdrho_T; }
 
  /*!
   * \brief Get fluid thermal conductivity partial derivative.
   */
  su2double GetdktdT_rho() const { return dktdT_rho; }
 
  /*!
   * \brief Set specific heat Cp model.
   */
  virtual void SetCpModel(const CConfig* config, su2double val_Temperature_Ref) {}
 
  /*!
   * \brief Set viscosity model.
   */
  virtual void SetLaminarViscosityModel(const CConfig* config);
 
  /*!
   * \brief Set thermal conductivity model.
   */
  virtual void SetThermalConductivityModel(const CConfig* config);
 
  /*!
   * \brief Set mass diffusivity model.
   */
  virtual void SetMassDiffusivityModel(const CConfig* config);
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("e, rho").
   * \param[in] rho - first thermodynamic variable.
   * \param[in] e - second thermodynamic variable.
   */
  virtual void SetTDState_rhoe(su2double rho, su2double e) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("PT").
   * \param[in] th1 - first thermodynamic variable (P).
   * \param[in] th2 - second thermodynamic variable (T).
   */
  virtual void SetTDState_PT(su2double P, su2double T) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("Pv").
   * \param[in] th1 - first thermodynamic variable (P).
   * \param[in] th2 - second thermodynamic variable (v).
   */
  virtual void SetTDState_Prho(su2double P, su2double rho) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("Pv").
   * \param[in] th1 - first thermodynamic variable (P).
   * \param[in] th2 - second thermodynamic variable (v).
   *
   */
  virtual void SetEnergy_Prho(su2double P, su2double rho) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("hs").
   * \param[in] th1 - first thermodynamic variable (h).
   * \param[in] th2 - second thermodynamic variable (s).
   *
   */
  virtual void SetTDState_hs(su2double h, su2double s) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("rhoT").
   * \param[in] th1 - first thermodynamic variable (rho).
   * \param[in] th2 - second thermodynamic variable (T).
   *
   */
  virtual void SetTDState_rhoT(su2double rho, su2double T) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("Pv").
   * \param[in] th1 - first thermodynamic variable (P).
   * \param[in] th2 - second thermodynamic variable (s).
   */
  virtual void SetTDState_Ps(su2double P, su2double s) {}
 
  /*!
   * \brief virtual member that would be different for each gas model implemented
   * \param[in] InputSpec - Input pair for FLP calls ("Pv").
   * \param[in] th1 - first thermodynamic variable (P).
   * \param[in] th2 - second thermodynamic variable (v).
   */
  virtual void ComputeDerivativeNRBC_Prho(su2double P, su2double rho) {}
 
  /*!
   * \brief Virtual member.
   * \param[in] T - Temperature value at the point.
   */
  virtual void SetTDState_T(su2double val_Temperature, const su2double* val_scalars = nullptr) {}
 
  /*!
   * \brief Virtual member.
   * \param[in] val_enthalpy - Enthalpy value at the point.
   * \param[in] val_scalars - Scalar mass fractions.
   */
  virtual void SetTDState_h(su2double val_enthalpy, const su2double* val_scalars = nullptr) {}
 
  /*!
   * \brief Set fluid eddy viscosity provided by a turbulence model needed for computing effective thermal conductivity.
   */
  void SetEddyViscosity(su2double val_Mu_Turb) { Mu_Turb = val_Mu_Turb; }
 
  /*!
   * \brief Set the thermodynamic pressure of the incompressible fluid models.
   */
  void SetPressure(su2double val_pressure) { Pressure = val_pressure; }
 
  /*!
   * \brief Get fluid model extrapolation instance
   * \return Query point lies outside fluid model data range.
   */
  virtual unsigned long GetExtrapolation() const { return 0; }
 
  /*!
   * \brief Get the state of the Preferential diffusion model for flamelet simulations.
   * \return True if preferential diffusion model is active, false otherwise.
   */
  virtual bool GetPreferentialDiffusion() const { return false; }
 
  /*!
   * \brief Get number of Newton solver iterations.
   * \return Newton solver iteration count at termination.
   */
  virtual unsigned long GetnIter_Newton() { return 0; }
};