programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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-2017 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 
112  /* Specific physics variables and properties */
113 
189  /* Cooling tower fields */
198  /* End of attributes */
199 
201 
203 
207  int n;
209 };
210 
216 };
217 
218 /*============================================================================
219  * Global variables
220  *============================================================================*/
221 
222 /* Pointers */
223 
225 
226 /*=============================================================================
227  * Public function prototypes
228  *============================================================================*/
229 
230 /*----------------------------------------------------------------------------
231  * Free all field pointer data.
232  *----------------------------------------------------------------------------*/
233 
234 void
236 
237 /*----------------------------------------------------------------------------
238  * Map a simple field to an enumerated pointer.
239  *
240  * The associated field pointer may then be retreived using \ref CS_F_(e).
241  *
242  * parameters:
243  * e <-- field enumerator value
244  * f <-- pointer to field structure
245  *----------------------------------------------------------------------------*/
246 
247 void
249  cs_field_t *f);
250 
251 /*----------------------------------------------------------------------------
252  * Map a field to an (enumerated pointer, index) couple.
253  *
254  * This sort of mapping may be used for sets of fields whose size
255  * is not known in advance.
256  *
257  * The associated field pointer may then be retreived using \ref CS_F_(e, i).
258  *
259  * parameters:
260  * e <-- field enumerator value
261  * index <-- field enumerator index
262  * f <-- pointer to field structure
263  *----------------------------------------------------------------------------*/
264 
265 void
267  int index,
268  cs_field_t *f);
269 
270 /*----------------------------------------------------------------------------
271  * Map base fields to enumerated pointers.
272  *----------------------------------------------------------------------------*/
273 
274 void
276 
277 /*----------------------------------------------------------------------------
278  * Map some boundary fields to enumerated pointers.
279  *----------------------------------------------------------------------------*/
280 
281 void
283 
284 /*----------------------------------------------------------------------------
285  * Map base fields to enumerated pointers for atmospheric models
286  *
287  * parameters:
288  * n_chem_species <-- number of chemical species
289  * species_f_if <-- field id for each chemical species
290  *----------------------------------------------------------------------------*/
291 
292 void
293 cs_field_pointer_map_atmospheric(int n_chem_species,
294  const int species_f_id[]);
295 
296 /*----------------------------------------------------------------------------
297  * Map base fields to enumerated pointers for atmospheric models
298  *
299  * parameters:
300  * n_coals <-- number of coals
301  * n_classes <-- number of coal classes
302  *----------------------------------------------------------------------------*/
303 
304 void
306  int n_classes);
307 
308 /*----------------------------------------------------------------------------*
309  * Map base fields to enumerated pointers for compressible model
310  *----------------------------------------------------------------------------*/
311 
312 void
314 
315 /*----------------------------------------------------------------------------*
316  * Map base fields to enumerated pointers for gas mix model
317  *----------------------------------------------------------------------------*/
318 
319 void
321 
322 /*----------------------------------------------------------------------------
323  * Map base fields to enumerated pointers for gas combustion.
324  *----------------------------------------------------------------------------*/
325 
326 void
328 
329 /*----------------------------------------------------------------------------*/
330 /*
331  * Map base fields to enumerated pointers for groundwater flows
332  *----------------------------------------------------------------------------*/
333 
334 void
336 
337 /*----------------------------------------------------------------------------*/
338 
340 
341 #endif /* __CS_FIELD_POINTER_H__ */
Definition: cs_field_pointer.h:70
Definition: cs_field_pointer.h:159
Definition: cs_field_pointer.h:187
Definition: cs_field_pointer.h:160
Definition: cs_field_pointer.h:155
Definition: cs_field_pointer.h:170
Definition: cs_field_pointer.h:195
Definition: cs_field_pointer.h:213
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition: cs_field_pointer.c:289
Definition: cs_field_pointer.h:107
Definition: cs_field_pointer.h:145
Definition: cs_field_pointer.h:164
Definition: cs_field_pointer.h:134
Definition: cs_field_pointer.h:161
Field descriptor.
Definition: cs_field.h:124
Definition: cs_field_pointer.h:167
Definition: cs_field_pointer.h:138
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition: cs_field_pointer.c:172
Definition: cs_field_pointer.h:193
Definition: cs_field_pointer.h:146
Definition: cs_field_pointer.h:156
Definition: cs_field_pointer.h:89
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
Definition: cs_field_pointer.h:119
cs_field_t * f
Definition: cs_field_pointer.h:214
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:174
Definition: cs_field_pointer.h:128
Definition: cs_field_pointer.h:157
void cs_field_pointer_map_boundary(void)
Map some boundary fields to enumerated pointers.
Definition: cs_field_pointer.c:359
Definition: cs_field_pointer.h:121
Definition: cs_field_pointer.h:140
void cs_field_pointer_map_gas_mix(void)
Map base fields to enumerated pointers for gas mix model.
Definition: cs_field_pointer.c:496
Definition: cs_field_pointer.h:67
Definition: cs_field_pointer.h:173
Definition: cs_field_pointer.h:103
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition: cs_field_pointer.c:472
Definition: cs_field_pointer.h:131
int n
Definition: cs_field_pointer.h:207
Definition: cs_field_pointer.h:98
Definition: cs_field_pointer.h:78
Definition: cs_field_pointer.h:191
Definition: cs_field_pointer.h:137
Definition: cs_field_pointer.h:149
Definition: cs_field_pointer.h:148
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:405
Definition: cs_field_pointer.h:109
Definition: cs_field_pointer.h:172
Definition: cs_field_pointer.h:154
Definition: cs_field_pointer.h:183
Definition: cs_field_pointer.h:200
void cs_field_pointer_map_groundwater(void)
Map base fields to enumerated pointers for groundwater flows.
Definition: cs_field_pointer.c:543
Definition: cs_field_pointer.h:123
Definition: cs_field_pointer.h:114
Definition: cs_field_pointer.h:101
Definition: cs_field_pointer.h:192
Definition: cs_field_pointer.h:171
Definition: cs_field_pointer.h:194
Definition: cs_field_pointer.h:118
Definition: cs_field_pointer.h:162
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:147
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:95
Definition: cs_field_pointer.h:180
Definition: cs_field_pointer.h:65
Definition: cs_field_pointer.h:136
Definition: cs_field_pointer.h:97
Definition: cs_field_pointer.h:87
Definition: cs_field_pointer.h:185
Definition: cs_field_pointer.h:110
Definition: cs_field_pointer.h:104
Definition: cs_field_pointer.h:177
Definition: cs_field_pointer.h:176
Definition: cs_field_pointer.h:190
Definition: cs_field_pointer.h:139
Definition: cs_field_pointer.h:178
Definition: cs_field_pointer.h:75
Definition: cs_field_pointer.h:165
Definition: cs_field_pointer.h:151
struct cs_field_pointer_array_t * a
Definition: cs_field_pointer.h:215
Definition: cs_field_pointer.h:132
Definition: cs_field_pointer.h:86
Definition: cs_field_pointer.h:77
Definition: cs_field_pointer.h:181
Definition: cs_field_pointer.h:206
#define END_C_DECLS
Definition: cs_defs.h:454
Definition: cs_field_pointer.h:141
Definition: cs_field_pointer.h:73
Definition: cs_field_pointer.h:81
Definition: cs_field_pointer.h:196
Definition: cs_field_pointer.h:126
Definition: cs_field_pointer.h:158
Definition: cs_field_pointer.h:152
Definition: cs_field_pointer.h:142
Definition: cs_field_pointer.h:143
Definition: cs_field_pointer.h:130
Definition: cs_field_pointer.h:144
Definition: cs_field_pointer.h:100
Definition: cs_field_pointer.h:96
Definition: cs_field_pointer.h:74
Definition: cs_field_pointer.h:106
Definition: cs_field_pointer.h:124
cs_field_pointer_id_t
Definition: cs_field_pointer.h:61
Definition: cs_field_pointer.h:120
Definition: cs_field_pointer.h:93
Definition: cs_field_pointer.h:150
Definition: cs_field_pointer.h:182
Definition: cs_field_pointer.h:71
Definition: cs_field_pointer.h:163
Definition: cs_field_pointer.h:168
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:378
cs_field_t * p[]
Definition: cs_field_pointer.h:208
Definition: cs_field_pointer.h:91
Definition: cs_field_pointer.h:127
Definition: cs_field_pointer.h:135
Definition: cs_field_pointer.h:82
Definition: cs_field_pointer.h:179
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:509
union cs_field_pointer_val_t * cs_glob_field_pointers
Definition: cs_field_pointer.c:130
Definition: cs_field_pointer.h:116