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-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 
32 BEGIN_C_DECLS
33 
34 /*============================================================================
35  * Type definitions
36  *============================================================================*/
37 
38 /*----------------------------------------------------------------------------
39  * Tag of the coherence structure
40  *----------------------------------------------------------------------------*/
41 
42 enum {
43   /* Bulk */
44 
45   CS_LAGR_COHERENCE_STRUCT_BULK = -1,
46   /* Boundary layer */
47 
48   /* Inner layer */
49   CS_LAGR_COHERENCE_STRUCT_INNER_ZONE_DIFF = 0,
50 
51   /* Outer layer: three types of structures */
52   CS_LAGR_COHERENCE_STRUCT_SWEEP = 1,
53   CS_LAGR_COHERENCE_STRUCT_DIFFUSION = 2,
54   CS_LAGR_COHERENCE_STRUCT_EJECTION = 3,
55 
56   CS_LAGR_COHERENCE_STRUCT_DEGEN_INNER_ZONE_DIFF = 10,
57   CS_LAGR_COHERENCE_STRUCT_DEGEN_DIFFUSION = 12,
58   CS_LAGR_COHERENCE_STRUCT_DEGEN_SWEEP = 20,
59   CS_LAGR_COHERENCE_STRUCT_DEGEN_EJECTION = 30
60 };
61 
62 /*============================================================================
63  * Public function prototypes
64  *============================================================================*/
65 
66 /*----------------------------------------------------------------------------
67  * Deposition submodel:
68  *   1/ Parameter initialization
69  *   2/ Call of the different subroutines with respect to the marko indicator
70  *
71  * parameters:
72  *   marko     <->    state of the jump process
73  *   tempf     <--    temperature of the fluid
74  *   lvisq     <--    wall-unit lenghtscale
75  *   tvisq     <--    wall-unit timescale
76  *   vpart     <--    particle wall-normal velocity
77  *   vvue      <--    wall-normal velocity of the flow seen
78  *   dx        <--    wall-normal displacement
79  *   diamp     <--    particle diameter
80  *   romp      <--    particle density
81  *   taup      <--    particle relaxation time
82  *   yplus     <--    particle wall-normal normalized distance
83  *   dintrf    <--    extern-intern interface location
84  *   enertur   <--    turbulent kinetic energy
85  *   gnorm     <--    wall-normal gravity component
86  *   vnorm     <--    wall-normal fluid (Eulerian) velocity
87  *   grpn      <--    wall-normal pressure gradient
88  *   piiln     <--    SDE integration auxiliary term
89  *   depint    <--    interface location near-wall/core-flow
90  *----------------------------------------------------------------------------*/
91 
92 void
93 cs_lagr_deposition(cs_real_t  dtp,
94                    cs_lnum_t *marko,
95                    cs_real_t  tempf,
96                    cs_real_t  lvisq,
97                    cs_real_t  tvisq,
98                    cs_real_t *vpart,
99                    cs_real_t *vvue,
100                    cs_real_t *dx,
101                    cs_real_t *diamp,
102                    cs_real_t  romp,
103                    cs_real_t  taup,
104                    cs_real_t *yplus,
105                    cs_real_t *dintrf,
106                    cs_real_t *enertur,
107                    cs_real_t *gnorm,
108                    cs_real_t *vnorm,
109                    cs_real_t *grpn,
110                    cs_real_t *piiln,
111                    cs_real_t *depint);
112 
113 /*----------------------------------------------------------------------------*/
114 
115 END_C_DECLS
116 
117 #endif /* __CS_LAGR_DEPOSITION_MODEL_H__ */
118