programmer's documentation
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-2015 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  * Define thermal table.
76  *----------------------------------------------------------------------------*/
77 
78 void
79 cs_thermal_table_set(const char *material,
80  const char *method,
81  const char *phas,
82  const char *reference,
84  const int temp_scale);
85 
86 /*----------------------------------------------------------------------------
87  * Finalize thermal table
88  *----------------------------------------------------------------------------*/
89 
90 void
92 
93 /*----------------------------------------------------------------------------
94  * Compute a property with table.
95  *
96  * property <-- property queried
97  * n_vals <-- number of values
98  * var1 <-- values on first plane axis
99  * var2 <-- values on second plane axis
100  * val --> resulting property values
101  *----------------------------------------------------------------------------*/
102 
103 void
105  const cs_lnum_t n_vals,
106  const cs_real_t var1[],
107  const cs_real_t var2[],
108  cs_real_t val[]);
109 
110 /*----------------------------------------------------------------------------
111  * Compute properties with Freesteam in a defined thermal plane.
112  *
113  * parameters:
114  * thermo_plane <-- thermodynamic plane
115  * property <-- property queried
116  * n_vals <-- number of values
117  * var1 <-- values on first plane axis
118  * var2 <-- values on second plane axis
119  * val --> resulting property values
120  *
121  * returns:
122  * floating point value associated with the key id for this field
123  *----------------------------------------------------------------------------*/
124 
125 void
127  cs_phys_prop_type_t property,
128  const cs_lnum_t n_vals,
129  const cs_real_t var1[],
130  const cs_real_t var2[],
131  cs_real_t val[]);
132 
133 /*----------------------------------------------------------------------------*/
134 
136 
137 #endif /* __CS_PHYSICAL_PROPERTIES_H__ */
Definition: cs_physical_properties.h:57
Definition: cs_physical_properties.h:61
cs_phys_prop_type_t
Definition: cs_physical_properties.h:52
Definition: cs_physical_properties.h:45
#define BEGIN_C_DECLS
Definition: cs_defs.h:429
Definition: cs_physical_properties.h:59
Definition: cs_physical_properties.h:63
Definition: cs_physical_properties.h:65
void cs_thermal_table_set(const char *material, const char *method, const char *phas, const char *reference, cs_phys_prop_thermo_plane_type_t thermo_plane, const int temp_scale)
Define thermal table.
Definition: cs_physical_properties.c:278
Definition: cs_physical_properties.h:60
cs_phys_prop_thermo_plane_type_t
Definition: cs_physical_properties.h:40
Definition: cs_physical_properties.h:44
Definition: cs_physical_properties.h:56
Definition: cs_physical_properties.h:64
void cs_phys_prop_freesteam(cs_phys_prop_thermo_plane_type_t thermo_plane, cs_phys_prop_type_t property, const cs_lnum_t n_vals, const cs_real_t var1[], const cs_real_t var2[], cs_real_t val[])
Compute properties with Freesteam in a defined thermal plane.
Definition: cs_physical_properties.c:496
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:292
void cs_phys_prop_compute(cs_phys_prop_type_t property, const cs_lnum_t n_vals, const cs_real_t var1[], const cs_real_t var2[], cs_real_t val[])
Compute a property.
Definition: cs_physical_properties.c:436
#define END_C_DECLS
Definition: cs_defs.h:430
Definition: cs_physical_properties.h:62
double cs_real_t
Definition: cs_defs.h:296
Definition: cs_physical_properties.h:46
Definition: cs_physical_properties.h:43
Definition: cs_physical_properties.h:48
Definition: cs_physical_properties.h:42
Definition: cs_physical_properties.h:47
void cs_thermal_table_finalize(void)
finalize thermal table.
Definition: cs_physical_properties.c:393
Definition: cs_physical_properties.h:55
Definition: cs_physical_properties.h:66
Definition: cs_physical_properties.h:54
Definition: cs_physical_properties.h:58