My Project
programmer's documentation
cs_gui_specific_physics.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_SPECIFIC_PHYSICS_H__
2 #define __CS_GUI_SPECIFIC_PHYSICS_H__
3 
4 /*============================================================================
5  * Management of the GUI parameters file: specific physics
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2019 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  * Public Fortran function prototypes
46  *============================================================================*/
47 
48 /*----------------------------------------------------------------------------
49  * Density under relaxation
50  *
51  * Fortran Interface:
52  *
53  * SUBROUTINE UICPI1 (SRROM)
54  * *****************
55  * DOUBLE PRECISION SRROM <-- density relaxation
56  * DOUBLE PRECISION DIFTL0 <-- dynamic diffusion
57  *----------------------------------------------------------------------------*/
58 
59 void CS_PROCF (uicpi1, UICPI1) (double *const srrom,
60  double *const diftl0);
61 
62 /*----------------------------------------------------------------------------
63  * Temperature for D3P Gas Combustion
64  *
65  * Fortran Interface:
66  *
67  * SUBROUTINE UICPI2 (SRROM)
68  * *****************
69  * DOUBLE PRECISION Toxy <-- Oxydant temperature
70  * DOUBLE PRECISION Tfuel <-- Fuel temperature
71  *----------------------------------------------------------------------------*/
72 
73 void CS_PROCF (uicpi2, UICPI2) (double *const toxy,
74  double *const tfuel);
75 
76 /*----------------------------------------------------------------------------
77  * Atmospheric flows: read of meteorological file of data
78  *
79  * Fortran Interface:
80  *
81  * subroutine uiati1
82  * *****************
83  * integer imeteo <-- on/off index
84  * char(*) fmeteo <-- meteo file name
85  * int len <-- meteo file name destination string length
86  *----------------------------------------------------------------------------*/
87 
88 void CS_PROCF (uiati1, UIATI1) (int *imeteo,
89  char *fmeteo,
90  int *len
91  CS_ARGF_SUPP_CHAINE);
92 
93 /*----------------------------------------------------------------------------
94  * Indirection between the solver numbering and the XML one
95  * for physical properties of the activated specific physics
96  * (pulverized solid fuels)
97  *----------------------------------------------------------------------------*/
98 
99 void CS_PROCF (uisofu, UISOFU) (const int *iirayo,
100  const int *iihmpr,
101  const int *ncharm,
102  int *ncharb,
103  int *nclpch,
104  int *nclacp,
105  const int *ncpcmx,
106  int *ichcor,
107  double *diam20,
108  double *cch,
109  double *hch,
110  double *och,
111  double *nch,
112  double *sch,
113  int *ipci,
114  double *pcich,
115  double *cp2ch,
116  double *rho0ch,
117  double *thcdch,
118  double *cck,
119  double *hck,
120  double *ock,
121  double *nck,
122  double *sck,
123  double *xashch,
124  double *xashsec,
125  double *xwatch,
126  double *h0ashc,
127  double *cpashc,
128  int *iy1ch,
129  double *y1ch,
130  int *iy2ch,
131  double *y2ch,
132  double *a1ch,
133  double *a2ch,
134  double *e1ch,
135  double *e2ch,
136  double *crepn1,
137  double *crepn2,
138  double *ahetch,
139  double *ehetch,
140  int *iochet,
141  double *ahetc2,
142  double *ehetc2,
143  int *ioetc2,
144  double *ahetwt,
145  double *ehetwt,
146  int *ioetwt,
147  int *ieqnox,
148  int *ieqco2,
149  int *imdnox,
150  int *irb,
151  int *ihtco2,
152  int *ihth2o,
153  double *qpr,
154  double *fn,
155  double *ckabs1,
156  int *noxyd,
157  double *oxyo2,
158  double *oxyn2,
159  double *oxyh2o,
160  double *oxyco2,
161  double *repnck,
162  double *repnle,
163  double *repnlo);
164 
165 /*----------------------------------------------------------------------------
166  * Copy name of thermophysical data file from C to Fortran
167  *----------------------------------------------------------------------------*/
168 
169 void CS_PROCF(cfnmtd, CFNMTD) (char *fstr, /* --> Fortran string */
170  int *len /* --> String Length */
171  CS_ARGF_SUPP_CHAINE);
172 
173 /*----------------------------------------------------------------------------
174  * groundwater model : read parameters
175  *
176  * Fortran Interface:
177  *
178  * subroutine uidai1
179  * *****************
180  * integer permeability <-- permeability type
181  * integer dispersion <-- dispersion type
182  * integer unsteady <-- steady flow
183  * integer gravity <-- check if gravity is taken into account
184  * integer unsaturated <-- take into account unsaturated zone
185  *----------------------------------------------------------------------------*/
186 
187 void CS_PROCF (uidai1, UIDAI1) (int *permeability,
188  int *dispersion,
189  int *unsteady,
190  int *gravity,
191  int *unsaturated);
192 
193 /*=============================================================================
194  * Public function prototypes
195  *============================================================================*/
196 
197 /*-----------------------------------------------------------------------------
198  * Activate specific physical models based on XML settings.
199  *----------------------------------------------------------------------------*/
200 
201 void
202 cs_gui_physical_model_select(void);
203 
204 /*----------------------------------------------------------------------------
205  * Electrical model: read parameters
206  *----------------------------------------------------------------------------*/
207 
208 void
209 cs_gui_elec_model(void);
210 
211 /*----------------------------------------------------------------------------
212  * Electrical model: define plane for elreca
213  *----------------------------------------------------------------------------*/
214 
215 void
216 cs_gui_elec_model_rec(void);
217 
218 /*-----------------------------------------------------------------------------
219  * Return the name of a thermophysical model.
220  *
221  * parameter:
222  * model_thermo --> thermophysical model category
223  *----------------------------------------------------------------------------*/
224 
225 const char *
226 cs_gui_get_thermophysical_model(const char *model_thermo);
227 
228 /*-----------------------------------------------------------------------------
229  * Return 1 if a specific physics model is activated, 0 othewise.
230  *
231  * Updates the cs_glob_vars global structure.
232  *----------------------------------------------------------------------------*/
233 
234 int
235 cs_gui_get_activ_thermophysical_model(void);
236 
237 /*----------------------------------------------------------------------------*/
238 
239 END_C_DECLS
240 
241 #endif /* __CS_GUI_SPECIFIC_PHYSICS_H__ */
sch
void const int const int int int int const int int double double double double double double * sch
Definition: cs_gui_specific_physics.h:112
gravity
void int int int * gravity
Definition: cs_gui_specific_physics.h:190
cs_gui_physical_model_select
void cs_gui_physical_model_select(void)
Definition: cs_gui_specific_physics.c:1257
sck
void const int const int int int int const int int double double double double double double int double double double double double double double double double * sck
Definition: cs_gui_specific_physics.h:122
cs_gui_get_thermophysical_model
const char * cs_gui_get_thermophysical_model(const char *model_thermo)
Definition: cs_gui_specific_physics.c:1516
nch
void const int const int int int int const int int double double double double double * nch
Definition: cs_gui_specific_physics.h:111
repnlo
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double double double double double double * repnlo
Definition: cs_gui_specific_physics.h:163
ihtco2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int * ihtco2
Definition: cs_gui_specific_physics.h:151
len
size_t len
Definition: mei_scanner.c:560
crepn1
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double * crepn1
Definition: cs_gui_specific_physics.h:136
oxyn2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double * oxyn2
Definition: cs_gui_specific_physics.h:158
h0ashc
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double * h0ashc
Definition: cs_gui_specific_physics.h:126
diam20
void const int const int int int int const int int double * diam20
Definition: cs_gui_specific_physics.h:107
e2ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double * e2ch
Definition: cs_gui_specific_physics.h:135
cpashc
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double * cpashc
Definition: cs_gui_specific_physics.h:127
unsteady
void int int * unsteady
Definition: cs_gui_specific_physics.h:189
repnck
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double double double double * repnck
Definition: cs_gui_specific_physics.h:161
ehetch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double * ehetch
Definition: cs_gui_specific_physics.h:139
ahetc2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double * ahetc2
Definition: cs_gui_specific_physics.h:141
och
void const int const int int int int const int int double double double double * och
Definition: cs_gui_specific_physics.h:110
imdnox
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int * imdnox
Definition: cs_gui_specific_physics.h:149
qpr
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double * qpr
Definition: cs_gui_specific_physics.h:153
ncharb
void const int const int int * ncharb
Definition: cs_gui_specific_physics.h:102
cs_gui_get_activ_thermophysical_model
int cs_gui_get_activ_thermophysical_model(void)
Definition: cs_gui_specific_physics.c:1540
ieqnox
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int * ieqnox
Definition: cs_gui_specific_physics.h:147
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
nclacp
void const int const int int int int * nclacp
Definition: cs_gui_specific_physics.h:104
a2ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double * a2ch
Definition: cs_gui_specific_physics.h:133
noxyd
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int * noxyd
Definition: cs_gui_specific_physics.h:156
y1ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double * y1ch
Definition: cs_gui_specific_physics.h:129
ipci
void const int const int int int int const int int double double double double double double int * ipci
Definition: cs_gui_specific_physics.h:113
nck
void const int const int int int int const int int double double double double double double int double double double double double double double double * nck
Definition: cs_gui_specific_physics.h:121
oxyh2o
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double double * oxyh2o
Definition: cs_gui_specific_physics.h:159
xashch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double * xashch
Definition: cs_gui_specific_physics.h:123
rho0ch
void const int const int int int int const int int double double double double double double int double double double * rho0ch
Definition: cs_gui_specific_physics.h:116
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
ieqco2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int * ieqco2
Definition: cs_gui_specific_physics.h:148
cs_gui_elec_model
void cs_gui_elec_model(void)
Definition: cs_gui_specific_physics.c:1403
ahetwt
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double * ahetwt
Definition: cs_gui_specific_physics.h:144
crepn2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double * crepn2
Definition: cs_gui_specific_physics.h:137
ehetwt
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double * ehetwt
Definition: cs_gui_specific_physics.h:145
e1ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double * e1ch
Definition: cs_gui_specific_physics.h:134
pcich
void const int const int int int int const int int double double double double double double int double * pcich
Definition: cs_gui_specific_physics.h:114
a1ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double * a1ch
Definition: cs_gui_specific_physics.h:132
y2ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double * y2ch
Definition: cs_gui_specific_physics.h:131
ncharm
void const int const int * ncharm
Definition: cs_gui_specific_physics.h:101
cck
void const int const int int int int const int int double double double double double double int double double double double double * cck
Definition: cs_gui_specific_physics.h:118
ioetc2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int * ioetc2
Definition: cs_gui_specific_physics.h:143
ehetc2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double * ehetc2
Definition: cs_gui_specific_physics.h:142
fn
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double * fn
Definition: cs_gui_specific_physics.h:154
fmeteo
void char * fmeteo
Definition: cs_gui_specific_physics.h:89
irb
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int * irb
Definition: cs_gui_specific_physics.h:150
iy1ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int * iy1ch
Definition: cs_gui_specific_physics.h:128
iy2ch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int * iy2ch
Definition: cs_gui_specific_physics.h:130
cch
void const int const int int int int const int int double double * cch
Definition: cs_gui_specific_physics.h:108
hck
void const int const int int int int const int int double double double double double double int double double double double double double * hck
Definition: cs_gui_specific_physics.h:119
oxyo2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double * oxyo2
Definition: cs_gui_specific_physics.h:157
thcdch
void const int const int int int int const int int double double double double double double int double double double double * thcdch
Definition: cs_gui_specific_physics.h:117
ioetwt
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int * ioetwt
Definition: cs_gui_specific_physics.h:146
ppincl::srrom
double precision, save srrom
Definition: ppincl.f90:732
cp2ch
void const int const int int int int const int int double double double double double double int double double * cp2ch
Definition: cs_gui_specific_physics.h:115
oxyco2
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double double double * oxyco2
Definition: cs_gui_specific_physics.h:160
iihmpr
void const int * iihmpr
Definition: cs_gui_specific_physics.h:100
ock
void const int const int int int int const int int double double double double double double int double double double double double double double * ock
Definition: cs_gui_specific_physics.h:120
atincl::imeteo
integer, save imeteo
imeteo --> flag for reading the meteo input file
Definition: atincl.f90:116
xwatch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double * xwatch
Definition: cs_gui_specific_physics.h:125
ihth2o
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int * ihth2o
Definition: cs_gui_specific_physics.h:152
ichcor
void const int const int int int int const int int * ichcor
Definition: cs_gui_specific_physics.h:106
repnle
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double int double double double double double double * repnle
Definition: cs_gui_specific_physics.h:162
ncpcmx
void const int const int int int int const int * ncpcmx
Definition: cs_gui_specific_physics.h:105
unsaturated
void int int int int * unsaturated
Definition: cs_gui_specific_physics.h:191
nclpch
void const int const int int int * nclpch
Definition: cs_gui_specific_physics.h:103
dispersion
void int * dispersion
Definition: cs_gui_specific_physics.h:188
ckabs1
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int double double int double double int int int int int int int double double double * ckabs1
Definition: cs_gui_specific_physics.h:155
tfuel
void double *const tfuel
Definition: cs_gui_specific_physics.h:74
iochet
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double double int * iochet
Definition: cs_gui_specific_physics.h:140
radiat::iirayo
integer(c_int), pointer, save iirayo
Activation of the radiative transfer module:
Definition: radiat.f90:45
xashsec
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double * xashsec
Definition: cs_gui_specific_physics.h:124
diftl0
void double *const diftl0
Definition: cs_gui_specific_physics.h:60
cs_gui_elec_model_rec
void cs_gui_elec_model_rec(void)
Definition: cs_gui_specific_physics.c:1477
cs_base.h
hch
void const int const int int int int const int int double double double * hch
Definition: cs_gui_specific_physics.h:109
ahetch
void const int const int int int int const int int double double double double double double int double double double double double double double double double double double double double double int double int double double double double double double double double * ahetch
Definition: cs_gui_specific_physics.h:138
CS_ARGF_SUPP_CHAINE
void char int *len CS_ARGF_SUPP_CHAINE
Definition: cs_gui_specific_physics.h:91
CS_PROCF
void CS_PROCF(uicpi1, UICPI1)(double *const srrom
Generated on Wed May 13 2020 17:46:36 for My Project by   doxygen 1.8.17