programmer's documentation
cs_lagr_deposition_model.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_DEPOSITION_MODEL_H__
2 #define __CS_LAGR_DEPOSITION_MODEL_H__
3 
4 /*============================================================================
5  * Functions and types for the Lagrangian module
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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 
33 
34 /*============================================================================
35  * Public function prototypes
36  *============================================================================*/
37 
38 /*----------------------------------------------------------------------------
39  * Deposition submodel:
40  * 1/ Parameter initialization
41  * 2/ Call of the different subroutines with respect to the marko indicator
42  *
43  * parameters:
44  * marko <-> state of the jump process
45  * tempf <-- temperature of the fluid
46  * lvisq <-- wall-unit lenghtscale
47  * tvisq <-- wall-unit timescale
48  * vpart <-- particle wall-normal velocity
49  * vvue <-- wall-normal velocity of the flow seen
50  * dx <-- wall-normal displacement
51  * diamp <-- particle diameter
52  * romp <-- particle density
53  * taup <-- particle relaxation time
54  * yplus <-- particle wall-normal normalized distance
55  * dintrf <-- extern-intern interface location
56  * enertur <-- turbulent kinetic energy
57  * gnorm <-- wall-normal gravity component
58  * vnorm <-- wall-normal fluid (Eulerian) velocity
59  * grpn <-- wall-normal pressure gradient
60  * piiln <-- SDE integration auxiliary term
61  * depint <-- interface location near-wall/core-flow
62  *----------------------------------------------------------------------------*/
63 
64 void
66  cs_lnum_t *marko,
67  cs_real_t tempf,
68  cs_real_t lvisq,
69  cs_real_t tvisq,
70  cs_real_t *vpart,
71  cs_real_t *vvue,
72  cs_real_t *dx,
73  cs_real_t *diamp,
74  cs_real_t romp,
75  cs_real_t taup,
76  cs_real_t *yplus,
77  cs_real_t *dintrf,
78  cs_real_t *enertur,
79  cs_real_t *gnorm,
80  cs_real_t *vnorm,
81  cs_real_t *grpn,
82  cs_real_t *piiln,
83  cs_real_t *depint);
84 
85 /*----------------------------------------------------------------------------*/
86 
88 
89 #endif /* __CS_LAGR_DEPOSITION_MODEL_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
#define END_C_DECLS
Definition: cs_defs.h:452
void cs_lagr_deposition(cs_real_t dtp, cs_lnum_t *marko, cs_real_t tempf, cs_real_t lvisq, cs_real_t tvisq, cs_real_t *vpart, cs_real_t *vvue, cs_real_t *dx, cs_real_t *diamp, cs_real_t romp, cs_real_t taup, cs_real_t *yplus, cs_real_t *dintrf, cs_real_t *enertur, cs_real_t *gnorm, cs_real_t *vnorm, cs_real_t *grpn, cs_real_t *piiln, cs_real_t *depint)
Definition: cs_lagr_deposition_model.c:1028