programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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-2014 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 /* thermal model descriptor */
49 /*--------------------------*/
50 
51 typedef struct {
52 
53  int itherm; /* thermal model
54  - 0: no thermal model
55  - 1: temperature
56  - 2: enthalpy
57  - 3: total energy (only for compressible
58  module)*/
59  int itpscl; /* temperature scale
60  - 0: none
61  - 1: Kelvin
62  - 2: Celsius*/
63  int iscalt; /* index of the thermal scalar (temperature,
64  energy or enthalpy), the index of the
65  corresponding variable is isca(iscalt)*/
66 
68 
69 /*============================================================================
70  * Static global variables
71  *============================================================================*/
72 
73 /* Pointer to thermal model structure */
74 
76 
77 /*=============================================================================
78  * Public function prototypes
79  *============================================================================*/
80 
81 /*----------------------------------------------------------------------------*/
82 
84 
85 #endif /* __CS_THERMAL_MODEL_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:405
int itherm
Definition: cs_thermal_model.h:53
#define END_C_DECLS
Definition: cs_defs.h:406
Thermal model descriptor.
Definition: cs_thermal_model.h:51
int iscalt
Definition: cs_thermal_model.h:63
const cs_thermal_model_t * cs_glob_thermal_model
int itpscl
Definition: cs_thermal_model.h:59