src/base/cs_wall_functions.h Source File

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_wall_functions.h
Go to the documentation of this file.
1 #ifndef __CS_WALL_FUNCTIONS_H__
2 #define __CS_WALL_FUNCTIONS_H__
3
4 /*============================================================================
5 * Wall functions
6 *============================================================================*/
7
8 /*
9 This file is part of Code_Saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2013 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_base.h"
35
36 /*----------------------------------------------------------------------------*/
37
38 BEGIN_C_DECLS
39
40 /*=============================================================================
41 * Local Macro definitions
42 *============================================================================*/
43
44 /*============================================================================
45 * Type definition
46 *============================================================================*/
47
48 /*============================================================================
49 * Global variables
50 *============================================================================*/
51
52 /*============================================================================
53 * Public function definitions for Fortran API
54 *============================================================================*/
55
56 /*----------------------------------------------------------------------------
57 * Compute the friction velocity and y+/u+
58 *----------------------------------------------------------------------------*/
59
60 void CS_PROCF (wallfunctions, WALLFUNCTIONS)
61 (
62 const cs_int_t *const iwallf, /* <-- wall function type */
63 const cs_int_t *const ifac, /* <-- face number */
64 const cs_real_t *const xkappa, /* <-- Von Karman constant */
65 const cs_real_t *const cstlog, /* <-- Log law constant */
66 const cs_real_t *const cmu025, /* <-- C_mu^1/4 */
67 const cs_real_t *const ypluli, /* <-- y+ limit */
68 const cs_real_t *const apow, /* <-- Coef of the Wener law */
69 const cs_real_t *const bpow, /* <-- Coef of the Wener law */
70 const cs_real_t *const cpow, /* <-- Coef of the Wener law */
71 const cs_real_t *const viscosity, /* <-- kinematic viscosity */
72 const cs_real_t *const t_visc, /* <-- turbulent kinematic viscosity */
73 const cs_real_t *const vel, /* <-- wall projected
74 cell center velocity */
75 const cs_real_t *const y, /* <-- wall distance */
76 const cs_real_t *const kinetic_en, /* <-- turbulente kinetic energy */
77 cs_int_t *iuntur, /* <-- indicator:
78 0 in the viscous sublayer */
79 cs_int_t *nsubla, /* <-- counter of cell in the viscous
80 sublayer */
81 cs_int_t *nlogla, /* <-- counter of cell in the log-layer */
82 cs_real_t *ustar, /* --> friction velocity */
83 cs_real_t *uk, /* --> friction velocity */
84 cs_real_t *yplus, /* --> non-dimension wall distance */
85 cs_real_t *ypup, /* --> yplus projected vel ratio */
86 cs_real_t *cofimp, /* --> |U_F|/|U_I^p| to ensure a good
87 turbulence production */
88 cs_real_t *dplus /* --> dimensionless shift to the wall
89 for scalable wall functions */
90 );
91
92 /*----------------------------------------------------------------------------*/
93
94 END_C_DECLS
95
96 #endif /* __CS_WALL_FUNCTIONS_H__ */