src/base/cs_physical_properties.h Source File

| programmer's documentation

- Main Page
- Related Pages
- Modules
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_physical_properties.h
Go to the documentation of this file.
1 #ifndef __CS_PHYSICAL_PROPERTIES_H__
2 #define __CS_PHYSICAL_PROPERTIES_H__
3
4 /*============================================================================
5 * Functions dealing with parallelism
6 *============================================================================*/
7
8 /*
9 This file is part of Code_Saturne, a general-purpose CFD tool.
10
11 Copyright (C) 1998-2013 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
38 BEGIN_C_DECLS
39
40 typedef enum {
41
42 CS_PHYS_PROP_PLANE_PH,
43 CS_PHYS_PROP_PLANE_PT,
44 CS_PHYS_PROP_PLANE_PS,
45 CS_PHYS_PROP_PLANE_PU,
46 CS_PHYS_PROP_PLANE_PV,
47 CS_PHYS_PROP_PLANE_TS,
48 CS_PHYS_PROP_PLANE_TX,
49
50 } cs_phys_prop_thermo_plane_type_t;
51
52 typedef enum {
53
54 CS_PHYS_PROP_PRESSURE,
55 CS_PHYS_PROP_TEMPERATURE,
56 CS_PHYS_PROP_ENTHALPY,
57 CS_PHYS_PROP_ENTROPY,
58 CS_PHYS_PROP_ISOBARIC_HEAT_CAPACITY,
59 CS_PHYS_PROP_ISOCHORIC_HEAT_CAPACITY,
60 CS_PHYS_PROP_SPECIFIC_VOLUME,
61 CS_PHYS_PROP_DENSITY,
62 CS_PHYS_PROP_INTERNAL_ENERGY,
63 CS_PHYS_PROP_QUALITY,
64 CS_PHYS_PROP_THERMAL_CONDUCTIVITY,
65 CS_PHYS_PROP_DYNAMIC_VISCOSITY,
66 CS_PHYS_PROP_SPEED_OF_SOUND
67
68 } cs_phys_prop_type_t;
69
70 /*=============================================================================
71 * Public function prototypes
72 *============================================================================*/
73
74 /*----------------------------------------------------------------------------
75 * Compute properties with Freesteam in a defined thermal plane.
76 *
77 * parameters:
78 * thermo_plane <-- thermodynamic plane
79 * property <-- property queried
80 * n_vals <-- number of values
81 * var1 <-- values on first plane axis
82 * var2 <-- values on second plane axis
83 * val --> resulting property values
84 *
85 * returns:
86 * floating point value associated with the key id for this field
87 *----------------------------------------------------------------------------*/
88
89 void
90 cs_phys_prop_freesteam(cs_phys_prop_thermo_plane_type_t thermo_plane,
91 cs_phys_prop_type_t property,
92 const cs_lnum_t n_vals,
93 const cs_real_t var1[],
94 const cs_real_t var2[],
95 cs_real_t val[]);
96
97 /*----------------------------------------------------------------------------*/
98
99 END_C_DECLS
100
101 #endif /* __CS_PHYSICAL_PROPERTIES_H__ */