My Project
programmer's documentation
•All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
cs_cf_model.h
Go to the documentation of this file.
1 #ifndef __CS_CF_MODEL_H__
2 #define __CS_CF_MODEL_H__
3 
4 /*============================================================================
5  * Thermodynamic laws for the compressible module
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2019 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 #include "cs_defs.h"
32 
33 /*----------------------------------------------------------------------------
34  * Standard C library headers
35  *----------------------------------------------------------------------------*/
36 
37 /*----------------------------------------------------------------------------
38  * Local headers
39  *----------------------------------------------------------------------------*/
40 
41 /*----------------------------------------------------------------------------*/
42 
43 BEGIN_C_DECLS
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /* compressible model general options descriptor */
50 /*-----------------------------------------------*/
51 
52 typedef struct {
53 
54  int ieos; /* indicator of equation of state */
55 
56  int ithvar; /* indicator for thermodynamic
57  variables initialization */
58 
59  double psginf; /* stiffened gas limit pressure (zero in
60  perfect gas) (Pa) for single phase model */
61 
62  double gammasg; /* stiffened gas polytropic coefficient,
63  (dimensionless) for single phase model */
64 
65  int hgn_relax_eq_st; /* source term step:
66  - -1 disabled
67  - 0 enabled
68  */
69 
70 } cs_cf_model_t;
71 
72 /*============================================================================
73  * Static global variables
74  *============================================================================*/
75 
76 /* pointer to main compressible model descriptor structure */
77 
78 extern const cs_cf_model_t *cs_glob_cf_model;
79 
80 /*=============================================================================
81  * Public function definitions
82  *============================================================================*/
83 
84 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 cs_cf_model_t *
91 cs_get_glob_cf_model(void);
92 
93 /*----------------------------------------------------------------------------*/
94 
95 END_C_DECLS
96 
97 #endif /* __CS_CF_MODEL_H__ */
cs_defs.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_glob_cf_model
const cs_cf_model_t * cs_glob_cf_model
cs_cf_model_t::gammasg
double gammasg
Definition: cs_cf_model.h:62
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_cf_model_t::ithvar
int ithvar
Definition: cs_cf_model.h:56
cs_get_glob_cf_model
cs_cf_model_t * cs_get_glob_cf_model(void)
Provide access to compressible model global structure cs_glob_cf_model.
Definition: cs_cf_model.c:187
cs_cf_model_t::psginf
double psginf
Definition: cs_cf_model.h:59
cs_cf_model_t::ieos
int ieos
Definition: cs_cf_model.h:54
cs_cf_model_t::hgn_relax_eq_st
int hgn_relax_eq_st
Definition: cs_cf_model.h:65
cs_cf_model_t
Compressible model general options descriptor.
Definition: cs_cf_model.h:52
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16