7.2
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-2022 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 
113  /* Specific physics variables and properties */
114 
198  /* Cooling tower fields */
208  /* NCFD fields */
245  /* Added variables (scalars) */
248  /* User-defined arrays */
250 
251  /* End of attributes */
252 
254 
256 
262 };
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 
280 void
282 
283 /*----------------------------------------------------------------------------
284  * Free all field pointer data.
285  *----------------------------------------------------------------------------*/
286 
287 void
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 
300 void
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 
318 void
320  int index,
321  cs_field_t *f);
322 
323 /*----------------------------------------------------------------------------
324  * Map base fields to enumerated pointers.
325  *----------------------------------------------------------------------------*/
326 
327 void
329 
330 /*----------------------------------------------------------------------------
331  * Map some boundary fields to enumerated pointers.
332  *----------------------------------------------------------------------------*/
333 
334 void
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 
345 void
346 cs_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 
357 void
359  int n_classes);
360 
361 /*----------------------------------------------------------------------------*
362  * Map base fields to enumerated pointers for compressible model
363  *----------------------------------------------------------------------------*/
364 
365 void
367 
368 /*----------------------------------------------------------------------------*
369  * Map base fields to enumerated pointers for gas mix model
370  *----------------------------------------------------------------------------*/
371 
372 void
374 
375 /*----------------------------------------------------------------------------
376  * Map base fields to enumerated pointers for gas combustion.
377  *----------------------------------------------------------------------------*/
378 
379 void
381 
382 /*----------------------------------------------------------------------------*/
383 /*
384  * Map base fields to enumerated pointers for groundwater flows
385  *----------------------------------------------------------------------------*/
386 
387 void
389 
390 /*----------------------------------------------------------------------------*/
391 
393 
394 #endif /* __CS_FIELD_POINTER_H__ */
Definition: cs_field_pointer.h:70
Definition: cs_field_pointer.h:241
Definition: cs_field_pointer.h:164
Definition: cs_field_pointer.h:196
Definition: cs_field_pointer.h:224
Definition: cs_field_pointer.h:165
Definition: cs_field_pointer.h:160
Definition: cs_field_pointer.h:175
Definition: cs_field_pointer.h:204
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition: cs_field_pointer.c:277
Definition: cs_field_pointer.h:192
Definition: cs_field_pointer.h:104
Definition: cs_field_pointer.h:150
Definition: cs_field_pointer.h:169
Definition: cs_field_pointer.h:139
Definition: cs_field_pointer.h:166
Definition: cs_field_pointer.h:243
Field descriptor.
Definition: cs_field.h:125
Definition: cs_field_pointer.h:172
Definition: cs_field_pointer.h:106
Definition: cs_field_pointer.h:143
Definition: cs_field_pointer.h:77
void cs_field_pointer_ensure_init(void)
Ensure field pointer array is initialized.
Definition: cs_field_pointer.c:173
Definition: cs_field_pointer.h:229
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition: cs_field_pointer.c:186
Definition: cs_field_pointer.h:227
Definition: cs_field_pointer.h:215
Definition: cs_field_pointer.h:202
Definition: cs_field_pointer.h:151
Definition: cs_field_pointer.h:161
Definition: cs_field_pointer.h:84
Definition: cs_field_pointer.h:237
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
Definition: cs_field_pointer.h:124
Definition: cs_field_pointer.h:216
Definition: cs_field_pointer.h:228
Definition: cs_field_pointer.h:73
#define CS_ENUMF_(e)
Macro used for scoping of field pointer enums.
Definition: cs_field_pointer.h:47
Definition: cs_field_pointer.h:179
Definition: cs_field_pointer.h:133
Definition: cs_field_pointer.h:162
Definition: cs_field_pointer.h:230
Definition: cs_field_pointer.h:231
cs_field_t * f
Definition: cs_field_pointer.h:260
void cs_field_pointer_map_boundary(void)
Map some boundary fields to enumerated pointers.
Definition: cs_field_pointer.c:347
Definition: cs_field_pointer.h:214
Definition: cs_field_pointer.h:126
Definition: cs_field_pointer.h:145
void cs_field_pointer_map_gas_mix(void)
Map base fields to enumerated pointers for gas mix model.
Definition: cs_field_pointer.c:497
Definition: cs_field_pointer.h:67
Definition: cs_field_pointer.h:178
Definition: cs_field_pointer.h:100
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition: cs_field_pointer.c:460
Definition: cs_field_pointer.h:136
Definition: cs_field_pointer.h:212
Definition: cs_field_pointer.h:217
Definition: cs_field_pointer.h:200
Definition: cs_field_pointer.h:239
Definition: cs_field_pointer.h:223
Definition: cs_field_pointer.h:142
Definition: cs_field_pointer.h:68
Definition: cs_field_pointer.h:154
Definition: cs_field_pointer.h:153
Definition: cs_field_pointer.h:234
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
Definition: cs_field_pointer.h:109
Definition: cs_field_pointer.h:177
Definition: cs_field_pointer.h:159
Definition: cs_field_pointer.h:188
Definition: cs_field_pointer.h:107
Definition: cs_field_pointer.h:253
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:206
Definition: cs_field_pointer.h:95
cs_field_t ** p
Definition: cs_field_pointer.h:261
struct cs_field_pointer_array_t * cs_glob_field_pointers
Definition: cs_field_pointer.c:130
Definition: cs_field_pointer.h:128
Definition: cs_field_pointer.h:115
Definition: cs_field_pointer.h:98
Definition: cs_field_pointer.h:201
Definition: cs_field_pointer.h:176
Definition: cs_field_pointer.h:218
Definition: cs_field_pointer.h:222
Definition: cs_field_pointer.h:203
Definition: cs_field_pointer.h:123
Definition: cs_field_pointer.h:210
Definition: cs_field_pointer.h:209
Definition: cs_field_pointer.h:167
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
Definition: cs_field_pointer.h:152
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
Definition: cs_field_pointer.h:91
Definition: cs_field_pointer.h:185
Definition: cs_field_pointer.h:65
Definition: cs_field_pointer.h:141
Definition: cs_field_pointer.h:93
Definition: cs_field_pointer.h:226
Definition: cs_field_pointer.h:249
Definition: cs_field_pointer.h:89
Definition: cs_field_pointer.h:221
Definition: cs_field_pointer.h:190
Definition: cs_field_pointer.h:238
Definition: cs_field_pointer.h:81
Definition: cs_field_pointer.h:120
Definition: cs_field_pointer.h:225
Definition: cs_field_pointer.h:194
Definition: cs_field_pointer.h:111
Definition: cs_field_pointer.h:101
Definition: cs_field_pointer.h:94
Definition: cs_field_pointer.h:182
Definition: cs_field_pointer.h:213
Definition: cs_field_pointer.h:219
Definition: cs_field_pointer.h:233
Definition: cs_field_pointer.h:181
Definition: cs_field_pointer.h:199
Definition: cs_field_pointer.h:144
Definition: cs_field_pointer.h:183
Definition: cs_field_pointer.h:170
Definition: cs_field_pointer.h:156
Definition: cs_field_pointer.h:235
Definition: cs_field_pointer.h:232
Definition: cs_field_pointer.h:137
Definition: cs_field_pointer.h:80
Definition: cs_field_pointer.h:246
Definition: cs_field_pointer.h:186
Definition: cs_field_pointer.h:259
#define END_C_DECLS
Definition: cs_defs.h:511
Definition: cs_field_pointer.h:146
Definition: cs_field_pointer.h:75
Definition: cs_field_pointer.h:205
Definition: cs_field_pointer.h:131
Definition: cs_field_pointer.h:163
Definition: cs_field_pointer.h:157
Definition: cs_field_pointer.h:147
Definition: cs_field_pointer.h:121
Definition: cs_field_pointer.h:148
Definition: cs_field_pointer.h:135
Definition: cs_field_pointer.h:149
Definition: cs_field_pointer.h:189
Definition: cs_field_pointer.h:211
Definition: cs_field_pointer.h:97
Definition: cs_field_pointer.h:92
Definition: cs_field_pointer.h:191
Definition: cs_field_pointer.h:103
Definition: cs_field_pointer.h:129
cs_field_pointer_id_t
Definition: cs_field_pointer.h:61
Definition: cs_field_pointer.h:125
Definition: cs_field_pointer.h:240
Definition: cs_field_pointer.h:88
Definition: cs_field_pointer.h:155
Definition: cs_field_pointer.h:187
Definition: cs_field_pointer.h:110
Definition: cs_field_pointer.h:71
Definition: cs_field_pointer.h:168
Definition: cs_field_pointer.h:220
Definition: cs_field_pointer.h:119
Definition: cs_field_pointer.h:242
Definition: cs_field_pointer.h:173
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
Definition: cs_field_pointer.h:86
Definition: cs_field_pointer.h:132
Definition: cs_field_pointer.h:140
Definition: cs_field_pointer.h:76
Definition: cs_field_pointer.h:236
Definition: cs_field_pointer.h:184
void cs_field_pointer_map_gas_combustion(void)
Map base fields to enumerated pointers for gas combustion.
Definition: cs_field_pointer.c:510
Definition: cs_field_pointer.h:117