CTurbSAVariable.hpp

Go to the documentation of this file.

/*!
 * \file CTurbSAVariable.hpp
 * \brief Declaration of the variables of the SA turbulence model.
 * \author F. Palacios, 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 "CTurbVariable.hpp"
 
/*!
 * \class CTurbSAVariable
 * \brief Main class for defining the variables of the turbulence model.
 * \ingroup Turbulence_Model
 * \author A. Bueno.
 */
 
class CTurbSAVariable final : public CTurbVariable {
 
private:
  VectorType DES_LengthScale;
  VectorType lesMode;
  su2vector<int8_t> sbsInBox;
  MatrixType stochSource;
  MatrixType stochSourceOld;
  VectorType Vortex_Tilting;
  VectorType besselIntegral;
 
public:
  /*!
   * \brief Constructor of the class.
   * \param[in] val_nu_tilde - Turbulent variable value (initialization value).
   * \param[in] val_muT  - The eddy viscosity
   * \param[in] npoint - Number of points/nodes/vertices in the domain.
   * \param[in] ndim - Number of dimensions of the problem.
   * \param[in] nvar - Number of variables of the problem.
   * \param[in] constants -
   * \param[in] config - Definition of the particular problem.
   */
  CTurbSAVariable(su2double val_nu_tilde, su2double val_muT, unsigned long npoint, unsigned long ndim, unsigned long nvar, CConfig *config);
 
  /*!
   * \brief Destructor of the class.
   */
  ~CTurbSAVariable() override = default;
 
  /*!
   * \brief Get the DES length scale
   * \param[in] iPoint - Point index.
   * \return Value of the DES length Scale.
   */
  inline su2double GetDES_LengthScale(unsigned long iPoint) const override { return DES_LengthScale(iPoint); }
 
  /*!
   * \brief Set the DES Length Scale.
   * \param[in] iPoint - Point index.
   */
  inline void SetDES_LengthScale(unsigned long iPoint, su2double val_des_lengthscale) override { DES_LengthScale(iPoint) = val_des_lengthscale; }
 
  /*!
   * \brief Get the source terms for the stochastic equations.
   * \param[in] iPoint - Point index.
   * \param[in] iDim - Dimension index.
   * \return Value of the source term for the stochastic equations.
   */
  inline su2double GetLangevinSourceTerms(unsigned long iPoint, unsigned short iDim) const override { return stochSource(iPoint, iDim); }
 
  /*!
   * \brief Set the source terms for the stochastic equations.
   * \param[in] iPoint - Point index.
   * \param[in] iDim - Dimension index.
   * \param[in] val_stochSource - Value of the source term for the stochastic equations.
   */
  inline void SetLangevinSourceTerms(unsigned long iPoint, unsigned short iDim, su2double val_stochSource) override { stochSource(iPoint, iDim) = val_stochSource; }
 
  /*!
   * \brief Get the old value of the source terms for the stochastic equations.
   * \param[in] iPoint - Point index.
   * \param[in] iDim - Dimension index.
   * \return Old value of the source terms for the stochastic equations.
   */
  inline su2double GetLangevinSourceTermsOld(unsigned long iPoint, unsigned short iDim) const override { return stochSourceOld(iPoint, iDim); }
 
  /*!
   * \brief Set the old value of source terms for the stochastic equations.
   * \param[in] iPoint - Point index.
   * \param[in] iDim - Dimension index.
   * \param[in] val_stochSource_old - Old value of the source term for the stochastic equations.
   */
  inline void SetLangevinSourceTermsOld(unsigned long iPoint, unsigned short iDim, su2double val_stochSource_old) override { stochSourceOld(iPoint, iDim) = val_stochSource_old; }
 
 /*!
   * \brief Get if the Stochastic Backscatter Model must be applied only in a confined box.
   * \param[in] iPoint - Point index.
   * \return 1.0 if the Stochastic Backscatter Model must be applied only in a confined box.
   */
  inline int8_t GetSbsInBox(unsigned long iPoint) const override { return sbsInBox(iPoint); }
 
  /*!
   * \brief Set if the Stochastic Backscatter Model must be applied only in a confined box.
   * \param[in] iPoint - Point index.
   * \param[in] val_sbsInBox - 1.0 if the Stochastic Backscatter Model must be applied only in a confined box.
   */
  inline void SetSbsInBox(unsigned long iPoint, int8_t val_sbsInBox) override { sbsInBox(iPoint) = val_sbsInBox; }
 
  /*!
   * \brief Set the LES sensor.
   */
  inline void SetLES_Mode(unsigned long iPoint, su2double val_les_mode) override { lesMode(iPoint) = val_les_mode; }
 
  /*!
   * \brief Get the LES sensor.
   * \return Value of the LES sensor.
   */
  inline su2double GetLES_Mode(unsigned long iPoint) const override { return lesMode(iPoint); }
 
  /*!
   * \brief Set the vortex tilting measure for computation of the EDDES length scale
   * \param[in] iPoint - Point index.
   */
  void SetVortex_Tilting(unsigned long iPoint, CMatrixView<const su2double>,
                         const su2double* Vorticity, su2double LaminarViscosity) override;
 
  /*!
   * \brief Get the vortex tilting measure for computation of the EDDES length scale
   * \param[in] iPoint - Point index.
   * \return Value of the DES length Scale
   */
  inline su2double GetVortex_Tilting(unsigned long iPoint) const override { return Vortex_Tilting(iPoint); }
 
  /*!
   * \brief Set the integral of the product of three Bessel functions appearing in Laplacian smoothing.
   * \param[in] iPoint - Point index.
   * \param[in] val_integral - Value of the integral.
   */
  inline void SetBesselIntegral(unsigned long iPoint, su2double val_integral) override { besselIntegral(iPoint) = val_integral; }
 
  /*!
   * \brief Get the the integral of the product of three Bessel functions appearing in Laplacian smoothing.
   * \return Value of the integral.
   */
  inline su2double GetBesselIntegral(unsigned long iPoint) const override { return besselIntegral(iPoint); }
 
};