8.0
general documentation
Loading...
Searching...
No Matches
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-2023 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#include "cs_field.h"
36
37/*----------------------------------------------------------------------------*/
38
40
41/*=============================================================================
42 * Macro definitions
43 *============================================================================*/
44
45/*============================================================================
46 * Type definitions
47 *============================================================================*/
48
49/*----------------------------------------------------------------------------
50 * Thermal model type
51 *----------------------------------------------------------------------------*/
52
62
70
71/* thermal model descriptor */
72/*--------------------------*/
73
74typedef struct {
75
76 union {
78 int itherm;
79 };
80
81 union {
83 int itpscl;
84 };
85
87
88/*============================================================================
89 * Static global variables
90 *============================================================================*/
91
92/* Pointer to thermal model structure */
93
95
96/*=============================================================================
97 * Public function prototypes
98 *============================================================================*/
99
100/*----------------------------------------------------------------------------
101 * Provide access to cs_glob_thermal_model
102 *
103 * needed to initialize structure with GUI
104 *----------------------------------------------------------------------------*/
105
108
109/*----------------------------------------------------------------------------
110 * Return thermal field (temperature, enthalpy, total energy according to
111 * thermal model).
112 *
113 * returns:
114 * pointer to thermal field
115 *----------------------------------------------------------------------------*/
116
119
120/*----------------------------------------------------------------------------
121 * Print the thermal model structure to setup.log.
122 *----------------------------------------------------------------------------*/
123
124void
126
127/*----------------------------------------------------------------------------*/
128
130
131#endif /* __CS_THERMAL_MODEL_H__ */
#define BEGIN_C_DECLS
Definition cs_defs.h:509
#define END_C_DECLS
Definition cs_defs.h:510
void cs_thermal_model_log_setup(void)
Definition cs_thermal_model.c:219
cs_field_t * cs_thermal_model_field(void)
Definition cs_thermal_model.c:179
cs_thermal_model_t * cs_get_glob_thermal_model(void)
Definition cs_thermal_model.c:207
const cs_thermal_model_t * cs_glob_thermal_model
cs_temperature_scale_t
Definition cs_thermal_model.h:63
@ CS_TEMPERATURE_SCALE_CELSIUS
Definition cs_thermal_model.h:67
@ CS_TEMPERATURE_SCALE_KELVIN
Definition cs_thermal_model.h:66
@ CS_TEMPERATURE_SCALE_NONE
Definition cs_thermal_model.h:65
cs_thermal_model_variable_t
Definition cs_thermal_model.h:53
@ CS_THERMAL_MODEL_ENTHALPY
Definition cs_thermal_model.h:57
@ CS_THERMAL_MODEL_TEMPERATURE
Definition cs_thermal_model.h:56
@ CS_THERMAL_MODEL_N_TYPES
Definition cs_thermal_model.h:59
@ CS_THERMAL_MODEL_NONE
Definition cs_thermal_model.h:55
@ CS_THERMAL_MODEL_TOTAL_ENERGY
Definition cs_thermal_model.h:58
Field descriptor.
Definition cs_field.h:130
Thermal model descriptor.
Definition cs_thermal_model.h:74
int itpscl
Definition cs_thermal_model.h:83
int itherm
Definition cs_thermal_model.h:78
cs_temperature_scale_t temperature_scale
Definition cs_thermal_model.h:82
cs_thermal_model_variable_t thermal_variable
Definition cs_thermal_model.h:77