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-2015 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 
36 /*----------------------------------------------------------------------------*/
37 
39 
40 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /* Macro used for scoping of field pointer enums */
45 
46 #define CS_ENUMF_(e) CS_FIELD_POINTER_ ## e
47 
48 /* Macro used to return a field pointer by its enumerated value */
49 
50 #define CS_F_(e) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].f
51 
52 #define CS_FI_(e, i) cs_glob_field_pointers[CS_FIELD_POINTER_ ## e].a->p[i]
53 
54 /*============================================================================
55  * Type definitions
56  *============================================================================*/
57 
60 typedef enum {
61 
62  /* Base variables and properties */
63 
106  /* Specific physics variables and properties */
107 
169  /* End of attributes */
170 
172 
174 
178  int n;
180 };
181 
187 };
188 
189 /*============================================================================
190  * Global variables
191  *============================================================================*/
192 
193 /* Pointers */
194 
196 
197 /*=============================================================================
198  * Public function prototypes
199  *============================================================================*/
200 
201 /*----------------------------------------------------------------------------
202  * Free all field pointer data.
203  *----------------------------------------------------------------------------*/
204 
205 void
207 
208 /*----------------------------------------------------------------------------
209  * Map a simple field to an enumerated pointer.
210  *
211  * The associated field pointer may then be retreived using \ref CS_F_(e).
212  *
213  * parameters:
214  * e <-- field enumerator value
215  * f <-- pointer to field structure
216  *----------------------------------------------------------------------------*/
217 
218 void
220  cs_field_t *f);
221 
222 /*----------------------------------------------------------------------------
223  * Map a field to an (enumerated pointer, index) couple.
224  *
225  * This sort of mapping may be used for sets of fields whose size
226  * is not known in advance.
227  *
228  * The associated field pointer may then be retreived using \ref CS_F_(e, i).
229  *
230  * parameters:
231  * e <-- field enumerator value
232  * index <-- field enumerator index
233  * f <-- pointer to field structure
234  *----------------------------------------------------------------------------*/
235 
236 void
238  int index,
239  cs_field_t *f);
240 
241 /*----------------------------------------------------------------------------
242  * Map base fields to enumerated pointers.
243  *----------------------------------------------------------------------------*/
244 
245 void
247 
248 /*----------------------------------------------------------------------------
249  * Map base fields to enumerated pointers for atmospheric models
250  *
251  * parameters:
252  * n_chem_species <-- number of chemical species
253  * species_f_if <-- field id for each chemical species
254  *----------------------------------------------------------------------------*/
255 
256 void
257 cs_field_pointer_map_atmospheric(int n_chem_species,
258  const int species_f_id[]);
259 
260 /*----------------------------------------------------------------------------
261  * Map base fields to enumerated pointers for atmospheric models
262  *
263  * parameters:
264  * n_coals <-- number of coals
265  * n_classes <-- number of coal classes
266  *----------------------------------------------------------------------------*/
267 
268 void
270  int n_classes);
271 
272 /*----------------------------------------------------------------------------*
273  * Map base fields to enumerated pointers for compressible model
274  *----------------------------------------------------------------------------*/
275 
276 void
278 
279 /*----------------------------------------------------------------------------
280  * Map base fields to enumerated pointers for electric arcs
281  *
282  * parameters:
283  * n_gasses <-- number of gasses
284  *----------------------------------------------------------------------------*/
285 
286 void
288 
289 /*----------------------------------------------------------------------------
290  * Map base fields to enumerated pointers for gas combustion.
291  *----------------------------------------------------------------------------*/
292 
293 void
295 
296 /*----------------------------------------------------------------------------
297  * Map base fields to enumerated pointers for radiation module
298  *
299  * parameters:
300  * n_r_phases <-- number of radiating phases: 1 + possibly
301  * number of combustible classes (coal, fuel)
302  *----------------------------------------------------------------------------*/
303 
304 void
305 cs_field_pointer_map_radiation(int n_r_phases);
306 
307 /*----------------------------------------------------------------------------*/
308 
310 
311 #endif /* __CS_FIELD_POINTER_H__ */
Definition: cs_field_pointer.h:69
Definition: cs_field_pointer.h:147
Definition: cs_field_pointer.h:184
void cs_field_pointer_map_base(void)
Map base fields to enumerated pointers.
Definition: cs_field_pointer.c:289
Definition: cs_field_pointer.h:101
Definition: cs_field_pointer.h:137
Definition: cs_field_pointer.h:126
Field descriptor.
Definition: cs_field.h:99
Definition: cs_field_pointer.h:151
Definition: cs_field_pointer.h:130
void cs_field_pointer_destroy_all(void)
Free all field pointer data.
Definition: cs_field_pointer.c:172
Definition: cs_field_pointer.h:138
Definition: cs_field_pointer.h:148
#define BEGIN_C_DECLS
Definition: cs_defs.h:419
Definition: cs_field_pointer.h:111
cs_field_t * f
Definition: cs_field_pointer.h:185
Definition: cs_field_pointer.h:81
#define CS_ENUMF_(e)
Macro used for scoping of field pointer enums.
Definition: cs_field_pointer.h:46
Definition: cs_field_pointer.h:158
Definition: cs_field_pointer.h:120
Definition: cs_field_pointer.h:154
Definition: cs_field_pointer.h:149
Definition: cs_field_pointer.h:113
Definition: cs_field_pointer.h:132
Definition: cs_field_pointer.h:66
Definition: cs_field_pointer.h:157
Definition: cs_field_pointer.h:98
void cs_field_pointer_map_compressible(void)
Map base fields to enumerated pointers for compressible model.
Definition: cs_field_pointer.c:452
Definition: cs_field_pointer.h:123
int n
Definition: cs_field_pointer.h:178
Definition: cs_field_pointer.h:93
Definition: cs_field_pointer.h:77
Definition: cs_field_pointer.h:160
Definition: cs_field_pointer.h:129
Definition: cs_field_pointer.h:141
Definition: cs_field_pointer.h:140
Definition: cs_field_pointer.h:67
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:385
Definition: cs_field_pointer.h:103
Definition: cs_field_pointer.h:156
Definition: cs_field_pointer.h:146
Definition: cs_field_pointer.h:167
Definition: cs_field_pointer.h:171
Definition: cs_field_pointer.h:115
Definition: cs_field_pointer.h:108
Definition: cs_field_pointer.h:96
void cs_field_pointer_map_electric_arcs(int n_gasses)
Map base fields to enumerated pointers for electric arcs.
Definition: cs_field_pointer.c:475
Definition: cs_field_pointer.h:110
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:139
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:91
Definition: cs_field_pointer.h:164
Definition: cs_field_pointer.h:64
Definition: cs_field_pointer.h:128
Definition: cs_field_pointer.h:85
void cs_field_pointer_map_radiation(int n_r_phases)
Map base fields to enumerated pointers for radiation module.
Definition: cs_field_pointer.c:537
Definition: cs_field_pointer.h:104
Definition: cs_field_pointer.h:161
Definition: cs_field_pointer.h:131
Definition: cs_field_pointer.h:162
Definition: cs_field_pointer.h:74
Definition: cs_field_pointer.h:143
struct cs_field_pointer_array_t * a
Definition: cs_field_pointer.h:186
Definition: cs_field_pointer.h:124
Definition: cs_field_pointer.h:84
Definition: cs_field_pointer.h:76
Definition: cs_field_pointer.h:165
Definition: cs_field_pointer.h:177
#define END_C_DECLS
Definition: cs_defs.h:420
Definition: cs_field_pointer.h:133
Definition: cs_field_pointer.h:72
Definition: cs_field_pointer.h:79
Definition: cs_field_pointer.h:118
Definition: cs_field_pointer.h:144
Definition: cs_field_pointer.h:134
Definition: cs_field_pointer.h:135
Definition: cs_field_pointer.h:122
Definition: cs_field_pointer.h:136
Definition: cs_field_pointer.h:95
Definition: cs_field_pointer.h:92
Definition: cs_field_pointer.h:73
Definition: cs_field_pointer.h:100
Definition: cs_field_pointer.h:155
Definition: cs_field_pointer.h:116
cs_field_pointer_id_t
Definition: cs_field_pointer.h:60
Definition: cs_field_pointer.h:112
Definition: cs_field_pointer.h:89
Definition: cs_field_pointer.h:142
Definition: cs_field_pointer.h:166
Definition: cs_field_pointer.h:70
Definition: cs_field_pointer.h:152
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:358
cs_field_t * p[]
Definition: cs_field_pointer.h:179
Definition: cs_field_pointer.h:87
Definition: cs_field_pointer.h:119
Definition: cs_field_pointer.h:127
Definition: cs_field_pointer.h:80
Definition: cs_field_pointer.h:163
Definition: cs_field_pointer.h:75
void cs_field_pointer_map_gas_combustion(void)
Map base fields to enumerated pointers for gas combustion.
Definition: cs_field_pointer.c:500
union cs_field_pointer_val_t * cs_glob_field_pointers
Definition: cs_field_pointer.c:130