programmer's documentation
cs_elec_model.h
Go to the documentation of this file.
1 #ifndef __CS_ELEC_MODEL_H__
2 #define __CS_ELEC_MODEL_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-2018 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 #include "cs_mesh.h"
37 #include "cs_mesh_quantities.h"
38 
39 /*----------------------------------------------------------------------------*/
40 
42 
43 /*=============================================================================
44  * Macro definitions
45  *============================================================================*/
46 
47 /*============================================================================
48  * Type definitions
49  *============================================================================*/
50 
51 /*----------------------------------------------------------------------------
52  * Structure to read properties in dp_ELE
53  *----------------------------------------------------------------------------*/
54 
55 typedef struct {
56  int ngaz;
57  int npoint;
66  // cs_real_t *qespel; /* Charge massique des especes C/kg */
67  // cs_real_t *suscep; /* Susceptibilite (relation champ - mobilite) m2/s/V */
69 
70 /*----------------------------------------------------------------------------
71  * Structure to read transformer parameters in dp_ELE
72  *----------------------------------------------------------------------------*/
73 
74 typedef struct {
75  int nbelec;
76  int *ielecc;
77  int *ielect;
78  int *ielecb;
79  int nbtrf;
80  int ntfref;
81  int *ibrpr;
82  int *ibrsec;
90 
91 /*----------------------------------------------------------------------------
92  * Electrical model options descriptor
93  *----------------------------------------------------------------------------*/
94 
95 typedef struct {
96  int ixkabe;
97  int ntdcla;
98  int irestrike;
99  cs_real_t restrike_point[3];
100  cs_real_t crit_reca[5];
101  int ielcor;
102  int modrec;
103  int idreca;
104  int *izreca;
112 
113 /*============================================================================
114  * Static global variables
115  *============================================================================*/
116 
117 /* Pointer to electrical model options structure */
118 
122 
123 /* Constant for electrical models */
124 
125 extern const cs_real_t cs_elec_permvi;
126 extern const cs_real_t cs_elec_epszer;
127 
128 /*=============================================================================
129  * Public function prototypes for Fortran API
130  *============================================================================*/
131 
132 void
133 CS_PROCF (elini1, ELINI1) (cs_real_t *visls0,
134  cs_real_t *diftl0,
135  cs_int_t *idircl,
136  cs_int_t *isca);
137 
138 void
139 CS_PROCF (elflux, ELFLUX) (cs_int_t *iappel);
140 
141 void
142 CS_PROCF (elthht, ELTHHT) (cs_int_t *mode,
143  cs_real_t *ym,
144  cs_real_t *enthal,
145  cs_real_t *temp);
146 
147 void
148 CS_PROCF (ellecd, ELLECD) (void);
149 
150 void
151 CS_PROCF (elphyv, ELPHYV) (void);
152 
153 void
154 CS_PROCF (eltssc, ELTSSC) (const cs_int_t *isca,
155  cs_real_t *smbrs);
156 
157 void
158 CS_PROCF (eltsvv, ELTSVV) (const int *f_id,
159  cs_real_t *smbrv);
160 
161 void
162 CS_PROCF (elvarp, ELVARP) (void);
163 
164 void
165 CS_PROCF (elprop, ELPROP) (void);
166 
167 void
168 CS_PROCF (eliniv, ELINIV) (cs_int_t *isuite);
169 
170 void
171 CS_PROCF (elreca, ELRECA) (cs_real_t *dt);
172 
173 /*=============================================================================
174  * Public function prototypes
175  *============================================================================*/
176 
177 /*----------------------------------------------------------------------------
178  * Provide acces to cs_elec_option
179  *----------------------------------------------------------------------------*/
180 
183 
184 /*----------------------------------------------------------------------------
185  * Provide acces to cs_glob_transformer
186  *----------------------------------------------------------------------------*/
187 
190 
191 /*----------------------------------------------------------------------------
192  * Initialize structures for electrical model
193  *----------------------------------------------------------------------------*/
194 
195 void
197 
198 /*----------------------------------------------------------------------------
199  * Destroy structures for electrical model
200  *----------------------------------------------------------------------------*/
201 
202 void
204 
205 /*----------------------------------------------------------------------------
206  * Specific initialization for electric arc
207  *----------------------------------------------------------------------------*/
208 
209 void
211  cs_real_t *diftl0,
212  int *idircl,
213  int *isca);
214 
215 /*----------------------------------------------------------------------------
216  * Read properties file
217  *----------------------------------------------------------------------------*/
218 
219 void
221 
222 /*----------------------------------------------------------------------------
223  * compute specific electric arc fields
224  *----------------------------------------------------------------------------*/
225 
226 void
228  int call_id);
229 
230 /*----------------------------------------------------------------------------
231  * convert enthalpy-temperature
232  *----------------------------------------------------------------------------*/
233 
234 void
235 cs_elec_convert_h_t(int mode,
236  cs_real_t *ym,
237  cs_real_t *enthal,
238  cs_real_t *temp);
239 
240 /*----------------------------------------------------------------------------
241  * compute physical properties
242  *----------------------------------------------------------------------------*/
243 
244 void
246  const cs_mesh_quantities_t *mesh_quantities);
247 
248 /*----------------------------------------------------------------------------
249  * compute source terms for energy
250  *----------------------------------------------------------------------------*/
251 
252 void
254  const cs_mesh_quantities_t *mesh_quantities,
255  int f_id,
256  cs_real_t *smbrs);
257 
258 /*----------------------------------------------------------------------------
259  * compute source terms for vector potential
260  *----------------------------------------------------------------------------*/
261 
262 void
264  const cs_mesh_quantities_t *mesh_quantities,
265  int f_id,
266  cs_real_3_t *smbrv);
267 
268 /*----------------------------------------------------------------------------
269  * add variables fields
270  *----------------------------------------------------------------------------*/
271 
272 void
274 
275 /*----------------------------------------------------------------------------
276  * add properties fields
277  *----------------------------------------------------------------------------*/
278 
279 void
281 
282 /*----------------------------------------------------------------------------
283  * initialize electric fields
284  *----------------------------------------------------------------------------*/
285 
286 void
288  int isuite);
289 
290 /*----------------------------------------------------------------------------
291  * scaling electric quantities
292  *----------------------------------------------------------------------------*/
293 
294 void
296  const cs_mesh_quantities_t *mesh_quantities,
297  cs_real_t *dt);
298 
299 /*----------------------------------------------------------------------------*/
300 
302 
303 #endif /* __CS_ELEC_MODEL_H__ */
cs_real_t * xkabel
Definition: cs_elec_model.h:65
const cs_real_t cs_elec_epszer
Definition: cs_elec_model.c:275
int * ibrsec
Definition: cs_elec_model.h:82
void elvarp(void)
Definition: cs_elec_model.c:536
int irestrike
Definition: cs_elec_model.h:98
void cs_elec_convert_h_t(int mode, cs_real_t *ym, cs_real_t *enthal, cs_real_t *temp)
Definition: cs_elec_model.c:971
const cs_data_joule_effect_t * cs_glob_transformer
void cs_elec_fields_initialize(const cs_mesh_t *mesh, int isuite)
Definition: cs_elec_model.c:2030
int modrec
Definition: cs_elec_model.h:102
void elini1(cs_real_t *visls0, cs_real_t *diftl0, cs_int_t *idircl, cs_int_t *isca)
Definition: cs_elec_model.c:471
const cs_data_elec_t * cs_glob_elec_properties
cs_real_t * zi
Definition: cs_elec_model.h:86
void elprop(void)
Definition: cs_elec_model.c:542
integer, dimension(nscamx), save isca
Definition: numvar.f90:131
int ntdcla
Definition: cs_elec_model.h:97
void cs_elec_scaling_function(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, cs_real_t *dt)
Definition: cs_elec_model.c:2079
void elthht(cs_int_t *mode, cs_real_t *ym, cs_real_t *enthal, cs_real_t *temp)
Definition: cs_elec_model.c:488
int nbelec
Definition: cs_elec_model.h:75
cs_data_joule_effect_t * cs_get_glob_transformer(void)
Definition: cs_elec_model.c:578
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
int cs_int_t
Fortran-compatible integer.
Definition: cs_defs.h:296
integer, dimension(nvarmx), save idircl
Definition: optcal.f90:392
int * ielecc
Definition: cs_elec_model.h:76
void cs_electrical_model_specific_initialization(cs_real_t *visls0, cs_real_t *diftl0, int *idircl, int *isca)
Definition: cs_elec_model.c:668
cs_real_t * visel
Definition: cs_elec_model.h:63
cs_real_t * zr
Definition: cs_elec_model.h:85
void cs_elec_physical_properties(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities)
Definition: cs_elec_model.c:1067
cs_real_t * uroff
Definition: cs_elec_model.h:87
int ngaz
Definition: cs_elec_model.h:56
void ellecd(void)
Definition: cs_elec_model.c:497
cs_real_t elcou
Definition: cs_elec_model.h:109
cs_real_t * rhoel
Definition: cs_elec_model.h:60
cs_real_t * xlabel
Definition: cs_elec_model.h:64
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
int * ibrpr
Definition: cs_elec_model.h:81
cs_real_t * cpel
Definition: cs_elec_model.h:61
integer, save isuite
Indicator of a calculation restart (=1) or not (=0). This value is set automatically by the code; dep...
Definition: optcal.f90:405
cs_real_t * uioff
Definition: cs_elec_model.h:88
cs_real_t srrom
Definition: cs_elec_model.h:110
const cs_elec_option_t * cs_glob_elec_option
Definition: cs_mesh.h:63
int * izreca
Definition: cs_elec_model.h:104
void cs_elec_source_terms(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, int f_id, cs_real_t *smbrs)
Definition: cs_elec_model.c:1714
cs_real_t coejou
Definition: cs_elec_model.h:108
cs_real_t puisim
Definition: cs_elec_model.h:107
int nbtrf
Definition: cs_elec_model.h:79
double precision, dimension(nscamx), save visls0
reference molecular diffusivity related to the scalar J ( ).
Definition: optcal.f90:1354
void eliniv(cs_int_t *isuite)
Definition: cs_elec_model.c:548
void cs_elec_add_property_fields(void)
Definition: cs_elec_model.c:1911
void elreca(cs_real_t *dt)
Definition: cs_elec_model.c:554
double precision, save diftl0
Definition: ppthch.f90:161
void eltssc(const cs_int_t *isca, cs_real_t *smbrs)
Definition: cs_elec_model.c:511
void cs_electrical_model_initialize(void)
Definition: cs_elec_model.c:588
Definition: cs_field_pointer.h:65
Definition: cs_mesh_quantities.h:85
const cs_real_t cs_elec_permvi
Definition: cs_elec_model.c:269
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:309
int * ielecb
Definition: cs_elec_model.h:78
cs_real_t * sigel
Definition: cs_elec_model.h:62
void elphyv(void)
Definition: cs_elec_model.c:504
cs_real_t pot_diff
Definition: cs_elec_model.h:106
option for electric model
Definition: cs_elec_model.h:95
cs_real_t * rnbs
Definition: cs_elec_model.h:84
int npoint
Definition: cs_elec_model.h:57
#define END_C_DECLS
Definition: cs_defs.h:462
int ntfref
Definition: cs_elec_model.h:80
int ielcor
Definition: cs_elec_model.h:101
#define CS_PROCF(x, y)
Definition: cs_defs.h:475
void cs_electrical_model_finalize(void)
Definition: cs_elec_model.c:631
void eltsvv(const int *f_id, cs_real_t *smbrv)
Definition: cs_elec_model.c:526
cs_real_t * tenspr
Definition: cs_elec_model.h:83
cs_real_t couimp
Definition: cs_elec_model.h:105
physical properties for electric model descriptor.
Definition: cs_elec_model.h:55
void elflux(cs_int_t *iappel)
Definition: cs_elec_model.c:481
void cs_electrical_properties_read(void)
Definition: cs_elec_model.c:779
cs_elec_option_t * cs_get_glob_elec_option(void)
Definition: cs_elec_model.c:568
void cs_elec_add_variable_fields(void)
Definition: cs_elec_model.c:1811
int idreca
Definition: cs_elec_model.h:103
void cs_elec_compute_fields(const cs_mesh_t *mesh, int call_id)
Definition: cs_elec_model.c:1386
int ixkabe
Definition: cs_elec_model.h:96
cs_real_t * th
Definition: cs_elec_model.h:58
cs_real_t * ehgaz
Definition: cs_elec_model.h:59
Structure to read transformer parameters in dp_ELE.
Definition: cs_elec_model.h:74
Definition: mesh.f90:26
void cs_elec_source_terms_v(const cs_mesh_t *mesh, const cs_mesh_quantities_t *mesh_quantities, int f_id, cs_real_3_t *smbrv)
Definition: cs_elec_model.c:1777
int * ielect
Definition: cs_elec_model.h:77