programmer's documentation
 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 
39 
40 typedef enum {
41 
49 
51 
52 typedef enum {
53 
67 
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
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 
100 
101 #endif /* __CS_PHYSICAL_PROPERTIES_H__ */