src/gui/cs_gui_variables.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_gui_variables.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_VARIABLES_H__
2 #define __CS_GUI_VARIABLES_H__
3
4 /*============================================================================
5 * Management of the GUI parameters file: variables
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_base.h"
35
36 /*----------------------------------------------------------------------------*/
37
38 BEGIN_C_DECLS
39
40 /*============================================================================
41 * Type definitions
42 *============================================================================*/
43
44 /*----------------------------------------------------------------------------
45 * Variables and scalars management structure
46 *----------------------------------------------------------------------------*/
47
48 typedef struct {
49 char *model; /* predifined physics model */
50 char *model_value; /* predifined physics model value */
51 char **head; /* name of the head */
52 char **type; /* type of markup: 'variable' or 'scalar' */
53 char **name; /* variables name and scalars label */
54 char **label; /* scalars label */
55 int *rtp; /* variables position in fortran array RTP */
56 int nvar; /* total number of variables and scalars */
57 int nscaus; /* number of user scalars */
58 int nscapp; /* number of specific physics scalars */
59 int nprop; /* number of properties */
60 int nsalpp; /* number of predifined physics properties */
61 int nprayc; /* number of cell's radiative properties */
62 int ntimaver; /* number of time averages */
63 char **properties_name; /* label of properties */
64 int *properties_ipp; /* properties position for post-processing */
65 int *propce; /* properties position in fortran array PROPCE */
66 char **b_prop_name; /* label of boundary faces properties */
67 int *b_prop_ipp; /* boundary faces prop position for post */
68 } cs_var_t;
69
70
71 typedef struct {
72 int _cs_gui_max_vars;
73 int _cs_gui_last_var;
74 char **_cs_gui_var_name;
75 } cs_label_t;
76
77 /*============================================================================
78 * Static global variables
79 *============================================================================*/
80
81 extern cs_var_t *cs_glob_var; /* Pointer to main variables structure */
82 extern cs_label_t *cs_glob_label; /* Pointer to main label structure */
83
84 /*============================================================================
85 * Public function prototypes for Fortran API
86 *============================================================================*/
87
88 /*=============================================================================
89 * Public function prototypes
90 *============================================================================*/
91
92 /*----------------------------------------------------------------------------*/
93
94 END_C_DECLS
95
96 #endif /* __CS_GUI_VARIABLES_H__ */