programmer's documentation
cs_physical_constants.h
Go to the documentation of this file.
1 #ifndef __CS_PHYSICAL_CONSTANTS_H__
2 #define __CS_PHYSICAL_CONSTANTS_H__
3 
4 /*============================================================================
5  * Base physical constants data.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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 /* physical constants descriptor */
49 /*-------------------------------*/
50 
51 typedef struct {
52 
53  double gx, gy, gz; /* gravity components */
54  int icorio; /* Coriolis source terms indicator */
55 
57 
58 /* fluid properties descriptor */
59 /*-----------------------------*/
60 
61 typedef struct {
62 
63  int ixyzp0; /* indicator for filling of reference point for
64  total pressure */
65  double ro0; /* reference density */
66  double viscl0; /* reference molecular dynamic viscosity */
67  double p0; /* reference pressure for the total pressure */
68  double pred0; /* reference value for the reduced pressure */
69  double xyzp0[3]; /* reference point coordinates for the total
70  pressure */
71  double t0; /* reference temperature */
72  double cp0; /* reference specific heat */
73  double xmasmr; /* molar mass of the perfect gas in kg/mol
74  (if ieos=1) */
75  double pther; /* uniform thermodynamic pressure for the low-Mach
76  algorithm */
77  double pthera; /* thermodynamic pressure for the previous time
78  step */
79  double pthermax; /* thermodynamic maximum pressure for user
80  clipping, used to model a venting effect */
81 
83 
84 /*============================================================================
85  * Static global variables
86  *============================================================================*/
87 
88 /* Pointer to main physical constants structure */
89 
91 
92 /* Pointer to main fluid properties structure */
93 
95 
96 /*=============================================================================
97  * Public function prototypes
98  *============================================================================*/
99 
100 /*----------------------------------------------------------------------------*/
101 
103 
104 #endif /* __CS_PHYSICAL_CONSTANTS_H__ */
real(c_double), pointer, save gy
Definition: cstphy.f90:65
Fluid properties descriptor.
Definition: cs_physical_constants.h:61
int ixyzp0
Definition: cs_physical_constants.h:63
double cp0
Definition: cs_physical_constants.h:72
real(c_double), dimension(:), pointer, save xyzp0
coordinates of the reference point for the total pressure.
Definition: cstphy.f90:153
#define BEGIN_C_DECLS
Definition: cs_defs.h:419
double xmasmr
Definition: cs_physical_constants.h:73
const cs_physical_constants_t * cs_glob_physical_constants
double t0
Definition: cs_physical_constants.h:71
double pthermax
Definition: cs_physical_constants.h:79
const cs_fluid_properties_t * cs_glob_fluid_properties
Definition: cs_physical_constants.c:257
int icorio
Definition: cs_physical_constants.h:54
double pther
Definition: cs_physical_constants.h:75
real(c_double), pointer, save gx
Gravity.
Definition: cstphy.f90:65
double viscl0
Definition: cs_physical_constants.h:66
#define END_C_DECLS
Definition: cs_defs.h:420
double pthera
Definition: cs_physical_constants.h:77
double p0
Definition: cs_physical_constants.h:67
Physical constants descriptor.
Definition: cs_physical_constants.h:51
double gz
Definition: cs_physical_constants.h:53
double pred0
Definition: cs_physical_constants.h:68
double ro0
Definition: cs_physical_constants.h:65