6.3
general documentation
cs_field_pointer.h
Go to the documentation of this file.
1 #ifndef __CS_FIELD_POINTER_H__
2 #define __CS_FIELD_POINTER_H__
3 
4 /*============================================================================
5  * Field pointers and ids for standard and model fields
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2020 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_defs.h"
35 #include "cs_field.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
40 
41 /*=============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /* Macro used for scoping of field pointer enums */
46 
47 #define CS_ENUMF_(e) CS_FIELD_POINTER_ ## e
48 
49 /* Macro used to return a field pointer by its enumerated value */
50 
51 #define CS_F_(e) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f
52 
53 #define CS_FI_(e, i) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].p[i]
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
61 typedef enum {
62 
63  /* Base variables and properties */
64 
83  CS_ENUMF_(alp_bl),
87  CS_ENUMF_(nusa),
119  /* Specific physics variables and properties */
120 
204  /* Cooling tower fields */
214  /* NCFD fields */
249  /* Added variables (scalars) */
252  /* User-defined arrays */
254 
255  /* End of attributes */
256 
258 
260 
266 };
267 
268 /*============================================================================
269  * Global variables
270  *============================================================================*/
271 
272 /* Pointers */
273 
275 
276 /*=============================================================================
277  * Public function prototypes
278  *============================================================================*/
279 
280 /*----------------------------------------------------------------------------
281  * Ensure field pointer array is initialized.
282  *----------------------------------------------------------------------------*/
283 
284 void
286 
287 /*----------------------------------------------------------------------------
288  * Free all field pointer data.
289  *----------------------------------------------------------------------------*/
290 
291 void
293 
294 /*----------------------------------------------------------------------------
295  * Map a simple field to an enumerated pointer.
296  *
297  * The associated field pointer may then be retreived using \ref CS_F_(e).
298  *
299  * parameters:
300  * e <-- field enumerator value
301  * f <-- pointer to field structure
302  *----------------------------------------------------------------------------*/
303 
304 void
306  cs_field_t *f);
307 
308 /*----------------------------------------------------------------------------
309  * Map a field to an (enumerated pointer, index) couple.
310  *
311  * This sort of mapping may be used for sets of fields whose size
312  * is not known in advance.
313  *
314  * The associated field pointer may then be retreived using \ref CS_F_(e, i).
315  *
316  * parameters:
317  * e <-- field enumerator value
318  * index <-- field enumerator index
319  * f <-- pointer to field structure
320  *----------------------------------------------------------------------------*/
321 
322 void
324  int index,
325  cs_field_t *f);
326 
327 /*----------------------------------------------------------------------------
328  * Map base fields to enumerated pointers.
329  *----------------------------------------------------------------------------*/
330 
331 void
333 
334 /*----------------------------------------------------------------------------
335  * Map some boundary fields to enumerated pointers.
336  *----------------------------------------------------------------------------*/
337 
338 void
340 
341 /*----------------------------------------------------------------------------
342  * Map base fields to enumerated pointers for atmospheric models
343  *
344  * parameters:
345  * n_chem_species <-- number of chemical species
346  * species_f_if <-- field id for each chemical species
347  *----------------------------------------------------------------------------*/
348 
349 void
350 cs_field_pointer_map_atmospheric(int n_chem_species,
351  const int species_f_id[]);
352 
353 /*----------------------------------------------------------------------------
354  * Map base fields to enumerated pointers for atmospheric models
355  *
356  * parameters:
357  * n_coals <-- number of coals
358  * n_classes <-- number of coal classes
359  *----------------------------------------------------------------------------*/
360 
361 void
363  int n_classes);
364 
365 /*----------------------------------------------------------------------------*
366  * Map base fields to enumerated pointers for compressible model
367  *----------------------------------------------------------------------------*/
368 
369 void
371 
372 /*----------------------------------------------------------------------------*
373  * Map base fields to enumerated pointers for gas mix model
374  *----------------------------------------------------------------------------*/
375 
376 void
378 
379 /*----------------------------------------------------------------------------
380  * Map base fields to enumerated pointers for gas combustion.
381  *----------------------------------------------------------------------------*/
382 
383 void
385 
386 /*----------------------------------------------------------------------------*/
387 /*
388  * Map base fields to enumerated pointers for groundwater flows
389  *----------------------------------------------------------------------------*/
390 
391 void
393 
394 /*----------------------------------------------------------------------------*/
395 
397 
398 #endif /* __CS_FIELD_POINTER_H__ */
qfpyy
@ qfpyy
Definition: cs_field_pointer.h:222
coyfp
@ coyfp
Definition: cs_field_pointer.h:143
e_tot
@ e_tot
Definition: cs_field_pointer.h:100
ntdrp
@ ntdrp
Definition: cs_field_pointer.h:131
emissivity
@ emissivity
Definition: cs_field_pointer.h:191
vel
@ vel
Definition: cs_field_pointer.h:68
cs_defs.h
xlam
@ xlam
Definition: cs_field_pointer.h:189
t_b
@ t_b
Definition: cs_field_pointer.h:99
radsc
@ radsc
Definition: cs_field_pointer.h:170
f9m
@ f9m
Definition: cs_field_pointer.h:157
surf_tens
@ surf_tens
Definition: cs_field_pointer.h:240
curim
@ curim
Definition: cs_field_pointer.h:173
poti
@ poti
Definition: cs_field_pointer.h:166
vel_mean
@ vel_mean
Definition: cs_field_pointer.h:243
cs_field_pointer_map_indexed
void cs_field_pointer_map_indexed(cs_field_pointer_id_t e, int index, cs_field_t *f)
Map a field to an (enumerated pointer, index) couple.
Definition: cs_field_pointer.c:232
rad_abs
@ rad_abs
Definition: cs_field_pointer.h:183
vel_rel
@ vel_rel
Definition: cs_field_pointer.h:244
rad_emi
@ rad_emi
Definition: cs_field_pointer.h:184
add_var
@ add_var
Definition: cs_field_pointer.h:250
th_diff
@ th_diff
Definition: cs_field_pointer.h:113
lambda
@ lambda
Definition: cs_field_pointer.h:112
yhcn
@ yhcn
Definition: cs_field_pointer.h:160
t_poro
@ t_poro
Definition: cs_field_pointer.h:117
fm
@ fm
Definition: cs_field_pointer.h:134
t_kelvin
@ t_kelvin
Definition: cs_field_pointer.h:121
rho
@ rho
Definition: cs_field_pointer.h:103
f4m
@ f4m
Definition: cs_field_pointer.h:152
rad_ck_down
@ rad_ck_down
Definition: cs_field_pointer.h:198
disp_t
@ disp_t
Definition: cs_field_pointer.h:239
drho_dp
@ drho_dp
Definition: cs_field_pointer.h:235
phi
@ phi
Definition: cs_field_pointer.h:81
npm
@ npm
Definition: cs_field_pointer.h:138
rho_b
@ rho_b
Definition: cs_field_pointer.h:104
drag
@ drag
Definition: cs_field_pointer.h:231
void_f
@ void_f
Definition: cs_field_pointer.h:94
f6m
@ f6m
Definition: cs_field_pointer.h:154
yf_ncond
@ yf_ncond
Definition: cs_field_pointer.h:215
rad_cak
@ rad_cak
Definition: cs_field_pointer.h:185
qinsp
@ qinsp
Definition: cs_field_pointer.h:188
f7m
@ f7m
Definition: cs_field_pointer.h:155
h_l
@ h_l
Definition: cs_field_pointer.h:208
ym_w
@ ym_w
Definition: cs_field_pointer.h:206
rad_ck_up
@ rad_ck_up
Definition: cs_field_pointer.h:197
dt
@ dt
Definition: cs_field_pointer.h:65
r22
@ r22
Definition: cs_field_pointer.h:74
magfl
@ magfl
Definition: cs_field_pointer.h:175
cs_field_pointer_map_coal_combustion
void cs_field_pointer_map_coal_combustion(int n_coals, int n_classes)
Map base fields to enumerated pointers for coal combustion.
Definition: cs_field_pointer.c:399
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:493
elech
@ elech
Definition: cs_field_pointer.h:171
head
@ head
Definition: cs_field_pointer.h:202
mass_f
@ mass_f
Definition: cs_field_pointer.h:126
elefl
@ elefl
Definition: cs_field_pointer.h:176
rij
@ rij
Definition: cs_field_pointer.h:79
fdown
@ fdown
Definition: cs_field_pointer.h:196
fsm
@ fsm
Definition: cs_field_pointer.h:137
pack_zone_id
@ pack_zone_id
Definition: cs_field_pointer.h:212
omg
@ omg
Definition: cs_field_pointer.h:86
thermal_diff_l
@ thermal_diff_l
Definition: cs_field_pointer.h:211
cs_field_pointer_map_atmospheric
void cs_field_pointer_map_atmospheric(int n_chem_species, const int species_f_id[])
Map base fields to enumerated pointers for atmospheric models.
Definition: cs_field_pointer.c:372
drift_vel
@ drift_vel
Definition: cs_field_pointer.h:241
potr
@ potr
Definition: cs_field_pointer.h:165
energy_f
@ energy_f
Definition: cs_field_pointer.h:127
yfm
@ yfm
Definition: cs_field_pointer.h:141
qfpzz
@ qfpzz
Definition: cs_field_pointer.h:226
volume_f
@ volume_f
Definition: cs_field_pointer.h:125
fconv
@ fconv
Definition: cs_field_pointer.h:193
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:492
vism
@ vism
Definition: cs_field_pointer.h:123
cs_field_pointer_array_t::f
cs_field_t * f
Definition: cs_field_pointer.h:264
cs_field_pointer_destroy_all
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition: cs_field_pointer.c:186
fp2m
@ fp2m
Definition: cs_field_pointer.h:135
hybrid_blend
@ hybrid_blend
Definition: cs_field_pointer.h:90
lift
@ lift
Definition: cs_field_pointer.h:238
epa
@ epa
Definition: cs_field_pointer.h:190
r23
@ r23
Definition: cs_field_pointer.h:77
mol_mass
@ mol_mass
Definition: cs_field_pointer.h:200
qfpxy
@ qfpxy
Definition: cs_field_pointer.h:219
yno
@ yno
Definition: cs_field_pointer.h:161
xck
@ xck
Definition: cs_field_pointer.h:147
h2
@ h2
Definition: cs_field_pointer.h:149
x2
@ x2
Definition: cs_field_pointer.h:229
qfpyx
@ qfpyx
Definition: cs_field_pointer.h:221
mu_t
@ mu_t
Definition: cs_field_pointer.h:110
yplus
@ yplus
Definition: cs_field_pointer.h:242
xch
@ xch
Definition: cs_field_pointer.h:146
CS_FIELD_N_POINTERS
@ CS_FIELD_N_POINTERS
Definition: cs_field_pointer.h:257
cs_field_pointer_map_gas_combustion
void cs_field_pointer_map_gas_combustion(void)
Map base fields to enumerated pointers for gas combustion.
Definition: cs_field_pointer.c:516
ygfm
@ ygfm
Definition: cs_field_pointer.h:139
tau12_t
@ tau12_t
Definition: cs_field_pointer.h:237
laplf
@ laplf
Definition: cs_field_pointer.h:174
hconv
@ hconv
Definition: cs_field_pointer.h:194
eps
@ eps
Definition: cs_field_pointer.h:71
xwt
@ xwt
Definition: cs_field_pointer.h:148
thermal_diff_h
@ thermal_diff_h
Definition: cs_field_pointer.h:210
f2m
@ f2m
Definition: cs_field_pointer.h:151
cs_field_pointer_ensure_init
void cs_field_pointer_ensure_init(void)
Ensure field pointer array is initialized.
Definition: cs_field_pointer.c:173
cs_field_pointer_map_boundary
void cs_field_pointer_map_boundary(void)
Map some boundary fields to enumerated pointers.
Definition: cs_field_pointer.c:353
cs_field_pointer_map_compressible
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition: cs_field_pointer.c:466
cs_field.h
r13
@ r13
Definition: cs_field_pointer.h:78
alp_bl
@ alp_bl
Definition: cs_field_pointer.h:83
humid
@ humid
Definition: cs_field_pointer.h:205
np
@ np
Definition: cs_field_pointer.h:145
r33
@ r33
Definition: cs_field_pointer.h:75
cs_field_pointer_array_t::p
cs_field_t ** p
Definition: cs_field_pointer.h:265
d32
@ d32
Definition: cs_field_pointer.h:230
qfp
@ qfp
Definition: cs_field_pointer.h:217
potva
@ potva
Definition: cs_field_pointer.h:167
cs_field_pointer_map_base
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition: cs_field_pointer.c:277
curre
@ curre
Definition: cs_field_pointer.h:172
ynh3
@ ynh3
Definition: cs_field_pointer.h:162
qfpzy
@ qfpzy
Definition: cs_field_pointer.h:225
user
@ user
Definition: cs_field_pointer.h:253
qfpxz
@ qfpxz
Definition: cs_field_pointer.h:220
rad_q
@ rad_q
Definition: cs_field_pointer.h:179
dt_dp
@ dt_dp
Definition: cs_field_pointer.h:245
r12
@ r12
Definition: cs_field_pointer.h:76
cs_field_pointer_id_t
cs_field_pointer_id_t
Definition: cs_field_pointer.h:61
f8m
@ f8m
Definition: cs_field_pointer.h:156
fnet
@ fnet
Definition: cs_field_pointer.h:192
cs_glob_field_pointers
struct cs_field_pointer_array_t * cs_glob_field_pointers
Definition: cs_field_pointer.c:130
qp
@ qp
Definition: cs_field_pointer.h:216
chemistry
@ chemistry
Definition: cs_field_pointer.h:132
f_bar
@ f_bar
Definition: cs_field_pointer.h:82
joulp
@ joulp
Definition: cs_field_pointer.h:169
hox
@ hox
Definition: cs_field_pointer.h:163
fvp2m
@ fvp2m
Definition: cs_field_pointer.h:158
kindiff
@ kindiff
Definition: cs_field_pointer.h:246
t
@ t
Definition: cs_field_pointer.h:98
qinci
@ qinci
Definition: cs_field_pointer.h:187
coldiff
@ coldiff
Definition: cs_field_pointer.h:247
if_poro
@ if_poro
Definition: cs_field_pointer.h:116
t_l
@ t_l
Definition: cs_field_pointer.h:207
cs_field_pointer_map
void cs_field_pointer_map(cs_field_pointer_id_t e, cs_field_t *f)
Map a simple field to an enumerated pointer.
Definition: cs_field_pointer.c:210
cp
@ cp
Definition: cs_field_pointer.h:106
th_diff_t
@ th_diff_t
Definition: cs_field_pointer.h:234
poro
@ poro
Definition: cs_field_pointer.h:115
f1m
@ f1m
Definition: cs_field_pointer.h:150
yco2
@ yco2
Definition: cs_field_pointer.h:159
yfp2m
@ yfp2m
Definition: cs_field_pointer.h:142
pot_t
@ pot_t
Definition: cs_field_pointer.h:129
fup
@ fup
Definition: cs_field_pointer.h:195
qfpyz
@ qfpyz
Definition: cs_field_pointer.h:223
r11
@ r11
Definition: cs_field_pointer.h:73
f5m
@ f5m
Definition: cs_field_pointer.h:153
drho_dh
@ drho_dh
Definition: cs_field_pointer.h:236
mesh_u
@ mesh_u
Definition: cs_field_pointer.h:92
qfpzx
@ qfpzx
Definition: cs_field_pointer.h:224
cs_field_pointer_map_groundwater
void cs_field_pointer_map_groundwater(void)
Map base fields to enumerated pointers for groundwater flows.
Definition: cs_field_pointer.c:550
cs_field_pointer_array_t
Definition: cs_field_pointer.h:263
rad_lumin
@ rad_lumin
Definition: cs_field_pointer.h:178
rad_ist
@ rad_ist
Definition: cs_field_pointer.h:182
ia
@ ia
Definition: cs_field_pointer.h:228
y_l_pack
@ y_l_pack
Definition: cs_field_pointer.h:209
qfpxx
@ qfpxx
Definition: cs_field_pointer.h:218
nusa
@ nusa
Definition: cs_field_pointer.h:87
h
@ h
Definition: cs_field_pointer.h:97
ycoel
@ ycoel
Definition: cs_field_pointer.h:168
cs_field_t
Field descriptor.
Definition: cs_field.h:125
cs_field_pointer_map_gas_mix
void cs_field_pointer_map_gas_mix(void)
Map base fields to enumerated pointers for gas mix model.
Definition: cs_field_pointer.c:503
h_tot
@ h_tot
Definition: cs_field_pointer.h:101
cv
@ cv
Definition: cs_field_pointer.h:107
vol_f
@ vol_f
Definition: cs_field_pointer.h:95
wlubr
@ wlubr
Definition: cs_field_pointer.h:233
gamma
@ gamma
Definition: cs_field_pointer.h:227
rad_est
@ rad_est
Definition: cs_field_pointer.h:181
CS_ENUMF_
#define CS_ENUMF_(e)
Macro used for scoping of field pointer enums.
Definition: cs_field_pointer.h:47
mu
@ mu
Definition: cs_field_pointer.h:109
ad_mass
@ ad_mass
Definition: cs_field_pointer.h:232
totwt
@ totwt
Definition: cs_field_pointer.h:130
k
@ k
Definition: cs_field_pointer.h:70
p
@ p
Definition: cs_field_pointer.h:67