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-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 #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 /*----------------------------------------------------------------------------*/
145 /*----------------------------------------------------------------------------*/
146 
147 void
149  int iterns,
150  int f_id,
151  const char *name,
152  int ndircp,
153  int iescap,
154  int imucpp,
155  cs_var_cal_opt_t *var_cal_opt,
156  const cs_real_t pvara[],
157  const cs_real_t pvark[],
158  const cs_real_t coefap[],
159  const cs_real_t coefbp[],
160  const cs_real_t cofafp[],
161  const cs_real_t cofbfp[],
162  const cs_real_t i_massflux[],
163  const cs_real_t b_massflux[],
164  const cs_real_t i_viscm[],
165  const cs_real_t b_viscm[],
166  const cs_real_t i_visc[],
167  const cs_real_t b_visc[],
168  cs_real_6_t viscel[],
169  const cs_real_2_t weighf[],
170  const cs_real_t weighb[],
171  int icvflb,
172  const int icvfli[],
173  const cs_real_t rovsdt[],
174  cs_real_t smbrp[],
175  cs_real_t pvar[],
176  cs_real_t dpvar[],
177  const cs_real_t xcpp[],
178  cs_real_t eswork[]);
179 
180 /*----------------------------------------------------------------------------*/
282 /*----------------------------------------------------------------------------*/
283 
284 void
286  int iterns,
287  int f_id,
288  const char *name,
289  int ndircp,
290  int ivisep,
291  int iescap,
292  cs_var_cal_opt_t *var_cal_opt,
293  const cs_real_3_t pvara[],
294  const cs_real_3_t pvark[],
295  const cs_real_3_t coefav[],
296  const cs_real_33_t coefbv[],
297  const cs_real_3_t cofafv[],
298  const cs_real_33_t cofbfv[],
299  const cs_real_t i_massflux[],
300  const cs_real_t b_massflux[],
301  cs_real_t i_viscm[],
302  const cs_real_t b_viscm[],
303  const cs_real_t i_visc[],
304  const cs_real_t b_visc[],
305  const cs_real_t secvif[],
306  const cs_real_t secvib[],
307  cs_real_6_t viscel[],
308  const cs_real_2_t weighf[],
309  const cs_real_t weighb[],
310  int icvflb,
311  const int icvfli[],
312  const cs_real_33_t fimp[],
313  cs_real_3_t smbrp[],
314  cs_real_3_t pvar[],
315  cs_real_3_t eswork[]);
316 
317 /*----------------------------------------------------------------------------*/
407 /*----------------------------------------------------------------------------*/
408 
409 void
411  int f_id,
412  const char *name,
413  int ndircp,
414  cs_var_cal_opt_t *var_cal_opt,
415  const cs_real_6_t pvara[],
416  const cs_real_6_t pvark[],
417  const cs_real_6_t coefats[],
418  const cs_real_66_t coefbts[],
419  const cs_real_6_t cofafts[],
420  const cs_real_66_t cofbfts[],
421  const cs_real_t i_massflux[],
422  const cs_real_t b_massflux[],
423  const cs_real_t i_viscm[],
424  const cs_real_t b_viscm[],
425  const cs_real_t i_visc[],
426  const cs_real_t b_visc[],
427  cs_real_6_t viscel[],
428  const cs_real_2_t weighf[],
429  const cs_real_t weighb[],
430  int icvflb,
431  const int icvfli[],
432  const cs_real_66_t fimp[],
433  cs_real_6_t smbrp[],
434  cs_real_6_t pvar[]);
435 
437 
438 #endif /* __CS_EQUATION_ITERATIVE_SOLVE_H__ */
cs_real_t cs_real_2_t[2]
vector of 2 floating-point values
Definition: cs_defs.h:309
cs_real_t cs_real_6_t[6]
vector of 6 floating-point values
Definition: cs_defs.h:312
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:317
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
integer(c_int), pointer, save idtvar
option for a variable time step
Definition: optcal.f90:467
void cs_equation_iterative_solve_scalar(int idtvar, int iterns, 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:208
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_equation_iterative_solve_vector(int idtvar, int iterns, 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[], cs_real_6_t viscel[], const cs_real_2_t weighf[], const cs_real_t weighb[], 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:1087
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:310
structure containing the variable calculation options.
Definition: cs_parameters.h:60
#define END_C_DECLS
Definition: cs_defs.h:463
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:1907
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:316