programmer's 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-2018 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].a->p[i]
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
61 typedef enum {
62 
63  /* Base variables and properties */
64 
110  /* Specific physics variables and properties */
111 
187  /* Cooling tower fields */
196  /* End of attributes */
197 
199 
201 
205  int n;
207 };
208 
214 };
215 
216 /*============================================================================
217  * Global variables
218  *============================================================================*/
219 
220 /* Pointers */
221 
223 
224 /*=============================================================================
225  * Public function prototypes
226  *============================================================================*/
227 
228 /*----------------------------------------------------------------------------
229  * Free all field pointer data.
230  *----------------------------------------------------------------------------*/
231 
232 void
234 
235 /*----------------------------------------------------------------------------
236  * Map a simple field to an enumerated pointer.
237  *
238  * The associated field pointer may then be retreived using \ref CS_F_(e).
239  *
240  * parameters:
241  * e <-- field enumerator value
242  * f <-- pointer to field structure
243  *----------------------------------------------------------------------------*/
244 
245 void
247  cs_field_t *f);
248 
249 /*----------------------------------------------------------------------------
250  * Map a field to an (enumerated pointer, index) couple.
251  *
252  * This sort of mapping may be used for sets of fields whose size
253  * is not known in advance.
254  *
255  * The associated field pointer may then be retreived using \ref CS_F_(e, i).
256  *
257  * parameters:
258  * e <-- field enumerator value
259  * index <-- field enumerator index
260  * f <-- pointer to field structure
261  *----------------------------------------------------------------------------*/
262 
263 void
265  int index,
266  cs_field_t *f);
267 
268 /*----------------------------------------------------------------------------
269  * Map base fields to enumerated pointers.
270  *----------------------------------------------------------------------------*/
271 
272 void
274 
275 /*----------------------------------------------------------------------------
276  * Map some boundary fields to enumerated pointers.
277  *----------------------------------------------------------------------------*/
278 
279 void
281 
282 /*----------------------------------------------------------------------------
283  * Map base fields to enumerated pointers for atmospheric models
284  *
285  * parameters:
286  * n_chem_species <-- number of chemical species
287  * species_f_if <-- field id for each chemical species
288  *----------------------------------------------------------------------------*/
289 
290 void
291 cs_field_pointer_map_atmospheric(int n_chem_species,
292  const int species_f_id[]);
293 
294 /*----------------------------------------------------------------------------
295  * Map base fields to enumerated pointers for atmospheric models
296  *
297  * parameters:
298  * n_coals <-- number of coals
299  * n_classes <-- number of coal classes
300  *----------------------------------------------------------------------------*/
301 
302 void
304  int n_classes);
305 
306 /*----------------------------------------------------------------------------*
307  * Map base fields to enumerated pointers for compressible model
308  *----------------------------------------------------------------------------*/
309 
310 void
312 
313 /*----------------------------------------------------------------------------*
314  * Map base fields to enumerated pointers for gas mix model
315  *----------------------------------------------------------------------------*/
316 
317 void
319 
320 /*----------------------------------------------------------------------------
321  * Map base fields to enumerated pointers for gas combustion.
322  *----------------------------------------------------------------------------*/
323 
324 void
326 
327 /*----------------------------------------------------------------------------*/
328 /*
329  * Map base fields to enumerated pointers for groundwater flows
330  *----------------------------------------------------------------------------*/
331 
332 void
334 
335 /*----------------------------------------------------------------------------*/
336 
338 
339 #endif /* __CS_FIELD_POINTER_H__ */
Definition: cs_field_pointer.h:70
Definition: cs_field_pointer.h:157
Definition: cs_field_pointer.h:185
Definition: cs_field_pointer.h:158
Definition: cs_field_pointer.h:153
Definition: cs_field_pointer.h:168
Definition: cs_field_pointer.h:193
Definition: cs_field_pointer.h:211
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition: cs_field_pointer.c:289
Definition: cs_field_pointer.h:105
Definition: cs_field_pointer.h:143
Definition: cs_field_pointer.h:162
Definition: cs_field_pointer.h:132
Definition: cs_field_pointer.h:159
Field descriptor.
Definition: cs_field.h:124
Definition: cs_field_pointer.h:165
Definition: cs_field_pointer.h:136
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition: cs_field_pointer.c:172
Definition: cs_field_pointer.h:191
Definition: cs_field_pointer.h:144
Definition: cs_field_pointer.h:154
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
Definition: cs_field_pointer.h:117
cs_field_t * f
Definition: cs_field_pointer.h:212
Definition: cs_field_pointer.h:83
Definition: cs_field_pointer.h:79
#define CS_ENUMF_(e)
Macro used for scoping of field pointer enums.
Definition: cs_field_pointer.h:47
Definition: cs_field_pointer.h:172
Definition: cs_field_pointer.h:126
Definition: cs_field_pointer.h:155
void cs_field_pointer_map_boundary(void)
Map some boundary fields to enumerated pointers.
Definition: cs_field_pointer.c:357
Definition: cs_field_pointer.h:119
Definition: cs_field_pointer.h:138
void cs_field_pointer_map_gas_mix(void)
Map base fields to enumerated pointers for gas mix model.
Definition: cs_field_pointer.c:494
Definition: cs_field_pointer.h:67
Definition: cs_field_pointer.h:171
Definition: cs_field_pointer.h:101
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition: cs_field_pointer.c:470
Definition: cs_field_pointer.h:129
int n
Definition: cs_field_pointer.h:205
Definition: cs_field_pointer.h:96
Definition: cs_field_pointer.h:78
Definition: cs_field_pointer.h:189
Definition: cs_field_pointer.h:135
Definition: cs_field_pointer.h:147
Definition: cs_field_pointer.h:146
Definition: cs_field_pointer.h:68
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:403
Definition: cs_field_pointer.h:107
Definition: cs_field_pointer.h:170
Definition: cs_field_pointer.h:152
Definition: cs_field_pointer.h:181
Definition: cs_field_pointer.h:198
void cs_field_pointer_map_groundwater(void)
Map base fields to enumerated pointers for groundwater flows.
Definition: cs_field_pointer.c:541
Definition: cs_field_pointer.h:121
Definition: cs_field_pointer.h:112
Definition: cs_field_pointer.h:99
Definition: cs_field_pointer.h:190
Definition: cs_field_pointer.h:169
Definition: cs_field_pointer.h:192
Definition: cs_field_pointer.h:116
Definition: cs_field_pointer.h:160
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:225
Definition: cs_field_pointer.h:145
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:196
Definition: cs_field_pointer.h:93
Definition: cs_field_pointer.h:178
Definition: cs_field_pointer.h:65
Definition: cs_field_pointer.h:134
Definition: cs_field_pointer.h:95
Definition: cs_field_pointer.h:87
Definition: cs_field_pointer.h:183
Definition: cs_field_pointer.h:108
Definition: cs_field_pointer.h:102
Definition: cs_field_pointer.h:175
Definition: cs_field_pointer.h:174
Definition: cs_field_pointer.h:188
Definition: cs_field_pointer.h:137
Definition: cs_field_pointer.h:176
Definition: cs_field_pointer.h:75
Definition: cs_field_pointer.h:163
Definition: cs_field_pointer.h:149
struct cs_field_pointer_array_t * a
Definition: cs_field_pointer.h:213
Definition: cs_field_pointer.h:130
Definition: cs_field_pointer.h:86
Definition: cs_field_pointer.h:77
Definition: cs_field_pointer.h:179
Definition: cs_field_pointer.h:204
#define END_C_DECLS
Definition: cs_defs.h:452
Definition: cs_field_pointer.h:139
Definition: cs_field_pointer.h:73
Definition: cs_field_pointer.h:81
Definition: cs_field_pointer.h:194
Definition: cs_field_pointer.h:124
Definition: cs_field_pointer.h:156
Definition: cs_field_pointer.h:150
Definition: cs_field_pointer.h:140
Definition: cs_field_pointer.h:141
Definition: cs_field_pointer.h:128
Definition: cs_field_pointer.h:142
Definition: cs_field_pointer.h:98
Definition: cs_field_pointer.h:94
Definition: cs_field_pointer.h:74
Definition: cs_field_pointer.h:104
Definition: cs_field_pointer.h:122
cs_field_pointer_id_t
Definition: cs_field_pointer.h:61
Definition: cs_field_pointer.h:118
Definition: cs_field_pointer.h:91
Definition: cs_field_pointer.h:148
Definition: cs_field_pointer.h:180
Definition: cs_field_pointer.h:71
Definition: cs_field_pointer.h:161
Definition: cs_field_pointer.h:166
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:376
cs_field_t * p[]
Definition: cs_field_pointer.h:206
Definition: cs_field_pointer.h:89
Definition: cs_field_pointer.h:125
Definition: cs_field_pointer.h:133
Definition: cs_field_pointer.h:82
Definition: cs_field_pointer.h:177
Definition: cs_field_pointer.h:76
void cs_field_pointer_map_gas_combustion(void)
Map base fields to enumerated pointers for gas combustion.
Definition: cs_field_pointer.c:507
union cs_field_pointer_val_t * cs_glob_field_pointers
Definition: cs_field_pointer.c:130
Definition: cs_field_pointer.h:114