8.2
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-2024 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
126
129
133
137
157
170
174
180
194
196
198
199 /* Cooling tower fields */
208
209 /* NCFD fields */
248
249 /* Added variables (scalars) */
251
252 /* User-defined arrays */
254
255 /* End of attributes */
256
258
260
262
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
284void
286
287/*----------------------------------------------------------------------------
288 * Free all field pointer data.
289 *----------------------------------------------------------------------------*/
290
291void
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
304void
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
322void
324 int index,
325 cs_field_t *f);
326
327/*----------------------------------------------------------------------------
328 * Map base fields to enumerated pointers.
329 *----------------------------------------------------------------------------*/
330
331void
333
334/*----------------------------------------------------------------------------
335 * Map some boundary fields to enumerated pointers.
336 *----------------------------------------------------------------------------*/
337
338void
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
349void
350cs_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
361void
363 int n_classes);
364
365/*----------------------------------------------------------------------------*
366 * Map base fields to enumerated pointers for compressible model
367 *----------------------------------------------------------------------------*/
368
369void
371
372/*----------------------------------------------------------------------------*
373 * Map base fields to enumerated pointers for gas mix model
374 *----------------------------------------------------------------------------*/
375
376void
378
379/*----------------------------------------------------------------------------
380 * Map base fields to enumerated pointers for gas combustion.
381 *----------------------------------------------------------------------------*/
382
383void
385
386/*----------------------------------------------------------------------------*/
387/*
388 * Map base fields to enumerated pointers for groundwater flows
389 *----------------------------------------------------------------------------*/
390
391void
393
394/*----------------------------------------------------------------------------*/
395
397
398#endif /* __CS_FIELD_POINTER_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:528
#define END_C_DECLS
Definition cs_defs.h:529
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:241
@ user
Definition cs_field_pointer.h:253
@ head
Definition cs_field_pointer.h:197
@ volume_f
Definition cs_field_pointer.h:119
@ alp_bl
Definition cs_field_pointer.h:77
@ drift_vel
Definition cs_field_pointer.h:239
@ npm
Definition cs_field_pointer.h:131
@ qfpzx
Definition cs_field_pointer.h:219
@ ynh3
Definition cs_field_pointer.h:155
@ f1m
Definition cs_field_pointer.h:143
@ p
Definition cs_field_pointer.h:67
@ radiance
Definition cs_field_pointer.h:173
@ ym_w
Definition cs_field_pointer.h:201
@ f4m
Definition cs_field_pointer.h:145
@ d32
Definition cs_field_pointer.h:225
@ xlam
Definition cs_field_pointer.h:183
@ coyfp
Definition cs_field_pointer.h:136
@ energy_f
Definition cs_field_pointer.h:121
@ mol_mass
Definition cs_field_pointer.h:195
@ elefl
Definition cs_field_pointer.h:169
@ rad_energy
Definition cs_field_pointer.h:171
@ gamma
Definition cs_field_pointer.h:222
@ yfm
Definition cs_field_pointer.h:134
@ qfpxx
Definition cs_field_pointer.h:213
@ f2m
Definition cs_field_pointer.h:144
@ qfp
Definition cs_field_pointer.h:212
@ elast
Definition cs_field_pointer.h:246
@ nusa
Definition cs_field_pointer.h:81
@ thermal_diff_l
Definition cs_field_pointer.h:206
@ k
Definition cs_field_pointer.h:70
@ tau12_t
Definition cs_field_pointer.h:232
@ pot_t
Definition cs_field_pointer.h:123
@ h_tot
Definition cs_field_pointer.h:95
@ vel_rel
Definition cs_field_pointer.h:242
@ 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:154
@ qfpzy
Definition cs_field_pointer.h:220
@ eps
Definition cs_field_pointer.h:71
@ radsc
Definition cs_field_pointer.h:163
@ xch
Definition cs_field_pointer.h:139
@ xwt
Definition cs_field_pointer.h:141
@ ntdrp
Definition cs_field_pointer.h:124
@ rad_est
Definition cs_field_pointer.h:175
@ add_var
Definition cs_field_pointer.h:250
@ c_alpha
Definition cs_field_pointer.h:247
@ cv
Definition cs_field_pointer.h:101
@ magfl
Definition cs_field_pointer.h:168
@ fp2m
Definition cs_field_pointer.h:128
@ lift
Definition cs_field_pointer.h:233
@ hybrid_blend
Definition cs_field_pointer.h:84
@ f8m
Definition cs_field_pointer.h:149
@ t_poro
Definition cs_field_pointer.h:111
@ curre
Definition cs_field_pointer.h:165
@ joulp
Definition cs_field_pointer.h:162
@ qfpyz
Definition cs_field_pointer.h:218
@ qinci
Definition cs_field_pointer.h:181
@ t_kelvin
Definition cs_field_pointer.h:115
@ ygfm
Definition cs_field_pointer.h:132
@ yh_l_pack
Definition cs_field_pointer.h:203
@ dt_dp
Definition cs_field_pointer.h:243
@ disp_t
Definition cs_field_pointer.h:234
@ curim
Definition cs_field_pointer.h:166
@ surf_tens
Definition cs_field_pointer.h:235
@ potva
Definition cs_field_pointer.h:160
@ drho_dp
Definition cs_field_pointer.h:230
@ ycoel
Definition cs_field_pointer.h:161
@ vel
Definition cs_field_pointer.h:68
@ wlubr
Definition cs_field_pointer.h:228
@ cp
Definition cs_field_pointer.h:100
@ poti
Definition cs_field_pointer.h:159
@ xck
Definition cs_field_pointer.h:140
@ humid
Definition cs_field_pointer.h:200
@ qinsp
Definition cs_field_pointer.h:182
@ qfpxy
Definition cs_field_pointer.h:214
@ h
Definition cs_field_pointer.h:91
@ drho_dh
Definition cs_field_pointer.h:231
@ f9m
Definition cs_field_pointer.h:150
@ qp
Definition cs_field_pointer.h:211
@ e_tot
Definition cs_field_pointer.h:94
@ th_diff_t
Definition cs_field_pointer.h:229
@ rad_ck_down
Definition cs_field_pointer.h:192
@ pack_zone_id
Definition cs_field_pointer.h:207
@ poro
Definition cs_field_pointer.h:109
@ rad_cak
Definition cs_field_pointer.h:179
@ np
Definition cs_field_pointer.h:138
@ yco2
Definition cs_field_pointer.h:152
@ fj
Definition cs_field_pointer.h:238
@ f7m
Definition cs_field_pointer.h:148
@ 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:146
@ fsm
Definition cs_field_pointer.h:130
@ fnet
Definition cs_field_pointer.h:186
@ rho
Definition cs_field_pointer.h:97
@ f6m
Definition cs_field_pointer.h:147
@ drag
Definition cs_field_pointer.h:226
@ yplus
Definition cs_field_pointer.h:240
@ sl_corr
Definition cs_field_pointer.h:236
@ epa
Definition cs_field_pointer.h:184
@ coldiff
Definition cs_field_pointer.h:245
@ rij
Definition cs_field_pointer.h:73
@ yf_ncond
Definition cs_field_pointer.h:210
@ yfp2m
Definition cs_field_pointer.h:135
@ potr
Definition cs_field_pointer.h:158
@ h2
Definition cs_field_pointer.h:142
@ fi
Definition cs_field_pointer.h:237
@ laplf
Definition cs_field_pointer.h:167
@ yhcn
Definition cs_field_pointer.h:153
@ rho_b
Definition cs_field_pointer.h:98
@ hconv
Definition cs_field_pointer.h:188
@ elech
Definition cs_field_pointer.h:164
@ kindiff
Definition cs_field_pointer.h:244
@ thermal_diff_h
Definition cs_field_pointer.h:205
@ x2
Definition cs_field_pointer.h:224
@ 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
@ CS_FIELD_N_POINTERS
Definition cs_field_pointer.h:257
@ f_bar
Definition cs_field_pointer.h:76
@ y_l_pack
Definition cs_field_pointer.h:204
@ t_b
Definition cs_field_pointer.h:93
@ chemistry
Definition cs_field_pointer.h:125
@ mu_t
Definition cs_field_pointer.h:104
@ rad_q
Definition cs_field_pointer.h:172
@ void_f
Definition cs_field_pointer.h:88
@ ad_mass
Definition cs_field_pointer.h:227
@ fvp2m
Definition cs_field_pointer.h:151
@ t_l_pack
Definition cs_field_pointer.h:202
@ vol_f
Definition cs_field_pointer.h:89
@ lambda
Definition cs_field_pointer.h:106
@ qfpxz
Definition cs_field_pointer.h:215
@ fm
Definition cs_field_pointer.h:127
@ th_diff
Definition cs_field_pointer.h:107
@ qfpyy
Definition cs_field_pointer.h:217
@ qfpzz
Definition cs_field_pointer.h:221
@ ia
Definition cs_field_pointer.h:223
@ fconv
Definition cs_field_pointer.h:187
@ mesh_u
Definition cs_field_pointer.h:86
@ qfpyx
Definition cs_field_pointer.h:216
@ hox
Definition cs_field_pointer.h:156
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:263
cs_field_t * f
Definition cs_field_pointer.h:264
cs_field_t ** p
Definition cs_field_pointer.h:265
Field descriptor.
Definition cs_field.h:131