programmer's documentation
cs_equation_iterative_solve.h
Go to the documentation of this file.
1 #ifndef __CS_EQUATION_ITERATIVE_SOLVE_H__
2 #define __CS_EQUATION_ITERATIVE_SOLVE_H__
3 
4 /*============================================================================
5  * Scalar convection diffusion equation solver.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2016 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 #include "cs_defs.h"
30 
31 /*----------------------------------------------------------------------------
32  * Local headers
33  *----------------------------------------------------------------------------*/
34 
35 #include "cs_parameters.h"
36 
38 
39 /*----------------------------------------------------------------------------*/
40 
41 /*=============================================================================
42  * Public function prototypes
43  *============================================================================*/
44 
45 /*----------------------------------------------------------------------------*/
52 /*----------------------------------------------------------------------------*/
53 
54 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void
148  int f_id,
149  const char *name,
150  int ndircp,
151  int iescap,
152  int imucpp,
153  cs_var_cal_opt_t *var_cal_opt,
154  const cs_real_t pvara[],
155  const cs_real_t pvark[],
156  const cs_real_t coefap[],
157  const cs_real_t coefbp[],
158  const cs_real_t cofafp[],
159  const cs_real_t cofbfp[],
160  const cs_real_t i_massflux[],
161  const cs_real_t b_massflux[],
162  const cs_real_t i_viscm[],
163  const cs_real_t b_viscm[],
164  const cs_real_t i_visc[],
165  const cs_real_t b_visc[],
166  cs_real_6_t viscel[],
167  const cs_real_2_t weighf[],
168  const cs_real_t weighb[],
169  int icvflb,
170  const int icvfli[],
171  const cs_real_t rovsdt[],
172  cs_real_t smbrp[],
173  cs_real_t pvar[],
174  cs_real_t dpvar[],
175  const cs_real_t xcpp[],
176  cs_real_t eswork[]);
177 
178 /*----------------------------------------------------------------------------*/
273 /*----------------------------------------------------------------------------*/
274 
275 void
277  int f_id,
278  const char *name,
279  int ndircp,
280  int ivisep,
281  int iescap,
282  cs_var_cal_opt_t *var_cal_opt,
283  const cs_real_3_t pvara[],
284  const cs_real_3_t pvark[],
285  const cs_real_3_t coefav[],
286  const cs_real_33_t coefbv[],
287  const cs_real_3_t cofafv[],
288  const cs_real_33_t cofbfv[],
289  const cs_real_t i_massflux[],
290  const cs_real_t b_massflux[],
291  cs_real_t i_viscm[],
292  const cs_real_t b_viscm[],
293  const cs_real_t i_visc[],
294  const cs_real_t b_visc[],
295  const cs_real_t secvif[],
296  const cs_real_t secvib[],
297  int icvflb,
298  const int icvfli[],
299  const cs_real_33_t fimp[],
300  cs_real_3_t smbrp[],
301  cs_real_3_t pvar[],
302  cs_real_3_t eswork[]);
303 
304 /*----------------------------------------------------------------------------*/
394 /*----------------------------------------------------------------------------*/
395 
396 void
398  int f_id,
399  const char *name,
400  int ndircp,
401  cs_var_cal_opt_t *var_cal_opt,
402  const cs_real_6_t pvara[],
403  const cs_real_6_t pvark[],
404  const cs_real_6_t coefats[],
405  const cs_real_66_t coefbts[],
406  const cs_real_6_t cofafts[],
407  const cs_real_66_t cofbfts[],
408  const cs_real_t i_massflux[],
409  const cs_real_t b_massflux[],
410  const cs_real_t i_viscm[],
411  const cs_real_t b_viscm[],
412  const cs_real_t i_visc[],
413  const cs_real_t b_visc[],
414  cs_real_6_t viscel[],
415  const cs_real_2_t weighf[],
416  const cs_real_t weighb[],
417  int icvflb,
418  const int icvfli[],
419  const cs_real_66_t fimp[],
420  cs_real_6_t smbrp[],
421  cs_real_6_t pvar[]);
422 
424 
425 #endif /* __CS_EQUATION_ITERATIVE_SOLVE_H__ */
cs_real_t cs_real_2_t[2]
vector of 2 floating-point values
Definition: cs_defs.h:307
cs_real_t cs_real_6_t[6]
vector of 6 floating-point values
Definition: cs_defs.h:310
integer, dimension(:), allocatable icvfli
Definition: cfpoin.f90:48
cs_real_t cs_real_66_t[6][6]
6x6 matrix of floating-point values
Definition: cs_defs.h:315
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
integer(c_int), pointer, save idtvar
option for a variable time step
Definition: optcal.f90:431
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
void cs_equation_iterative_solve_vector(int idtvar, int f_id, const char *name, int ndircp, int ivisep, int iescap, cs_var_cal_opt_t *var_cal_opt, const cs_real_3_t pvara[], const cs_real_3_t pvark[], const cs_real_3_t coefav[], const cs_real_33_t coefbv[], const cs_real_3_t cofafv[], const cs_real_33_t cofbfv[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], cs_real_t i_viscm[], const cs_real_t b_viscm[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t secvif[], const cs_real_t secvib[], int icvflb, const int icvfli[], const cs_real_33_t fimp[], cs_real_3_t smbrp[], cs_real_3_t pvar[], cs_real_3_t eswork[])
This function solves an advection diffusion equation with source terms for one time step for the vect...
Definition: cs_equation_iterative_solve.c:1056
void cs_equation_iterative_solve_scalar(int idtvar, int f_id, const char *name, int ndircp, int iescap, int imucpp, cs_var_cal_opt_t *var_cal_opt, const cs_real_t pvara[], const cs_real_t pvark[], const cs_real_t coefap[], const cs_real_t coefbp[], const cs_real_t cofafp[], const cs_real_t cofbfp[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_viscm[], const cs_real_t b_viscm[], const cs_real_t i_visc[], const cs_real_t b_visc[], cs_real_6_t viscel[], const cs_real_2_t weighf[], const cs_real_t weighb[], int icvflb, const int icvfli[], const cs_real_t rovsdt[], cs_real_t smbrp[], cs_real_t pvar[], cs_real_t dpvar[], const cs_real_t xcpp[], cs_real_t eswork[])
This function solves an advection diffusion equation with source terms for one time step for the vari...
Definition: cs_equation_iterative_solve.c:196
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:308
Definition: cs_parameters.h:69
#define END_C_DECLS
Definition: cs_defs.h:449
void cs_equation_iterative_solve_tensor(int idtvar, int f_id, const char *name, int ndircp, cs_var_cal_opt_t *var_cal_opt, const cs_real_6_t pvara[], const cs_real_6_t pvark[], const cs_real_6_t coefats[], const cs_real_66_t coefbts[], const cs_real_6_t cofafts[], const cs_real_66_t cofbfts[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_viscm[], const cs_real_t b_viscm[], const cs_real_t i_visc[], const cs_real_t b_visc[], cs_real_6_t viscel[], const cs_real_2_t weighf[], const cs_real_t weighb[], int icvflb, const int icvfli[], const cs_real_66_t fimp[], cs_real_6_t smbrp[], cs_real_6_t pvar[])
This function solves an advection diffusion equation with source terms for one time step for the symm...
Definition: cs_equation_iterative_solve.c:1845
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:314