cs_cdo_turbulence.h

Go to the documentation of this file.

#ifndef CS_CDO_TURBULENCE_H
#define CS_CDO_TURBULENCE_H
 
/*============================================================================
 * Functions to handle the resolution of the turbulence modelling
 *============================================================================*/
 
/*
  This file is part of code_saturne, a general-purpose CFD tool.
 
  Copyright (C) 1998-2026 EDF S.A.
 
  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License as published by the Free Software
  Foundation; either version 2 of the License, or (at your option) any later
  version.
 
  This program 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 General Public License for more
  details.
 
  You should have received a copy of the GNU General Public License along with
  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
  Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
 
/*----------------------------------------------------------------------------
 *  Local headers
 *----------------------------------------------------------------------------*/
 
#include "base/cs_field.h"
#include "base/cs_param_types.h"
#include "base/cs_reducers.h"
#include "base/cs_time_step.h"
#include "cdo/cs_cdo_connect.h"
#include "cdo/cs_cdo_quantities.h"
#include "cdo/cs_equation.h"
#include "cdo/cs_property.h"
#include "mesh/cs_mesh.h"
#include "turb/cs_turbulence_model.h"
 
/*============================================================================
 * Macro definitions
 *============================================================================*/
 
#define CS_NAVSTO_TOTAL_VISCOSITY    "total_viscosity"
#define CS_NAVSTO_LAM_VISCOSITY      "laminar_viscosity"
#define CS_NAVSTO_TURB_VISCOSITY     "turbulent_viscosity"
 
/*============================================================================
 * Type definitions
 *============================================================================*/
 
typedef struct {
 
  cs_turb_model_t            *model;
 
  cs_turb_rans_model_t       *rans_param;
 
  cs_turb_les_model_t        *les_param;
 
  cs_turb_ref_values_t       *reference_values;
 
  bool shared_from_legacy;
 
} cs_turbulence_param_t;
 
typedef struct _cs_turbulence_t cs_turbulence_t;
 
/*============================================================================
 * Function pointer definition
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void *
(cs_turb_init_context_t)(const cs_turb_model_t   *tbm);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void *
(cs_turb_free_context_t)(void     *turb_context);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_turb_compute_t)(const cs_mesh_t            *mesh,
                    const cs_cdo_connect_t     *connect,
                    const cs_cdo_quantities_t  *quant,
                    const cs_time_step_t       *time_step,
                    cs_turbulence_t            *tbs);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
typedef void
(cs_turb_update_t)(const cs_mesh_t                *mesh,
                   const cs_cdo_connect_t         *connect,
                   const cs_cdo_quantities_t      *quant,
                   const cs_time_step_t           *time_step,
                   const cs_turbulence_t          *tbs);
 
struct _cs_turbulence_t {
 
  cs_turbulence_param_t     *param;
 
  cs_equation_t             *mom_eq;
 
  cs_property_t              *rho;
 
  cs_property_t              *mu_tot;
 
  cs_property_t              *mu_l;
 
  cs_property_t              *mu_t;
 
  cs_real_t                  *mu_tot_array;
 
  /* \var mu_t_field
   * Field related to the turbulent viscosity
   */
 
  cs_field_t                 *mu_t_field;
 
  cs_field_t                 *rij;
 
  void                         *context;
 
  cs_turb_init_context_t       *init_context;
 
  cs_turb_free_context_t       *free_context;
 
  cs_turb_compute_t            *compute;
 
  cs_turb_compute_t            *compute_steady;
 
  cs_turb_update_t             *update;
 
  /*----------------------------------------------------------------------------*/
  /*----------------------------------------------------------------------------*/
 
  void
  add_boundary_stress(const cs_mesh_t *m, cs_field_t *boundary_stress) const;
 
  /*----------------------------------------------------------------------------*/
  /*----------------------------------------------------------------------------*/
 
  void
  check_convergence(const cs_cdo_quantities_t   *quant,
                    const cs_time_step_t        *ts,
                    const cs_param_psteady_t    &psp,
                    cs_cdo_navsto_psteady_cvg_t &ps_cvg) const;
};
 
/*============================================================================
 * Public function prototypes
 *============================================================================*/
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Allocate the structure storing the set of parameters for the
 *         turbulence modelling
 *
 * \return a pointer to a new allocated cs_turbulence_param_t structure
 */
/*----------------------------------------------------------------------------*/
 
cs_turbulence_param_t *
cs_turbulence_param_create(void);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Allocate the structure managing the turbulence modelling
 *
 * \param[in] tbp       pointer to a \ref cs_turbulence_param_t structure
 *
 * \return a pointer to a new allocated cs_turbulence_t structure
 */
/*----------------------------------------------------------------------------*/
 
cs_turbulence_t *
cs_turbulence_create(cs_turbulence_param_t    *tbp);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Free the structure managing the turbulence modelling
 *
 * \param[in, out]  p_turb_struct   pointer to the structure to free
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turbulence_free(cs_turbulence_t   **p_turb_struct);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Initialize the structure managing the turbulence modelling
 *
 * \param[in, out]  tbs     pointer to the structure to initialize
 * \param[in]       mom_eq  pointer to the structure mom_eq
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turbulence_init_setup(cs_turbulence_t     *tbs,
                         cs_equation_t       *mom_eq);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Finalize the setup of the turbulence modelling and especially the
 *         equations/properties and other related quantities
 *
 * \param[in]      mesh       pointer to a \ref cs_mesh_t structure
 * \param[in]      connect    pointer to a cs_cdo_connect_t structure
 * \param[in]      quant      pointer to a cs_cdo_quantities_t structure
 * \param[in]      time_step  pointer to a cs_time_step_t structure
 * \param[in, out] tbs        pointer to the turbulence main structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turbulence_finalize_setup(const cs_mesh_t            *mesh,
                             const cs_cdo_connect_t     *connect,
                             const cs_cdo_quantities_t  *quant,
                             const cs_time_step_t       *time_step,
                             cs_turbulence_t            *tbs);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Indicate whether use Legacy solved turbulent viscosity
 * \param[in, out] tbs        pointer to the turbulence main structure
 * \param[in]      is_shared  boolean parameter to set
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turbulence_set_shared_from_fv(cs_turbulence_t *tbs, bool is_shared);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Initialize the values of quantities related to a turbulence model.
 *
 * \param[in]      mesh       pointer to a \ref cs_mesh_t structure
 * \param[in]      connect    pointer to a cs_cdo_connect_t structure
 * \param[in]      quant      pointer to a cs_cdo_quantities_t structure
 * \param[in]      time_step  pointer to a cs_time_step_t structure
 * \param[in, out] tbs        pointer to the turbulence main structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turbulence_init_values(const cs_mesh_t             *mesh,
                          const cs_cdo_connect_t      *connect,
                          const cs_cdo_quantities_t   *quant,
                          const cs_time_step_t        *time_step,
                          cs_turbulence_t             *tbs);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Allocate and initialize the context structure related to the
 *         k-epsilon turbulence model
 *
 * \param[in]  tbm         structure which defines the turbulence model
 *
 * \return a pointer to a new allocated context structure
 */
/*----------------------------------------------------------------------------*/
 
void *
cs_turb_init_k_eps_context(const cs_turb_model_t      *tbm);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Free the context structure related to the k-epsilon turbulence model
 *
 * \param[in, out]  tbc   pointer to a structure context cast on-the-fly
 *
 * \return a null pointer
 */
/*----------------------------------------------------------------------------*/
 
void *
cs_turb_free_k_eps_context(void     *tbc);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Compute for the current time step the new state for the turbulence
 *         model. This means that all related equations are built and then
 *         solved.
 *
 * \param[in]      mesh       pointer to a \ref cs_mesh_t structure
 * \param[in]      connect    pointer to a cs_cdo_connect_t structure
 * \param[in]      quant      pointer to a cs_cdo_quantities_t structure
 * \param[in]      time_step  structure managing the time stepping
 * \param[in, out] tbs        pointer to turbulence structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turb_compute_k_eps(const cs_mesh_t            *mesh,
                      const cs_cdo_connect_t     *connect,
                      const cs_cdo_quantities_t  *quant,
                      const cs_time_step_t       *time_step,
                      cs_turbulence_t            *tbs);
 
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Update for the current time step the new state for the turbulence
 *         model. This is used to update the turbulent viscosity.
 *
 * \param[in]      mesh       pointer to a \ref cs_mesh_t structure
 * \param[in]      connect    pointer to a cs_cdo_connect_t structure
 * \param[in]      quant      pointer to a cs_cdo_quantities_t structure
 * \param[in]      time_step  structure managing the time stepping
 * \param[in]      tbs        pointer to a \ref cs_turbulence_t structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turb_update_k_eps(const cs_mesh_t              *mesh,
                     const cs_cdo_connect_t       *connect,
                     const cs_cdo_quantities_t    *quant,
                     const cs_time_step_t         *time_step,
                     const cs_turbulence_t        *tbs);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief  Update for the current time step the new state for the turbulence
 *         model. directly update the turbulent viscosity from Legacy.
 *
 * \param[in]      mesh       pointer to a \ref cs_mesh_t structure
 * \param[in]      connect    pointer to a cs_cdo_connect_t structure
 * \param[in]      quant      pointer to a cs_cdo_quantities_t structure
 * \param[in]      time_step  structure managing the time stepping
 * \param[in]      tbs        pointer to a \ref cs_turbulence_t structure
 */
/*----------------------------------------------------------------------------*/
 
void
cs_turb_update_shared_legacy(const cs_mesh_t           *mesh,
                             const cs_cdo_connect_t    *connect,
                             const cs_cdo_quantities_t *quant,
                             const cs_time_step_t      *time_step,
                             const cs_turbulence_t     *tbs);
 
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
 
void
cs_turb_compute_wall_bc_coeffs(const cs_equation_param_t  *eqp,
                               const double                nu,
                               const double                k,
                               const double                hfc,
                               const double                uct,
                               const double                uft,
                               cs_real_t                  *ht,
                               cs_real_t                  *f_w);
 
/*----------------------------------------------------------------------------*/
/*
 * \brief Return true if a wall function is used for turbulence.
 *
 * \param[in] turbulence  pointer to a cs_turbulence_param_t
 *
 *\return true or false
 */
/*----------------------------------------------------------------------------*/
 
bool
cs_turb_wall_functions_is_activated(const cs_turbulence_param_t *turbulence);
 
#endif /* CS_CDO_TURBULENCE_H */