programmer's documentation
cs_thermal_model.h
Go to the documentation of this file.
1 #ifndef __CS_THERMAL_MODEL_H__
2 #define __CS_THERMAL_MODEL_H__
3 
4 /*============================================================================
5  * Base thermal model data.
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 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Thermal model type
50  *----------------------------------------------------------------------------*/
51 
52 typedef enum {
53 
58 
60 
61 typedef enum {
62 
66 
68 
69 /* thermal model descriptor */
70 /*--------------------------*/
71 
72 typedef struct {
73 
74  int itherm; /* thermal model
75  - 0: no thermal model
76  - 1: temperature
77  - 2: enthalpy
78  - 3: total energy (only for compressible
79  module) */
80  int itpscl; /* temperature scale
81  - 0: none
82  - 1: Kelvin
83  - 2: Celsius */
84  int iscalt; /* index of the thermal scalar (temperature,
85  energy or enthalpy), the index of the
86  corresponding variable is isca(iscalt) */
87 
89 
90 /*============================================================================
91  * Static global variables
92  *============================================================================*/
93 
94 /* Pointer to thermal model structure */
95 
97 
98 /*=============================================================================
99  * Public function prototypes
100  *============================================================================*/
101 
102 /*----------------------------------------------------------------------------
103  * Provide acces to cs_glob_thermal_model
104  *
105  * needed to initialize structure with GUI
106  *----------------------------------------------------------------------------*/
107 
110 
111 /*----------------------------------------------------------------------------*/
112 
114 
115 #endif /* __CS_THERMAL_MODEL_H__ */
Definition: cs_thermal_model.h:63
Definition: cs_thermal_model.h:54
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
Definition: cs_thermal_model.h:56
cs_temperature_scale_t
Definition: cs_thermal_model.h:61
Definition: cs_thermal_model.h:55
Definition: cs_thermal_model.h:57
Definition: cs_thermal_model.h:64
int itherm
Definition: cs_thermal_model.h:74
#define END_C_DECLS
Definition: cs_defs.h:430
cs_thermal_model_t * cs_get_glob_thermal_model(void)
Definition: cs_thermal_model.c:175
Thermal model descriptor.
Definition: cs_thermal_model.h:72
int iscalt
Definition: cs_thermal_model.h:84
Definition: cs_thermal_model.h:65
const cs_thermal_model_t * cs_glob_thermal_model
int itpscl
Definition: cs_thermal_model.h:80
cs_thermal_model_variable_t
Definition: cs_thermal_model.h:52