1 #ifndef __CS_TURBUBELNCE_KE_H__
2 #define __CS_TURBUBELNCE_KE_H__
3 
4 /*============================================================================
5  * k-epsilon turbulence model.
6  *============================================================================*/
7 
8 /*
9   This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11   Copyright (C) 1998-2021 EDF S.A.
12 
13   This program is free software; you can redistribute it and/or modify it under
14   the terms of the GNU General Public License as published by the Free Software
15   Foundation; either version 2 of the License, or (at your option) any later
16   version.
17 
18   This program is distributed in the hope that it will be useful, but WITHOUT
19   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20   FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
21   details.
22 
23   You should have received a copy of the GNU General Public License along with
24   this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25   Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  *  Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Public function prototypes
42  *============================================================================*/
43 
44 /*----------------------------------------------------------------------------*/
45 /*!
46  * \brief Solve the k-epsilon equations.
47  *
48  * Solve the \f$ k - \varepsilon \f$  for incompressible flows
49  * or slightly compressible flows for one time step.
50  *
51  * \param[in]     ncesmp        number of cells with mass source term
52  * \param[in]     icetsm        index of cells with mass source term
53  * \param[in]     itypsm        mass source type for the variables
54  *                              size: [nvar][ncesmp]
55  * \param[in]     dt            time step (per cell)
56  * \param[in]     smacel        values of the variables associated to the
57  *                              mass source (for the pressure variable,
58  *                              smacel is the mass flux)
59  *                              size: [nvar][ncesmp]
60  * \param[out]    prdv2f        v2f production term
61  */
62 /*----------------------------------------------------------------------------*/
63 
64 void
65 cs_turbulence_ke(cs_lnum_t        ncesmp,
66                  cs_lnum_t        icetsm[],
67                  int              itypsm[],
68                  const cs_real_t *dt,
69                  cs_real_t        smacel[],
70                  cs_real_t       *prdv2f);
71 
72 /*----------------------------------------------------------------------------*/
73 
74 END_C_DECLS
75 
76 #endif /* __CS_TURBUBELNCE_KE_H__ */
77