8.0
general documentation
Loading...
Searching...
No Matches
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-2023 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
60
61typedef enum {
62
63 /* Base variables and properties */
64
66
69
72
74
79
83
85
87
90
96
99
102
105
108
112
113 /* Specific physics variables and properties */
114
116
118
122
127
130
134
138
158
171
174
180
193
195
197
198 /* Cooling tower fields */
207
208 /* NCFD fields */
244
245 /* Added variables (scalars) */
247
248 /* User-defined arrays */
250
251 /* End of attributes */
252
254
256
258
263
264/*============================================================================
265 * Global variables
266 *============================================================================*/
267
268/* Pointers */
269
271
272/*=============================================================================
273 * Public function prototypes
274 *============================================================================*/
275
276/*----------------------------------------------------------------------------
277 * Ensure field pointer array is initialized.
278 *----------------------------------------------------------------------------*/
279
280void
282
283/*----------------------------------------------------------------------------
284 * Free all field pointer data.
285 *----------------------------------------------------------------------------*/
286
287void
289
290/*----------------------------------------------------------------------------
291 * Map a simple field to an enumerated pointer.
292 *
293 * The associated field pointer may then be retreived using \ref CS_F_(e).
294 *
295 * parameters:
296 * e <-- field enumerator value
297 * f <-- pointer to field structure
298 *----------------------------------------------------------------------------*/
299
300void
302 cs_field_t *f);
303
304/*----------------------------------------------------------------------------
305 * Map a field to an (enumerated pointer, index) couple.
306 *
307 * This sort of mapping may be used for sets of fields whose size
308 * is not known in advance.
309 *
310 * The associated field pointer may then be retreived using \ref CS_F_(e, i).
311 *
312 * parameters:
313 * e <-- field enumerator value
314 * index <-- field enumerator index
315 * f <-- pointer to field structure
316 *----------------------------------------------------------------------------*/
317
318void
320 int index,
321 cs_field_t *f);
322
323/*----------------------------------------------------------------------------
324 * Map base fields to enumerated pointers.
325 *----------------------------------------------------------------------------*/
326
327void
329
330/*----------------------------------------------------------------------------
331 * Map some boundary fields to enumerated pointers.
332 *----------------------------------------------------------------------------*/
333
334void
336
337/*----------------------------------------------------------------------------
338 * Map base fields to enumerated pointers for atmospheric models
339 *
340 * parameters:
341 * n_chem_species <-- number of chemical species
342 * species_f_if <-- field id for each chemical species
343 *----------------------------------------------------------------------------*/
344
345void
346cs_field_pointer_map_atmospheric(int n_chem_species,
347 const int species_f_id[]);
348
349/*----------------------------------------------------------------------------
350 * Map base fields to enumerated pointers for atmospheric models
351 *
352 * parameters:
353 * n_coals <-- number of coals
354 * n_classes <-- number of coal classes
355 *----------------------------------------------------------------------------*/
356
357void
359 int n_classes);
360
361/*----------------------------------------------------------------------------*
362 * Map base fields to enumerated pointers for compressible model
363 *----------------------------------------------------------------------------*/
364
365void
367
368/*----------------------------------------------------------------------------*
369 * Map base fields to enumerated pointers for gas mix model
370 *----------------------------------------------------------------------------*/
371
372void
374
375/*----------------------------------------------------------------------------
376 * Map base fields to enumerated pointers for gas combustion.
377 *----------------------------------------------------------------------------*/
378
379void
381
382/*----------------------------------------------------------------------------*/
383/*
384 * Map base fields to enumerated pointers for groundwater flows
385 *----------------------------------------------------------------------------*/
386
387void
389
390/*----------------------------------------------------------------------------*/
391
393
394#endif /* __CS_FIELD_POINTER_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:509
#define END_C_DECLS
Definition cs_defs.h:510
struct cs_field_pointer_array_t * cs_glob_field_pointers
Definition cs_field_pointer.c:130
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
void cs_field_pointer_map_boundary(void)
Map some boundary fields to enumerated pointers.
Definition cs_field_pointer.c:347
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:366
#define CS_ENUMF_(e)
Macro used for scoping of field pointer enums.
Definition cs_field_pointer.h:47
void cs_field_pointer_map_gas_combustion(void)
Map base fields to enumerated pointers for gas combustion.
Definition cs_field_pointer.c:510
void cs_field_pointer_ensure_init(void)
Ensure field pointer array is initialized.
Definition cs_field_pointer.c:173
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:393
cs_field_pointer_id_t
Definition cs_field_pointer.h:61
@ t
Definition cs_field_pointer.h:92
@ mass_f
Definition cs_field_pointer.h:120
@ vel_mean
Definition cs_field_pointer.h:237
@ user
Definition cs_field_pointer.h:249
@ head
Definition cs_field_pointer.h:196
@ volume_f
Definition cs_field_pointer.h:119
@ alp_bl
Definition cs_field_pointer.h:77
@ drift_vel
Definition cs_field_pointer.h:235
@ npm
Definition cs_field_pointer.h:132
@ qfpzx
Definition cs_field_pointer.h:218
@ ynh3
Definition cs_field_pointer.h:156
@ f1m
Definition cs_field_pointer.h:144
@ h_l
Definition cs_field_pointer.h:202
@ p
Definition cs_field_pointer.h:67
@ ym_w
Definition cs_field_pointer.h:200
@ f4m
Definition cs_field_pointer.h:146
@ d32
Definition cs_field_pointer.h:224
@ xlam
Definition cs_field_pointer.h:183
@ coyfp
Definition cs_field_pointer.h:137
@ energy_f
Definition cs_field_pointer.h:121
@ mol_mass
Definition cs_field_pointer.h:194
@ elefl
Definition cs_field_pointer.h:170
@ gamma
Definition cs_field_pointer.h:221
@ yfm
Definition cs_field_pointer.h:135
@ qfpxx
Definition cs_field_pointer.h:212
@ f2m
Definition cs_field_pointer.h:145
@ qfp
Definition cs_field_pointer.h:211
@ elast
Definition cs_field_pointer.h:242
@ nusa
Definition cs_field_pointer.h:81
@ thermal_diff_l
Definition cs_field_pointer.h:205
@ k
Definition cs_field_pointer.h:70
@ tau12_t
Definition cs_field_pointer.h:231
@ pot_t
Definition cs_field_pointer.h:123
@ h_tot
Definition cs_field_pointer.h:95
@ vel_rel
Definition cs_field_pointer.h:238
@ emissivity
Definition cs_field_pointer.h:185
@ mu
Definition cs_field_pointer.h:103
@ rad_ck_up
Definition cs_field_pointer.h:191
@ yno
Definition cs_field_pointer.h:155
@ qfpzy
Definition cs_field_pointer.h:219
@ eps
Definition cs_field_pointer.h:71
@ radsc
Definition cs_field_pointer.h:164
@ xch
Definition cs_field_pointer.h:140
@ xwt
Definition cs_field_pointer.h:142
@ ntdrp
Definition cs_field_pointer.h:125
@ rad_est
Definition cs_field_pointer.h:175
@ add_var
Definition cs_field_pointer.h:246
@ c_alpha
Definition cs_field_pointer.h:243
@ cv
Definition cs_field_pointer.h:101
@ magfl
Definition cs_field_pointer.h:169
@ fp2m
Definition cs_field_pointer.h:129
@ lift
Definition cs_field_pointer.h:232
@ hybrid_blend
Definition cs_field_pointer.h:84
@ f8m
Definition cs_field_pointer.h:150
@ t_poro
Definition cs_field_pointer.h:111
@ curre
Definition cs_field_pointer.h:166
@ joulp
Definition cs_field_pointer.h:163
@ qfpyz
Definition cs_field_pointer.h:217
@ qinci
Definition cs_field_pointer.h:181
@ t_kelvin
Definition cs_field_pointer.h:115
@ ygfm
Definition cs_field_pointer.h:133
@ dt_dp
Definition cs_field_pointer.h:239
@ disp_t
Definition cs_field_pointer.h:233
@ curim
Definition cs_field_pointer.h:167
@ surf_tens
Definition cs_field_pointer.h:234
@ potva
Definition cs_field_pointer.h:161
@ drho_dp
Definition cs_field_pointer.h:229
@ ycoel
Definition cs_field_pointer.h:162
@ vel
Definition cs_field_pointer.h:68
@ wlubr
Definition cs_field_pointer.h:227
@ cp
Definition cs_field_pointer.h:100
@ poti
Definition cs_field_pointer.h:160
@ xck
Definition cs_field_pointer.h:141
@ humid
Definition cs_field_pointer.h:199
@ qinsp
Definition cs_field_pointer.h:182
@ rad_lumin
Definition cs_field_pointer.h:172
@ qfpxy
Definition cs_field_pointer.h:213
@ h
Definition cs_field_pointer.h:91
@ drho_dh
Definition cs_field_pointer.h:230
@ f9m
Definition cs_field_pointer.h:151
@ qp
Definition cs_field_pointer.h:210
@ e_tot
Definition cs_field_pointer.h:94
@ th_diff_t
Definition cs_field_pointer.h:228
@ rad_ck_down
Definition cs_field_pointer.h:192
@ pack_zone_id
Definition cs_field_pointer.h:206
@ poro
Definition cs_field_pointer.h:109
@ rad_cak
Definition cs_field_pointer.h:179
@ np
Definition cs_field_pointer.h:139
@ yco2
Definition cs_field_pointer.h:153
@ f7m
Definition cs_field_pointer.h:149
@ vism
Definition cs_field_pointer.h:117
@ rad_abs
Definition cs_field_pointer.h:177
@ rad_emi
Definition cs_field_pointer.h:178
@ rad_ist
Definition cs_field_pointer.h:176
@ fdown
Definition cs_field_pointer.h:190
@ omg
Definition cs_field_pointer.h:80
@ f5m
Definition cs_field_pointer.h:147
@ fsm
Definition cs_field_pointer.h:131
@ fnet
Definition cs_field_pointer.h:186
@ rho
Definition cs_field_pointer.h:97
@ f6m
Definition cs_field_pointer.h:148
@ drag
Definition cs_field_pointer.h:225
@ yplus
Definition cs_field_pointer.h:236
@ epa
Definition cs_field_pointer.h:184
@ coldiff
Definition cs_field_pointer.h:241
@ rij
Definition cs_field_pointer.h:73
@ yf_ncond
Definition cs_field_pointer.h:209
@ yfp2m
Definition cs_field_pointer.h:136
@ potr
Definition cs_field_pointer.h:159
@ h2
Definition cs_field_pointer.h:143
@ laplf
Definition cs_field_pointer.h:168
@ yhcn
Definition cs_field_pointer.h:154
@ rho_b
Definition cs_field_pointer.h:98
@ hconv
Definition cs_field_pointer.h:188
@ elech
Definition cs_field_pointer.h:165
@ kindiff
Definition cs_field_pointer.h:240
@ thermal_diff_h
Definition cs_field_pointer.h:204
@ x2
Definition cs_field_pointer.h:223
@ phi
Definition cs_field_pointer.h:75
@ fup
Definition cs_field_pointer.h:189
@ dt
Definition cs_field_pointer.h:65
@ if_poro
Definition cs_field_pointer.h:110
@ t_l
Definition cs_field_pointer.h:201
@ totwt
Definition cs_field_pointer.h:124
@ CS_FIELD_N_POINTERS
Definition cs_field_pointer.h:253
@ f_bar
Definition cs_field_pointer.h:76
@ y_l_pack
Definition cs_field_pointer.h:203
@ t_b
Definition cs_field_pointer.h:93
@ chemistry
Definition cs_field_pointer.h:126
@ mu_t
Definition cs_field_pointer.h:104
@ rad_q
Definition cs_field_pointer.h:173
@ void_f
Definition cs_field_pointer.h:88
@ ad_mass
Definition cs_field_pointer.h:226
@ fvp2m
Definition cs_field_pointer.h:152
@ vol_f
Definition cs_field_pointer.h:89
@ lambda
Definition cs_field_pointer.h:106
@ qfpxz
Definition cs_field_pointer.h:214
@ fm
Definition cs_field_pointer.h:128
@ th_diff
Definition cs_field_pointer.h:107
@ qfpyy
Definition cs_field_pointer.h:216
@ qfpzz
Definition cs_field_pointer.h:220
@ ia
Definition cs_field_pointer.h:222
@ fconv
Definition cs_field_pointer.h:187
@ mesh_u
Definition cs_field_pointer.h:86
@ qfpyx
Definition cs_field_pointer.h:215
@ hox
Definition cs_field_pointer.h:157
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition cs_field_pointer.c:186
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition cs_field_pointer.c:277
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition cs_field_pointer.c:460
void cs_field_pointer_map_gas_mix(void)
Map base fields to enumerated pointers for gas mix model.
Definition cs_field_pointer.c:497
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
void cs_field_pointer_map_groundwater(void)
Map base fields to enumerated pointers for groundwater flows.
Definition cs_field_pointer.c:544
Definition cs_field_pointer.h:259
cs_field_t * f
Definition cs_field_pointer.h:260
cs_field_t ** p
Definition cs_field_pointer.h:261
Field descriptor.
Definition cs_field.h:130