My Project
programmer's documentation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_gas_mix.h
Go to the documentation of this file.
1 #ifndef __CS_GAS_MIX_H__
2 #define __CS_GAS_MIX_H__
3 
4 /*============================================================================
5  * Base gas mix data.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2019 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 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /* Gas mix descriptor */
49 /*-------------------------------*/
50 
51 typedef struct {
52 
53  int n_species; /* number of species in the gas mix */
54  int *sp_id_to_f_id; /* array of species f_ids */
55 
56 } cs_gas_mix_t;
57 
58 /*============================================================================
59  * Static global variables
60  *============================================================================*/
61 
62 /* Pointer to main physical constants structure */
63 
64 extern const cs_gas_mix_t *cs_glob_gas_mix;
65 
66 /*=============================================================================
67  * Public function prototypes
68  *============================================================================*/
69 
70 /*----------------------------------------------------------------------------*/
76 /*----------------------------------------------------------------------------*/
77 
78 void
79 cs_gas_mix_add_species(int f_id);
80 
81 /*----------------------------------------------------------------------------*/
85 /*----------------------------------------------------------------------------*/
86 
87 void
88 cs_gas_mix_finalize(void);
89 
90 /*----------------------------------------------------------------------------*/
91 
92 END_C_DECLS
93 
94 #endif /* __CS_GAS_MIX_H__ */
f_id
void const int * f_id
Definition: cs_gui.h:292
cs_defs.h
cs_glob_gas_mix
const cs_gas_mix_t * cs_glob_gas_mix
Definition: cs_gas_mix.c:111
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_gas_mix_finalize
void cs_gas_mix_finalize(void)
Free array mapping gas mix species ids to field ids.
Definition: cs_gas_mix.c:193
cs_gas_mix_t
Gas mix descriptor.
Definition: cs_gas_mix.h:51
cs_gas_mix_add_species
void cs_gas_mix_add_species(int f_id)
Add a species field to the gas mix (set of fields).
Definition: cs_gas_mix.c:162
cs_gas_mix_t::n_species
int n_species
Definition: cs_gas_mix.h:53
cs_gas_mix_t::sp_id_to_f_id
int * sp_id_to_f_id
Definition: cs_gas_mix.h:54
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16