7.2
general documentation
cs_eos.hxx
Go to the documentation of this file.
1 #ifndef __CS_EOS_HXX__
2 #define __CS_EOS_HXX__
3 
4 /*============================================================================
5  * Equation of state
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2022 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  * Standard C library headers
32  *----------------------------------------------------------------------------*/
33 
34 /*----------------------------------------------------------------------------
35  * Local headers
36  *----------------------------------------------------------------------------*/
37 
38 #include "cs_physical_properties.h"
39 
40 #include "cs_base.h"
41 
42 /*----------------------------------------------------------------------------*/
43 
44 /*=============================================================================
45  * Local Macro Definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Structure definition
50  *============================================================================*/
51 
52 /*============================================================================
53  * Global variables definition
54  *============================================================================*/
55 
56 /*============================================================================
57  * Public function prototypes
58  *============================================================================*/
59 
60 /*----------------------------------------------------------------------------
61  * Define new EOS instances
62  *
63  * parameters:
64  * EOSMethod <-- table for EOS thermo properties (CATHARE, THETIS, ...)
65  * EOSRef <-- reference table for EOS thermo properties
66  *----------------------------------------------------------------------------*/
67 
68 #ifdef __cplusplus
69 extern "C"
70 #endif
71 void
72 cs_eos_create(const char *EOSMethod,
73  char *EOSRef);
74 
75 /*----------------------------------------------------------------------------
76  * Delete EOS instances
77  *----------------------------------------------------------------------------*/
78 
79 #ifdef __cplusplus
80 extern "C"
81 #endif
82 void
83 cs_eos_destroy(void);
84 
85 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 #ifdef __cplusplus
100 extern "C"
101 #endif
102 void
103 cs_phys_prop_eos(cs_phys_prop_thermo_plane_type_t thermo_plane,
104  cs_phys_prop_type_t property,
105  const cs_lnum_t n_vals,
106  double var1[],
107  double var2[],
108  cs_real_t val[]);
109 
110 /*----------------------------------------------------------------------------*/
111 
112 #endif /* __CS_EOS_HXX__ */
cs_eos_destroy
void cs_eos_destroy(void)
Definition: cs_eos.cxx:152
cs_base.h
cs_phys_prop_type_t
cs_phys_prop_type_t
Definition: cs_physical_properties.h:52
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_physical_properties.h
cs_phys_prop_thermo_plane_type_t
cs_phys_prop_thermo_plane_type_t
Definition: cs_physical_properties.h:40
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:316
cs_phys_prop_eos
void cs_phys_prop_eos(cs_phys_prop_thermo_plane_type_t thermo_plane, cs_phys_prop_type_t property, const cs_lnum_t n_vals, double var1[], double var2[], cs_real_t val[])
Computes physical properties in (P,h,Yi) for compressible flow.
Definition: cs_eos.cxx:175
cs_eos_create
void cs_eos_create(const char *EOSMethod, char *EOSRef)
Definition: cs_eos.cxx:138