programmer's documentation
cs_cdo_advection.h
Go to the documentation of this file.
1 #ifndef __CS_CDO_ADVECTION_H__
2 #define __CS_CDO_ADVECTION_H__
3 
4 /*============================================================================
5  * Build discrete convection operators for CDO schemes
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_advection_field.h"
35 #include "cs_cdo_connect.h"
36 #include "cs_cdo_local.h"
37 #include "cs_cdo_quantities.h"
38 #include "cs_equation_param.h"
39 #include "cs_property.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
43 BEGIN_C_DECLS
44 
45 /*============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 /*----------------------------------------------------------------------------*/
61 /*----------------------------------------------------------------------------*/
62 
63 typedef void
64 (cs_cdofb_advection_t)(const cs_cell_mesh_t *cm,
65  const cs_real_t fluxes[],
66  cs_sdm_t *adv);
67 
68 /*----------------------------------------------------------------------------*/
78 /*----------------------------------------------------------------------------*/
79 
80 typedef void
81 (cs_cdofb_advection_bc_t)(const cs_equation_param_t *eqp,
82  const cs_cell_mesh_t *cm,
83  cs_cell_builder_t *cb,
84  cs_cell_sys_t *csys);
85 
86 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 typedef void
101 (cs_cdo_advection_t)(const cs_equation_param_t *eqp,
102  const cs_cell_mesh_t *cm,
103  cs_real_t t_eval,
104  cs_face_mesh_t *fm,
105  cs_cell_builder_t *cb);
106 
107 /*----------------------------------------------------------------------------*/
118 /*----------------------------------------------------------------------------*/
119 
120 typedef void
121 (cs_cdo_advection_bc_t)(const cs_cell_mesh_t *cm,
122  const cs_equation_param_t *eqp,
123  cs_real_t t_eval,
124  cs_face_mesh_t *fm,
125  cs_cell_builder_t *cb,
126  cs_cell_sys_t *csys);
127 
128 /*============================================================================
129  * Global variables
130  *============================================================================*/
131 
132 /*============================================================================
133  * Public function prototypes
134  *============================================================================*/
135 
136 /*----------------------------------------------------------------------------*/
142 /*----------------------------------------------------------------------------*/
143 
144 void
145 cs_cdo_advection_set_cip_coef(double new_value);
146 
147 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 double
156 cs_cdo_advection_get_cip_coef(void);
157 
158 /*----------------------------------------------------------------------------*/
169 /*----------------------------------------------------------------------------*/
170 
171 void
172 cs_cdofb_advection_build(const cs_equation_param_t *eqp,
173  const cs_cell_mesh_t *cm,
174  cs_real_t t_eval,
175  cs_cdofb_advection_t *build_func,
176  cs_cell_builder_t *cb);
177 
178 /*----------------------------------------------------------------------------*/
188 /*----------------------------------------------------------------------------*/
189 
190 void
191 cs_cdo_advection_fb_bc(const cs_equation_param_t *eqp,
192  const cs_cell_mesh_t *cm,
193  cs_cell_builder_t *cb,
194  cs_cell_sys_t *csys);
195 
196 /*----------------------------------------------------------------------------*/
206 /*----------------------------------------------------------------------------*/
207 
208 void
209 cs_cdo_advection_fb_bc_wdi(const cs_equation_param_t *eqp,
210  const cs_cell_mesh_t *cm,
211  cs_cell_builder_t *cb,
212  cs_cell_sys_t *csys);
213 
214 /*----------------------------------------------------------------------------*/
231 /*----------------------------------------------------------------------------*/
232 
233 void
234 cs_cdo_advection_fb_upwnoc(const cs_cell_mesh_t *cm,
235  const cs_real_t fluxes[],
236  cs_sdm_t *adv);
237 
238 /*----------------------------------------------------------------------------*/
251 /*----------------------------------------------------------------------------*/
252 
253 void
254 cs_cdo_advection_get_vb_upwcsvdi(const cs_equation_param_t *eqp,
255  const cs_cell_mesh_t *cm,
256  cs_real_t t_eval,
257  cs_face_mesh_t *fm,
258  cs_cell_builder_t *cb);
259 
260 /*----------------------------------------------------------------------------*/
273 /*----------------------------------------------------------------------------*/
274 
275 void
276 cs_cdo_advection_get_vb_upwcsv(const cs_equation_param_t *eqp,
277  const cs_cell_mesh_t *cm,
278  cs_real_t t_eval,
279  cs_face_mesh_t *fm,
280  cs_cell_builder_t *cb);
281 
282 /*----------------------------------------------------------------------------*/
295 /*----------------------------------------------------------------------------*/
296 
297 void
298 cs_cdo_advection_get_vb_cencsv(const cs_equation_param_t *eqp,
299  const cs_cell_mesh_t *cm,
300  cs_real_t t_eval,
301  cs_face_mesh_t *fm,
302  cs_cell_builder_t *cb);
303 
304 /*----------------------------------------------------------------------------*/
317 /*----------------------------------------------------------------------------*/
318 
319 void
320 cs_cdo_advection_get_vb_mcucsv(const cs_equation_param_t *eqp,
321  const cs_cell_mesh_t *cm,
322  cs_real_t t_eval,
323  cs_face_mesh_t *fm,
324  cs_cell_builder_t *cb);
325 
326 /*----------------------------------------------------------------------------*/
339 /*----------------------------------------------------------------------------*/
340 
341 void
342 cs_cdo_advection_get_vb_upwnocdi(const cs_equation_param_t *eqp,
343  const cs_cell_mesh_t *cm,
344  cs_real_t t_eval,
345  cs_face_mesh_t *fm,
346  cs_cell_builder_t *cb);
347 
348 /*----------------------------------------------------------------------------*/
361 /*----------------------------------------------------------------------------*/
362 
363 void
364 cs_cdo_advection_get_vb_upwnoc(const cs_equation_param_t *eqp,
365  const cs_cell_mesh_t *cm,
366  cs_real_t t_eval,
367  cs_face_mesh_t *fm,
368  cs_cell_builder_t *cb);
369 
370 /*----------------------------------------------------------------------------*/
383 /*----------------------------------------------------------------------------*/
384 
385 void
386 cs_cdo_advection_get_vb_cennoc(const cs_equation_param_t *eqp,
387  const cs_cell_mesh_t *cm,
388  cs_real_t t_eval,
389  cs_face_mesh_t *fm,
390  cs_cell_builder_t *cb);
391 
392 /*----------------------------------------------------------------------------*/
404 /*----------------------------------------------------------------------------*/
405 
406 void
407 cs_cdo_advection_get_vcb_cw(const cs_equation_param_t *eqp,
408  const cs_cell_mesh_t *cm,
409  cs_real_t t_eval,
410  cs_face_mesh_t *fm,
411  cs_cell_builder_t *cb);
412 
413 /*----------------------------------------------------------------------------*/
424 /*----------------------------------------------------------------------------*/
425 
426 void
427 cs_cdo_advection_get_vcb(const cs_equation_param_t *eqp,
428  const cs_cell_mesh_t *cm,
429  cs_real_t t_eval,
430  cs_face_mesh_t *fm,
431  cs_cell_builder_t *cb);
432 
433 /*----------------------------------------------------------------------------*/
444 /*----------------------------------------------------------------------------*/
445 
446 void
447 cs_cdo_advection_add_vb_bc(const cs_cell_mesh_t *cm,
448  const cs_equation_param_t *eqp,
449  cs_real_t t_eval,
450  cs_face_mesh_t *fm,
451  cs_cell_builder_t *cb,
452  cs_cell_sys_t *csys);
453 
454 /*----------------------------------------------------------------------------*/
466 /*----------------------------------------------------------------------------*/
467 
468 void
469 cs_cdo_advection_add_vcb_bc(const cs_cell_mesh_t *cm,
470  const cs_equation_param_t *eqp,
471  cs_real_t t_eval,
472  cs_face_mesh_t *fm,
473  cs_cell_builder_t *cb,
474  cs_cell_sys_t *csys);
475 
476 /*----------------------------------------------------------------------------*/
487 /*----------------------------------------------------------------------------*/
488 
489 void
490 cs_cdo_advection_get_upwind_coef_cell(const cs_cdo_quantities_t *cdoq,
491  cs_param_advection_scheme_t scheme,
492  cs_real_t coefval[]);
493 
494 /*----------------------------------------------------------------------------*/
495 
496 END_C_DECLS
497 
498 #endif /* __CS_CDO_ADVECTION_H__ */
cs_cdo_advection_fb_upwnoc
void cs_cdo_advection_fb_upwnoc(const cs_cell_mesh_t *cm, const cs_real_t fluxes[], cs_sdm_t *adv)
Compute the convection operator attached to a cell with a CDO face-based scheme in the non-conservati...
Definition: cs_cdo_advection.c:1311
cs_cdo_advection_add_vb_bc
void cs_cdo_advection_add_vb_bc(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Compute the BC contribution for the convection operator.
Definition: cs_cdo_advection.c:2030
cs_cdo_advection_get_vb_cennoc
void cs_cdo_advection_get_vb_cennoc(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered sch...
Definition: cs_cdo_advection.c:1732
cs_cdo_advection_bc_t
void() cs_cdo_advection_bc_t(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Compute the BC contribution for the advection operator.
Definition: cs_cdo_advection.h:121
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:159
cs_cdo_advection_get_vb_mcucsv
void cs_cdo_advection_get_vb_mcucsv(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme when a mixed center...
Definition: cs_cdo_advection.c:1552
cs_cdo_connect.h
cs_cdofb_advection_build
void cs_cdofb_advection_build(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_cdofb_advection_t *build_func, cs_cell_builder_t *cb)
Build the cellwise advection operator for CDO-Fb schemes The local matrix related to this operator is...
Definition: cs_cdo_advection.c:1151
cs_cdo_advection_get_vb_upwcsv
void cs_cdo_advection_get_vb_upwcsv(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion a...
Definition: cs_cdo_advection.c:1446
cs_param_advection_scheme_t
cs_param_advection_scheme_t
Definition: cs_param.h:247
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
cs_cdo_advection_get_vb_upwnocdi
void cs_cdo_advection_get_vb_upwnocdi(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is a...
Definition: cs_cdo_advection.c:1599
cs_cell_mesh_t
Set of local quantities and connectivities related to a mesh cell This is a key structure for all cel...
Definition: cs_cdo_local.h:163
cs_cdofb_advection_t
void() cs_cdofb_advection_t(const cs_cell_mesh_t *cm, const cs_real_t fluxes[], cs_sdm_t *adv)
Define the local convection operator in CDO-Fb schemes.
Definition: cs_cdo_advection.h:64
cs_cdo_advection_get_cip_coef
double cs_cdo_advection_get_cip_coef(void)
Get the value of the stabilization coefficient used in CIP scheme.
Definition: cs_cdo_advection.c:1132
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_cell_sys_t
Set of arrays and local (small) dense matrices related to a mesh cell This is a key structure for bui...
Definition: cs_cdo_local.h:112
cs_property.h
fm
Definition: cs_field_pointer.h:123
cs_cdo_advection_get_vb_upwnoc
void cs_cdo_advection_get_vb_upwnoc(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme without diffusion w...
Definition: cs_cdo_advection.c:1673
cs_advection_field.h
cs_cdo_advection_get_vcb
void cs_cdo_advection_get_vcb(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme.
Definition: cs_cdo_advection.c:1909
cs_cdo_advection_add_vcb_bc
void cs_cdo_advection_add_vcb_bc(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Compute the BC contribution for the convection operator with CDO V+C schemes.
Definition: cs_cdo_advection.c:2130
cs_cell_builder_t
Set of local and temporary buffers useful for building the algebraic system with a cellwise process...
Definition: cs_cdo_local.h:75
cs_cdo_quantities.h
cs_cdo_advection_fb_bc_wdi
void cs_cdo_advection_fb_bc_wdi(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Add thecontribution of the boundary conditions to the local system in CDO-Fb schemes (with a diffusio...
Definition: cs_cdo_advection.c:1256
cs_cdo_advection_fb_bc
void cs_cdo_advection_fb_bc(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Add thecontribution of the boundary conditions to the local system in CDO-Fb schemes (without diffusi...
Definition: cs_cdo_advection.c:1197
cs_cdo_advection_t
void() cs_cdo_advection_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme. The local matrix related to this operator is stored in cb->loc.
Definition: cs_cdo_advection.h:101
cs_cdo_local.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:463
cs_cdo_advection_get_vb_upwcsvdi
void cs_cdo_advection_get_vb_upwcsvdi(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme when diffusion is a...
Definition: cs_cdo_advection.c:1370
cs_cdofb_advection_bc_t
void() cs_cdofb_advection_bc_t(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Add the contribution of the boundary conditions to the local system in CDO-Fb schemes.
Definition: cs_cdo_advection.h:81
cs_face_mesh_t
Set of local quantities and connectivities related to a mesh face Structure used to get a better memo...
Definition: cs_cdo_local.h:224
cs_cdo_advection_get_vcb_cw
void cs_cdo_advection_get_vcb_cw(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex+cell-based scheme when the advec...
Definition: cs_cdo_advection.c:1778
cs_cdo_advection_get_vb_cencsv
void cs_cdo_advection_get_vb_cencsv(const cs_equation_param_t *eqp, const cs_cell_mesh_t *cm, cs_real_t t_eval, cs_face_mesh_t *fm, cs_cell_builder_t *cb)
Compute the convection operator attached to a cell with a CDO vertex-based scheme when a centered sch...
Definition: cs_cdo_advection.c:1505
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_cdo_advection_set_cip_coef
void cs_cdo_advection_set_cip_coef(double new_value)
Set the value of the stabilization coefficient used in CIP scheme.
Definition: cs_cdo_advection.c:1118
cs_cdo_advection_get_upwind_coef_cell
void cs_cdo_advection_get_upwind_coef_cell(const cs_cdo_quantities_t *cdoq, cs_param_advection_scheme_t scheme, cs_real_t coefval[])
Compute the value in each cell of the upwinding coefficient given a related Peclet number...
Definition: cs_cdo_advection.c:2188
Generated on Sat Feb 2 2019 15:43:25 by   doxygen 1.8.13