My Project
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-2019 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  * Type definitions
36  *============================================================================*/
37 
38 /*----------------------------------------------------------------------------
39  * Tag of the coherence structure
40  *----------------------------------------------------------------------------*/
41 
42 enum {
43  /* Bulk */
44 
46  /* Boundary layer */
47 
48  /* Inner layer */
50 
51  /* Outer layer: three types of structures */
55 
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
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 
116 
117 #endif /* __CS_LAGR_DEPOSITION_MODEL_H__ */
CS_LAGR_COHERENCE_STRUCT_INNER_ZONE_DIFF
Definition: cs_lagr_deposition_model.h:49
cs_lagr_deposition
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:1053
CS_LAGR_COHERENCE_STRUCT_DEGEN_SWEEP
Definition: cs_lagr_deposition_model.h:58
CS_LAGR_COHERENCE_STRUCT_BULK
Definition: cs_lagr_deposition_model.h:45
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:298
CS_LAGR_COHERENCE_STRUCT_SWEEP
Definition: cs_lagr_deposition_model.h:52
CS_LAGR_COHERENCE_STRUCT_DIFFUSION
Definition: cs_lagr_deposition_model.h:53
CS_LAGR_COHERENCE_STRUCT_EJECTION
Definition: cs_lagr_deposition_model.h:54
CS_LAGR_COHERENCE_STRUCT_DEGEN_DIFFUSION
Definition: cs_lagr_deposition_model.h:57
yplus
Definition: cs_field_pointer.h:237
CS_LAGR_COHERENCE_STRUCT_DEGEN_INNER_ZONE_DIFF
Definition: cs_lagr_deposition_model.h:56
CS_LAGR_COHERENCE_STRUCT_DEGEN_EJECTION
Definition: cs_lagr_deposition_model.h:59