programmer's documentation
cs_gui_particles.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_PARTICLES_H__
2 #define __CS_GUI_PARTICLES_H__
3 
4 /*============================================================================
5  * Reader of the parameters file: lagrangian particles
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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 
39 
40 /*============================================================================
41  * Public function prototypes for Fortran API
42  *============================================================================*/
43 
44 /*----------------------------------------------------------------------------
45  * Copy variable name from C to Fortran
46  *----------------------------------------------------------------------------*/
47 
48 void CS_PROCF(cfname, CFNAME)
49 (
50  int *const flag, /* --> flag for array = 1, 2, or 3 */
51  char *const fstr, /* --> Fortran string */
52  int *const len, /* --> String Length */
53  int *const var_id /* --> Variable Id (1 to n) */
55  );
56 
57 /*----------------------------------------------------------------------------
58  * Copy variable name from Fortran to C
59  *----------------------------------------------------------------------------*/
60 
61 void CS_PROCF(fclag1, FCLAG1)
62 (
63  const char *const fstr, /* --> Fortran string */
64  int *const len, /* --> String Length */
65  int *const var_id /* --> Variable Id (1 to n) */
67 );
68 
69 /*----------------------------------------------------------------------------
70  * Copy variable name from Fortran to C
71  *----------------------------------------------------------------------------*/
72 
73 void CS_PROCF(fclag2, FCLAG2)
74 (
75  const char *const fstr, /* --> Fortran string */
76  int *const len, /* --> String Length */
77  int *const var_id /* --> Variable Id (1 to n) */
79 );
80 
81 /*----------------------------------------------------------------------------
82  * Copy variable name from Fortran to C
83  *----------------------------------------------------------------------------*/
84 
85 void CS_PROCF(fclag3, FCLAG3)
86 (
87  const char *const fstr, /* --> Fortran string */
88  int *const len, /* --> String Length */
89  int *const var_id /* --> Variable Id (1 to n) */
91 );
92 
93 /*-----------------------------------------------------------------------------
94  * Lagrangian: global settings, particles model, 2 way coupling, numerical ordering.
95  *
96  * Fortran Interface:
97  *
98  * SUBROUTINE UILAG1
99  * *****************
100  *
101  *----------------------------------------------------------------------------*/
102 
103 void CS_PROCF (uilag1, UILAG1) (int *const nlayer,
104  int *const iilagr,
105  int *const isuila,
106  int *const isuist,
107  int *const isttio,
108  int *const injcon,
109  int *const idepst,
110  int *const iphyla,
111  int *const idpvar,
112  int *const itpvar,
113  int *const impvar,
114  int *const iencra,
115  double tprenc[],
116  double visref[],
117  double enc1[],
118  double enc2[],
119  int *const nstits,
120  int *const ltsdyn,
121  int *const ltsmas,
122  int *const ltsthe,
123  int *const nordre,
124  int *const idistu,
125  int *const idiffl,
126  int *const modcpl,
127  int *const idirla,
128  int *const ntlal,
129  int *const ivisv1,
130  int *const ivisv2,
131  int *const ivistp,
132  int *const ivisdm,
133  int *const iviste,
134  int *const ivismp,
135  int *const ivisdk,
136  int *const iviswat,
137  int *const ivisch,
138  int *const ivisck,
139  int *const istala,
140  int *const nbclst,
141  double *const seuil,
142  int *const idstnt,
143  int *const nstist,
144  int ihslag[],
145  int *const iensi3,
146  double *const seuilf,
147  int *const nstbor,
148  int *const inbrbd,
149  int *const iflmbd,
150  int *const iangbd,
151  int *const ivitbd,
152  int *const iencnbbd,
153  int *const iencmabd,
154  int *const iencdibd,
155  int *const iencckbd,
156  int imoybr[],
157  int *const iactfv,
158  int *const iactvx,
159  int *const iactvy,
160  int *const iactvz,
161  int *const iactts);
162 
163 /*-----------------------------------------------------------------------------
164  * Fortran Interface:
165  *
166  * subroutine uilag2
167  * *****************
168  *
169  * integer nfabor --> number of boundary faces
170  * integer nozppm --> max number of boundary conditions zone
171  * integer nclagm --> max number of classes
172  * integer nflagm --> max number of boundaries
173  * integer iphyla --> physica model associated to the particles
174  * ..
175  * integer nlayer <-- number of layer for coal
176  * integer inuchl <-- particle coal number
177  * integer irawcl <-- coal particle composition injection condition
178  * integer ihpt <-- coal temperature in K (for each layer)
179  * integer ifrlag --> type of boundary face
180  * integer iusncl <-- array for particles class(es) number
181  * integer iusclb <-- array for particles boundary conditions
182  *----------------------------------------------------------------------------*/
183 
184 void CS_PROCF (uilag2, UILAG2) (const int *const nfabor,
185  const int *const nozppm,
186  const int *const ientrl,
187  const int *const isortl,
188  const int *const idepo1,
189  const int *const idepo2,
190  const int *const idepfa,
191  const int *const iencrl,
192  const int *const irebol,
193  const int *const isymtl,
194  const int *const iphyla,
195  const int *const ijnbp,
196  const int *const ijfre,
197  const int *const iclst,
198  const int *const ijuvw,
199  const int *const iuno,
200  const int *const iupt,
201  const int *const ivpt,
202  const int *const iwpt,
203  const int *const ijprpd,
204  const int *const ipoit,
205  const int *const idebt,
206  const int *const ijprdp,
207  const int *const idpt,
208  const int *const ivdpt,
209  const int *const iropt,
210  const int *const ijprtp,
211  const int *const itpt,
212  const int *const icpt,
213  const int *const iepsi,
214  const int *const nlayer,
215  const int *const inuchl,
216  const int *const irawcl,
217  const int const ihpt[],
218  int ifrlag[],
219  int iusncl[],
220  int iusclb[]);
221 
222 /*============================================================================
223  * Public function prototypes
224  *============================================================================*/
225 
226 /*-----------------------------------------------------------------------------
227  * Free global GUI structures related to particles.
228  *----------------------------------------------------------------------------*/
229 
230 void
232 
233 /*----------------------------------------------------------------------------*/
234 
236 
237 #endif /* __CS_GUI_PARTICLES_H__ */
integer, save ivismp
associates (=1) or not (=0) the variable "particle mass" with the output of particles or trajectories...
Definition: lagran.f90:1310
integer, save iuno
particle velocity magnitude
Definition: lagran.f90:636
integer, save iencnbbd
Definition: lagran.f90:1173
integer, save ijuvw
velocity condition type:
Definition: lagran.f90:603
integer, save iviswat
Definition: lagran.f90:1328
integer, save ivistp
associates (=1) or not (=0) the variable "residence time" with the output of particles or trajectorie...
Definition: lagran.f90:1298
integer, save idirla
direction (1=x, 2=y, 3=z) of the complete model. it corresponds to the main directions of the flow...
Definition: lagran.f90:1084
integer isortl
constant = 2 !TODO
Definition: lagpar.f90:154
void fclag2(const char *const fstr, int *const len, int *const var_id CS_ARGF_SUPP_CHAINE)
Definition: cs_gui_particles.c:608
integer, save ivisck
associates (=1) or not (=0) the variable "mass of coal of the coal particles" with the output of par...
Definition: lagran.f90:1325
integer, save iencmabd
Definition: lagran.f90:1175
integer, save iencdibd
Definition: lagran.f90:1177
integer, save iactvz
Definition: lagran.f90:723
integer, save ntlal
output period of Lagrange listing
Definition: entsor.f90:277
integer iencrl
constant = 6
Definition: lagpar.f90:162
integer, dimension(:), allocatable ifrlag
Definition: pointe.f90:388
integer idepfa
constant = 12
Definition: lagpar.f90:174
integer, save nstist
Definition: lagran.f90:767
#define BEGIN_C_DECLS
Definition: cs_defs.h:419
integer, save ijprpd
Definition: lagran.f90:607
double precision, dimension(ncharm2), save enc1
encrustation data
Definition: lagran.f90:978
integer, save iphyla
activates (>0) or deactivates (=0) the physical models associated to the particles: ...
Definition: lagran.f90:210
integer, save ivisch
associates (=1) or not (=0) the variable "mass of reactive coal of the coal particles" with the outp...
Definition: lagran.f90:1320
integer, save ijprdp
type of user profiles in uslag2:
Definition: lagran.f90:616
integer, save istala
activation (=1) or not (=0) of the calculation of the volume statistics related to the dispersed phas...
Definition: lagran.f90:735
integer, save idpvar
activation (=1) or not (=0) of an evolution equation on the particle diameter. Useful if iphyla = 1 ...
Definition: lagran.f90:220
integer, save ltsdyn
activation (=1) or not (=0) of the two-way coupling on the dynamics of the continuous phase...
Definition: lagran.f90:838
integer, save ipoit
particle weight
Definition: lagran.f90:654
integer, save nfabor
Definition: mesh.f90:58
integer, save idepst
Definition: lagran.f90:250
integer, save injcon
activates (=1) or not (=0) the continuous injection of particles. this option allows to inject partic...
Definition: lagran.f90:496
integer, save ivpt
particle v component by class and zone
Definition: lagran.f90:640
#define CS_ARGF_SUPP_CHAINE
Definition: cs_defs.h:448
integer nozppm
maximum index of boundary zones
Definition: ppppar.f90:45
integer, dimension(nvplmx), save ihslag
historic statistics options
Definition: lagran.f90:821
integer, save iactvy
Definition: lagran.f90:721
integer ientrl
particle injection zone. For each particle class associated with this zone, information must be provi...
Definition: lagpar.f90:152
void fclag3(const char *const fstr, int *const len, int *const var_id CS_ARGF_SUPP_CHAINE)
Definition: cs_gui_particles.c:674
integer, save idebt
flow rate
Definition: lagran.f90:656
integer, save isuila
activation (=1) or not (=0) of a Lagrangian calculation restart. The calculation restart file read wh...
Definition: lagran.f90:71
integer, dimension(nflagm), save iusncl
for all the nfrlag boundary zones previously identified, the number of classes nbclas (a class is a s...
Definition: lagran.f90:509
integer, save inbrbd
activation (=1) or not (=0) of the recording of the number of particle/boundary interactions, and of the calculation of the associated boundary statistics. inbrbd = 1 is a compulsory condition to use the particulate average imoybr = 2. Useful if iensi3=1
Definition: lagran.f90:1151
integer, save ivisv2
associates (=1) or not (=0) the variable "particle velocity" with the output of particles or trajecto...
Definition: lagran.f90:1294
integer, save ivisv1
associates (=1) or not (=0) the variable "velocity of the locally undisturbed fluid flow field" with...
Definition: lagran.f90:1290
integer, save ltsmas
activation (=1) or not (=0) of the two-way coupling on the mass. Useful if iilagr = 2...
Definition: lagran.f90:842
integer isymtl
constant = 13
Definition: lagpar.f90:176
integer, save impvar
activation (=1) or not (=0) of an evolution equation on the particle mass Useful if si iphyla = 1 ...
Definition: lagran.f90:224
integer, save itpvar
activation (=1) or not (=0) of an evolution equation on the particle temperature (in degrees Celsius)...
Definition: lagran.f90:216
integer, save iropt
density
Definition: lagran.f90:650
integer, save ijfre
injection frequency (if < 0 : particle are introduced only at first iteration
Definition: lagran.f90:595
double precision, dimension(ncharm2), save enc2
encrustation data
Definition: lagran.f90:980
integer, save inuchl
coal number of the particle (if iphyla=2)
Definition: lagran.f90:622
integer, save iwpt
particle w component by class and zone
Definition: lagran.f90:642
integer, save idstnt
absolute Lagrangian iteration number (includings the restarts) after which the calculation of the vol...
Definition: lagran.f90:756
integer idepo1
constant = 4
Definition: lagpar.f90:158
integer, save iactvx
Definition: lagran.f90:719
integer, save ijnbp
number of particles per class and per boundary zone
Definition: lagran.f90:592
integer, save nbclst
statistic per zone and per class
Definition: lagran.f90:824
integer, save icpt
particle specific heat
Definition: lagran.f90:652
integer nlayer
maximal number of layer per coal particle
Definition: lagpar.f90:60
void uilag1(int *const nlayer, int *const iilagr, int *const isuila, int *const isuist, int *const isttio, int *const injcon, int *const idepst, int *const iphyla, int *const idpvar, int *const itpvar, int *const impvar, int *const iencra, double tprenc[], double visref[], double enc1[], double enc2[], int *const nstits, int *const ltsdyn, int *const ltsmas, int *const ltsthe, int *const nordre, int *const idistu, int *const idiffl, int *const modcpl, int *const idirla, int *const ntlal, int *const ivisv1, int *const ivisv2, int *const ivistp, int *const ivisdm, int *const iviste, int *const ivismp, int *const ivisdk, int *const iviswat, int *const ivisch, int *const ivisck, int *const istala, int *const nbclst, double *const seuil, int *const idstnt, int *const nstist, int ihslag[], int *const iensi3, double *const seuilf, int *const nstbor, int *const inbrbd, int *const iflmbd, int *const iangbd, int *const ivitbd, int *const iencnbbd, int *const iencmabd, int *const iencdibd, int *const iencckbd, int imoybr[], int *const iactfv, int *const iactvx, int *const iactvy, int *const iactvz, int *const iactts)
Definition: cs_gui_particles.c:861
double precision, dimension(ncharm2), save visref
ash critical viscosity in , in the fouling model cf J.D. Watt et T. Fereday (J.Inst.Fuel, Vol.42-p99). Useful if iphyla = 2 and iencra = 1
Definition: lagran.f90:991
integer, save iencra
activates (=1) or not (=0) the option of coal particle fouling. It then is necessary to specify the d...
Definition: lagran.f90:972
integer, save iencckbd
Definition: lagran.f90:1179
integer, dimension(nlayer), save ihpt
particle temperature
Definition: lagran.f90:660
integer, save itpt
particle temperature
Definition: lagran.f90:644
integer, save idiffl
idiffl=1 suppresses the crossing trajectory effect, making turbulent dispersion for the particles ide...
Definition: lagran.f90:1096
integer, save iactfv
Definition: lagran.f90:717
integer, save irawcl
type of coal initial composition (if iphyla=2)
Definition: lagran.f90:620
integer, dimension(nflagm), save iusclb
for all the nfrlag boundary zones previously identified, a particle boundary condition type is given...
Definition: lagran.f90:554
integer, save ltsthe
if iphyla = 1 and itpvar = 1, ltsthe activates (=1) or not (=0) the two-way coupling on temperature...
Definition: lagran.f90:850
integer, save iactts
Definition: lagran.f90:725
integer, dimension(nusbrd+10), save imoybr
the recordings in parbor at every particle/boundary interaction are cumulated values (possibly reset ...
Definition: lagran.f90:1231
integer, save idpt
particle diameter
Definition: lagran.f90:646
integer, save iilagr
Definition: lagran.f90:65
integer, save nstits
Definition: lagran.f90:930
void cs_gui_particles_free(void)
Definition: cs_gui_particles.c:1757
integer, save iangbd
activation (=1) or not (=0) of the recording of the angle between a particle trajectory and a boundar...
Definition: lagran.f90:1164
integer irebol
constant = 3
Definition: lagpar.f90:156
integer, save nstbor
Definition: lagran.f90:1127
double precision, dimension(ncharm2), save tprenc
limit temperature (in degree Celsius) below which the coal particles do not cause any fouling (if the...
Definition: lagran.f90:985
#define END_C_DECLS
Definition: cs_defs.h:420
integer, save iepsi
particle emissivity
Definition: lagran.f90:658
double precision, save seuilf
every boundary face of the mesh undergoes a certain number of interactions with particles, expressed in term of statistical weight (sum of the statistical weights of all the particles which have interacted with the boundary face). seuilf is the limit statistical weight value, below which the contribution of the face is not taken into account in the statistics at the boundaries for post-processing. Useful if iensi3=1
Definition: lagran.f90:1255
integer, save isuist
Definition: lagran.f90:742
integer idepo2
constant = 5
Definition: lagpar.f90:160
integer, save iflmbd
activation (=1) or not (=0) of the recording of the particulate mass flow related to the particle/bou...
Definition: lagran.f90:1158
integer, save iclst
number of the statistics group
Definition: lagran.f90:624
void fclag1(const char *const fstr, int *const len, int *const var_id CS_ARGF_SUPP_CHAINE)
Definition: cs_gui_particles.c:543
#define CS_PROCF(x, y)
Definition: cs_defs.h:433
integer, save ivitbd
activation (=1) or not (=0) of the recording of the velocity of a particle involved in a particle/bou...
Definition: lagran.f90:1170
integer, save modcpl
activates (>0) or not (=0) the complete turbulent dispersion model. When modcpl is strictly positive...
Definition: lagran.f90:1079
integer, save ivdpt
particle diameter variance
Definition: lagran.f90:648
void cfname(int *const flag, char *const fstr, int *const len, int *const var_id CS_ARGF_SUPP_CHAINE)
Definition: cs_gui_particles.c:740
integer, save ijprtp
Definition: lagran.f90:611
integer, save isttio
Definition: lagran.f90:84
void uilag2(const int *const nfabor, const int *const nozppm, const int *const ientrl, const int *const isortl, const int *const idepo1, const int *const idepo2, const int *const idepfa, const int *const iencrl, const int *const irebol, const int *const isymtl, const int *const iphyla, const int *const ijnbp, const int *const ijfre, const int *const iclst, const int *const ijuvw, const int *const iuno, const int *const iupt, const int *const ivpt, const int *const iwpt, const int *const ijprpd, const int *const ipoit, const int *const idebt, const int *const ijprdp, const int *const idpt, const int *const ivdpt, const int *const iropt, const int *const ijprtp, const int *const itpt, const int *const icpt, const int *const iepsi, const int *const nlayer, const int *const inuchl, const int *const irawcl, const int const ihpt[], int ifrlag[], int iusncl[], int iusclb[])
Definition: cs_gui_particles.c:1418
integer, save idistu
activation (=1) or not (=0) of the particle turbulent dispersion. The turbulent dispersion is compati...
Definition: lagran.f90:1090
integer, save iviste
associates (=1) or not (=0) the variable "particle temperature" with the output of particles or traje...
Definition: lagran.f90:1306
double precision, save seuil
every cell of the calculation domain contains a certain quantity of particles, representing a certain...
Definition: lagran.f90:804
integer, save ivisdm
associates (=1) or not (=0) the variable "particle diameter" with the output of particles or trajecto...
Definition: lagran.f90:1302
integer, save nordre
order of integration for the stochastic differential equations
Definition: lagran.f90:1070
integer, save ivisdk
associates (=1) or not (=0) the variable "shrinking core diameter of the coal particles" with the ou...
Definition: lagran.f90:1315
integer, save iensi3
Definition: lagran.f90:1286
integer, save iupt
particle u component by class and zone
Definition: lagran.f90:638