programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_parameters.h
Go to the documentation of this file.
1 #ifndef __CS_PARAMETERS_H__
2 #define __CS_PARAMETERS_H__
3 
4 /*============================================================================
5  * General parameters management.
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 /*=============================================================================
41  * Macro definitions
42  *============================================================================*/
43 
44 /*============================================================================
45  * Type definitions
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Structure of variable calculation options
50  *----------------------------------------------------------------------------*/
51 
52 typedef struct {
53  int iwarni;
54  int iconv ;
55  int istat ;
56  int idiff ;
57  int idifft;
58  int idften;
59  int iswdyn;
60  int ischcv;
61  int isstpc;
62  int nswrgr;
63  int nswrsm;
64  int imligr;
65  int ircflu;
66  int inc ;
67  double thetav;
68  double blencv;
69  double epsilo;
70  double epsrsm;
71  double epsrgr;
72  double climgr;
73  double extrag;
74  double relaxv;
76 
77 /*----------------------------------------------------------------------------
78  * Boundary condition types
79  *----------------------------------------------------------------------------*/
80 
81 enum {
82  CS_INDEF = 1,
83  CS_INLET = 2,
84  CS_OUTLET = 3,
88  CS_ESICF = 7,
89  CS_SSPCF = 8,
90  CS_SOPCF = 9,
91  CS_ERUCF = 10,
92  CS_EPHCF = 11,
93  CS_EQHCF = 12,
94  CS_COUPLED = 13,
96 };
97 
98 /*=============================================================================
99  * Public function prototypes
100  *============================================================================*/
101 
102 /*----------------------------------------------------------------------------
103  * Define general field keys.
104  *
105  * A recommened practice for different submodules would be to use
106  * "cs_<module>_key_init() functions to define keys specific to those modules.
107  *----------------------------------------------------------------------------*/
108 
109 void
111 
112 /*----------------------------------------------------------------------------*/
113 
115 
116 #endif /* __CS_PARAMETERS_H__ */