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-2018 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 
59 
61 
62 typedef enum {
63 
67 
69 
70 /* thermal model descriptor */
71 /*--------------------------*/
72 
73 typedef struct {
74 
75  int itherm; /* thermal model
76  - 0: no thermal model
77  - 1: temperature
78  - 2: enthalpy
79  - 3: total energy (only for compressible
80  module) */
81  int itpscl; /* temperature scale
82  - 0: none
83  - 1: Kelvin
84  - 2: Celsius */
85  int iscalt; /* index of the thermal scalar (temperature,
86  energy or enthalpy), the index of the
87  corresponding variable is isca(iscalt) */
88 
90 
91 /*============================================================================
92  * Static global variables
93  *============================================================================*/
94 
95 /* Pointer to thermal model structure */
96 
98 
99 /*=============================================================================
100  * Public function prototypes
101  *============================================================================*/
102 
103 /*----------------------------------------------------------------------------
104  * Provide access to cs_glob_thermal_model
105  *
106  * needed to initialize structure with GUI
107  *----------------------------------------------------------------------------*/
108 
111 
112 /*----------------------------------------------------------------------------
113  * Return thermal field (temperature, enthalpy, total energy according to
114  * thermal model).
115  *
116  * returns:
117  * pointer to thermal field
118  *----------------------------------------------------------------------------*/
119 
120 cs_field_t *
122 
123 /*----------------------------------------------------------------------------
124  * Print the thermal model structure to setup.log.
125  *----------------------------------------------------------------------------*/
126 
127 void
129 
130 /*----------------------------------------------------------------------------*/
131 
133 
134 #endif /* __CS_THERMAL_MODEL_H__ */
Definition: cs_thermal_model.h:64
Definition: cs_thermal_model.h:58
cs_field_t * cs_thermal_model_field(void)
Definition: cs_thermal_model.c:205
Definition: cs_thermal_model.h:54
Field descriptor.
Definition: cs_field.h:124
void cs_thermal_model_log_setup(void)
Definition: cs_thermal_model.c:245
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
Definition: cs_thermal_model.h:56
cs_temperature_scale_t
Definition: cs_thermal_model.h:62
Definition: cs_thermal_model.h:55
Definition: cs_thermal_model.h:57
Definition: cs_thermal_model.h:65
int itherm
Definition: cs_thermal_model.h:75
#define END_C_DECLS
Definition: cs_defs.h:454
cs_thermal_model_t * cs_get_glob_thermal_model(void)
Definition: cs_thermal_model.c:233
Thermal model descriptor.
Definition: cs_thermal_model.h:73
int iscalt
Definition: cs_thermal_model.h:85
Definition: cs_thermal_model.h:66
const cs_thermal_model_t * cs_glob_thermal_model
int itpscl
Definition: cs_thermal_model.h:81
cs_thermal_model_variable_t
Definition: cs_thermal_model.h:52