cs_cdo_turbulence.h

Go to the documentation of this file.

#ifndef __CS_CDO_TURBULENCE_H__
#define __CS_CDO_TURBULENCE_H__

/*============================================================================
 * Routines to handle the resolution of the turbulence modelling
 *============================================================================*/

/*
  This file is part of Code_Saturne, a general-purpose CFD tool.

  Copyright (C) 1998-2021 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 "cs_cdo_connect.h"
#include "cs_cdo_quantities.h"
#include "cs_field.h"
#include "cs_mesh.h"
#include "cs_property.h"
#include "cs_time_step.h"
#include "cs_turbulence_model.h"

/*----------------------------------------------------------------------------*/

BEGIN_C_DECLS

/*============================================================================
 * 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;

} cs_turbulence_param_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_turbulence_param_t    *tbp,
                    void                           *tbc);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

typedef void
(cs_turb_update_t)(const cs_mesh_t                *mesh,
                   const cs_time_step_t           *time_step,
                   const cs_cdo_connect_t         *connect,
                   const cs_cdo_quantities_t      *cdoq,
                   const cs_turbulence_param_t    *tbp,
                   void                           *tbc);

typedef struct {

  cs_turbulence_param_t     *param;

  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_update_t            *update;

} cs_turbulence_t;

/*============================================================================
 * Public function prototypes
 *============================================================================*/

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_turbulence_param_t *
cs_turbulence_param_create(void);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

cs_turbulence_t *
cs_turbulence_create(cs_turbulence_param_t    *tbp);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_turbulence_free(cs_turbulence_t   **p_turb_struct);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_turbulence_init_setup(cs_turbulence_t   *turb);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

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);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_turbulence_initialize(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);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void *
cs_turb_init_k_eps_context(const cs_turb_model_t      *tbm);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void *
cs_turb_free_k_eps_context(void     *tbc);

/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/

void
cs_turb_compute_k_eps(const cs_mesh_t              *mesh,
                      const cs_turbulence_param_t  *tpb,
                      void                         *tbc);

/*----------------------------------------------------------------------------*/

END_C_DECLS

#endif /* __CS_CDO_TURBULENCE_H__ */