programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
cs_gui_particles.h
Go to the documentation of this file.
1 #ifndef __CS_GUI_PARTICLES_H__
2 #define __CS_GUI_PARTICLES_H__
3 
4 /*============================================================================
5  * Reader of the parameters file: lagrangian particles
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 
39 
40 /*============================================================================
41  * Public function prototypes for Fortran API
42  *============================================================================*/
43 
44 /*----------------------------------------------------------------------------
45  * Copy variable name from C to Fortran
46  *----------------------------------------------------------------------------*/
47 
48 void CS_PROCF(cfname, CFNAME)
49 (
50  int *const flag, /* --> flag for array = 1, 2, or 3 */
51  char *const fstr, /* --> Fortran string */
52  int *const len, /* --> String Length */
53  int *const var_id /* --> Variable Id (1 to n) */
55  );
56 
57 /*----------------------------------------------------------------------------
58  * Copy variable name from Fortran to C
59  *----------------------------------------------------------------------------*/
60 
61 void CS_PROCF(fclag1, FCLAG1)
62 (
63  const char *const fstr, /* --> Fortran string */
64  int *const len, /* --> String Length */
65  int *const var_id /* --> Variable Id (1 to n) */
67 );
68 
69 /*----------------------------------------------------------------------------
70  * Copy variable name from Fortran to C
71  *----------------------------------------------------------------------------*/
72 
73 void CS_PROCF(fclag2, FCLAG2)
74 (
75  const char *const fstr, /* --> Fortran string */
76  int *const len, /* --> String Length */
77  int *const var_id /* --> Variable Id (1 to n) */
79 );
80 
81 /*----------------------------------------------------------------------------
82  * Copy variable name from Fortran to C
83  *----------------------------------------------------------------------------*/
84 
85 void CS_PROCF(fclag3, FCLAG3)
86 (
87  const char *const fstr, /* --> Fortran string */
88  int *const len, /* --> String Length */
89  int *const var_id /* --> Variable Id (1 to n) */
91 );
92 
93 /*-----------------------------------------------------------------------------
94  * Lagrangian: global settings, particles model, 2 way coupling, numerical ordering.
95  *
96  * Fortran Interface:
97  *
98  * SUBROUTINE UILAG1
99  * *****************
100  *
101  *----------------------------------------------------------------------------*/
102 
103 void CS_PROCF (uilag1, UILAG1) (int *const nlayer,
104  int *const iilagr,
105  int *const isuila,
106  int *const isuist,
107  int *const nbpmax,
108  int *const isttio,
109  int *const injcon,
110  int *const idepst,
111  int *const iphyla,
112  int *const idpvar,
113  int *const itpvar,
114  int *const impvar,
115  int *const iencra,
116  double tprenc[],
117  double visref[],
118  double enc1[],
119  double enc2[],
120  int *const nstits,
121  int *const ltsdyn,
122  int *const ltsmas,
123  int *const ltsthe,
124  int *const nordre,
125  int *const idistu,
126  int *const idiffl,
127  int *const modcpl,
128  int *const idirla,
129  int *const ntlal,
130  int *const ivisv1,
131  int *const ivisv2,
132  int *const ivistp,
133  int *const ivisdm,
134  int *const iviste,
135  int *const ivismp,
136  int *const ivisdk,
137  int *const iviswat,
138  int *const ivisch,
139  int *const ivisck,
140  int *const istala,
141  int *const nbclst,
142  double *const seuil,
143  int *const idstnt,
144  int *const nstist,
145  int ihslag[],
146  int *const iensi3,
147  double *const seuilf,
148  int *const nstbor,
149  int *const inbrbd,
150  int *const iflmbd,
151  int *const iangbd,
152  int *const ivitbd,
153  int *const iencnbbd,
154  int *const iencmabd,
155  int *const iencdibd,
156  int *const iencckbd,
157  int imoybr[],
158  int *const iactfv,
159  int *const iactvx,
160  int *const iactvy,
161  int *const iactvz,
162  int *const iactts);
163 
164 /*-----------------------------------------------------------------------------
165  * Fortran Interface:
166  *
167  * subroutine uilag2
168  * *****************
169  *
170  * integer nfabor --> number of boundary faces
171  * integer nozppm --> max number of boundary conditions zone
172  * integer nclagm --> max number of classes
173  * integer nflagm --> max number of boundaries
174  * integer iphyla --> physica model associated to the particles
175  * ..
176  * integer nlayer <-- number of layer for coal
177  * integer inuchl <-- particle coal number
178  * integer irawcl <-- coal particle composition injection condition
179  * integer ihpt <-- coal temperature in K (for each layer)
180  * integer ifrlag --> type of boundary face
181  * integer iusncl <-- array for particles class(es) number
182  * integer iusclb <-- array for particles boundary conditions
183  *----------------------------------------------------------------------------*/
184 
185 void CS_PROCF (uilag2, UILAG2) (const int *const nfabor,
186  const int *const nozppm,
187  const int *const ientrl,
188  const int *const isortl,
189  const int *const idepo1,
190  const int *const idepo2,
191  const int *const idepfa,
192  const int *const iencrl,
193  const int *const irebol,
194  const int *const isymtl,
195  const int *const iphyla,
196  const int *const ijnbp,
197  const int *const ijfre,
198  const int *const iclst,
199  const int *const ijuvw,
200  const int *const iuno,
201  const int *const iupt,
202  const int *const ivpt,
203  const int *const iwpt,
204  const int *const ijprpd,
205  const int *const ipoit,
206  const int *const idebt,
207  const int *const ijprdp,
208  const int *const idpt,
209  const int *const ivdpt,
210  const int *const iropt,
211  const int *const ijprtp,
212  const int *const itpt,
213  const int *const icpt,
214  const int *const iepsi,
215  const int *const nlayer,
216  const int *const inuchl,
217  const int *const irawcl,
218  const int const ihpt[],
219  int ifrlag[],
220  int iusncl[],
221  int iusclb[]);
222 
223 /*============================================================================
224  * Public function prototypes
225  *============================================================================*/
226 
227 /*-----------------------------------------------------------------------------
228  * Free global GUI structures related to particles.
229  *----------------------------------------------------------------------------*/
230 
231 void
233 
234 /*----------------------------------------------------------------------------*/
235 
237 
238 #endif /* __CS_GUI_PARTICLES_H__ */