7.1
general documentation
cs_cdovcb_scaleq.h
Go to the documentation of this file.
1 #ifndef __CS_CDOVCB_SCALEQ_H__
2 #define __CS_CDOVCB_SCALEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO vertex+cell-based system for unsteady convection
6  * diffusion reaction of scalar-valued equations with source terms
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2021 EDF S.A.
13 
14  This program is free software; you can redistribute it and/or modify it under
15  the terms of the GNU General Public License as published by the Free Software
16  Foundation; either version 2 of the License, or (at your option) any later
17  version.
18 
19  This program is distributed in the hope that it will be useful, but WITHOUT
20  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
22  details.
23 
24  You should have received a copy of the GNU General Public License along with
25  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
26  Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 */
28 
29 /*----------------------------------------------------------------------------
30  * Local headers
31  *----------------------------------------------------------------------------*/
32 
33 #include "cs_base.h"
34 #include "cs_time_step.h"
35 #include "cs_mesh.h"
36 #include "cs_equation_common.h"
37 #include "cs_equation_param.h"
38 #include "cs_field.h"
39 #include "cs_cdo_connect.h"
40 #include "cs_cdo_quantities.h"
41 #include "cs_equation_param.h"
42 #include "cs_restart.h"
43 #include "cs_source_term.h"
44 
45 /*----------------------------------------------------------------------------*/
46 
47 BEGIN_C_DECLS
48 
49 /*============================================================================
50  * Macro definitions
51  *============================================================================*/
52 
53 /*============================================================================
54  * Public function prototypes
55  *============================================================================*/
56 
57 /*----------------------------------------------------------------------------*/
64 /*----------------------------------------------------------------------------*/
65 
66 bool
67 cs_cdovcb_scaleq_is_initialized(void);
68 
69 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_cdovcb_scaleq_init_common(const cs_cdo_quantities_t *quant,
84  const cs_cdo_connect_t *connect,
85  const cs_time_step_t *time_step,
86  const cs_matrix_structure_t *ms);
87 
88 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
98 cs_cdovcb_scaleq_get(cs_cell_sys_t **csys,
99  cs_cell_builder_t **cb);
100 
101 /*----------------------------------------------------------------------------*/
106 /*----------------------------------------------------------------------------*/
107 
108 void
109 cs_cdovcb_scaleq_finalize_common(void);
110 
111 /*----------------------------------------------------------------------------*/
123 /*----------------------------------------------------------------------------*/
124 
125 void *
126 cs_cdovcb_scaleq_init_context(const cs_equation_param_t *eqp,
127  int var_id,
128  int bflux_id,
129  cs_equation_builder_t *eqb);
130 
131 /*----------------------------------------------------------------------------*/
139 /*----------------------------------------------------------------------------*/
140 
141 void *
142 cs_cdovcb_scaleq_free_context(void *data);
143 
144 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
160 cs_cdovcb_scaleq_init_values(cs_real_t t_eval,
161  const int field_id,
162  const cs_mesh_t *mesh,
163  const cs_equation_param_t *eqp,
164  cs_equation_builder_t *eqb,
165  void *context);
166 
167 /*----------------------------------------------------------------------------*/
181 /*----------------------------------------------------------------------------*/
182 
183 void
184 cs_cdovcb_scaleq_interpolate(const cs_mesh_t *mesh,
185  const cs_real_t *cell_values,
186  const int field_id,
187  const cs_equation_param_t *eqp,
188  cs_equation_builder_t *eqb,
189  void *context);
190 
191 /*----------------------------------------------------------------------------*/
204 /*----------------------------------------------------------------------------*/
205 
206 void
207 cs_cdovcb_scaleq_solve_steady_state(bool cur2prev,
208  const cs_mesh_t *mesh,
209  const int field_id,
210  const cs_equation_param_t *eqp,
211  cs_equation_builder_t *eqb,
212  void *context);
213 
214 /*----------------------------------------------------------------------------*/
228 /*----------------------------------------------------------------------------*/
229 
230 void
231 cs_cdovcb_scaleq_solve_implicit(bool cur2prev,
232  const cs_mesh_t *mesh,
233  const int field_id,
234  const cs_equation_param_t *eqp,
235  cs_equation_builder_t *eqb,
236  void *context);
237 
238 /*----------------------------------------------------------------------------*/
252 /*----------------------------------------------------------------------------*/
253 
254 void
255 cs_cdovcb_scaleq_solve_theta(bool cur2prev,
256  const cs_mesh_t *mesh,
257  const int field_id,
258  const cs_equation_param_t *eqp,
259  cs_equation_builder_t *eqb,
260  void *context);
261 
262 /*----------------------------------------------------------------------------*/
274 /*----------------------------------------------------------------------------*/
275 
276 cs_real_t *
277 cs_cdovcb_scaleq_get_vertex_values(void *context,
278  bool previous);
279 
280 /*----------------------------------------------------------------------------*/
294 /*----------------------------------------------------------------------------*/
295 
296 cs_real_t *
297 cs_cdovcb_scaleq_get_cell_values(void *context,
298  bool previous);
299 
300 /*----------------------------------------------------------------------------*/
316 /*----------------------------------------------------------------------------*/
317 
318 void
319 cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t t_eval,
320  const cs_equation_param_t *eqp,
321  const cs_real_t *pot_v,
322  const cs_real_t *pot_c,
323  cs_equation_builder_t *eqb,
324  void *context,
325  cs_real_t *vf_flux);
326 
327 /*----------------------------------------------------------------------------*/
341 /*----------------------------------------------------------------------------*/
342 
343 void
344 cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[],
345  const cs_real_t *pdi,
346  const cs_equation_param_t *eqp,
347  int ml_id,
348  cs_equation_builder_t *eqb,
349  void *context,
350  double *d_flux,
351  double *c_flux);
352 
353 /*----------------------------------------------------------------------------*/
365 /*----------------------------------------------------------------------------*/
366 
367 void
368 cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *values,
369  const cs_equation_param_t *eqp,
370  cs_real_t t_eval,
371  cs_equation_builder_t *eqb,
372  void *context,
373  cs_real_t *diff_flux);
374 
375 /*----------------------------------------------------------------------------*/
387 /*----------------------------------------------------------------------------*/
388 
389 void
390 cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *values,
391  const cs_equation_param_t *eqp,
392  cs_real_t t_eval,
393  cs_equation_builder_t *eqb,
394  void *context,
395  cs_real_t *diff_flux);
396 
397 /*----------------------------------------------------------------------------*/
406 /*----------------------------------------------------------------------------*/
407 
408 void
409 cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values,
410  cs_equation_builder_t *eqb,
411  void *context,
412  cs_real_t *v_gradient);
413 
414 /*----------------------------------------------------------------------------*/
423 /*----------------------------------------------------------------------------*/
424 
425 void
426 cs_cdovcb_scaleq_read_restart(cs_restart_t *restart,
427  const char *eqname,
428  void *scheme_context);
429 
430 /*----------------------------------------------------------------------------*/
439 /*----------------------------------------------------------------------------*/
440 
441 void
442 cs_cdovcb_scaleq_write_restart(cs_restart_t *restart,
443  const char *eqname,
444  void *scheme_context);
445 
446 /*----------------------------------------------------------------------------*/
455 /*----------------------------------------------------------------------------*/
456 
457 void
458 cs_cdovcb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
459  cs_equation_builder_t *eqb,
460  void *context);
461 
462 /*----------------------------------------------------------------------------*/
470 /*----------------------------------------------------------------------------*/
471 
472 void
473 cs_cdovcb_scaleq_extra_post(const cs_equation_param_t *eqp,
474  cs_equation_builder_t *eqb,
475  void *context);
476 
477 /*----------------------------------------------------------------------------*/
478 
479 END_C_DECLS
480 
481 #endif /* __CS_CDOVCB_SCALEQ_H__ */
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_cdovcb_scaleq_get_vertex_values
cs_real_t * cs_cdovcb_scaleq_get_vertex_values(void *context, bool previous)
Retrieve an array of values at mesh vertices for the variable field associated to the given context T...
Definition: cs_cdovcb_scaleq.c:2680
cs_cdovcb_scaleq_get
void cs_cdovcb_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdovcb_scaleq.c:941
cs_base.h
cs_restart.h
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:177
cs_cdovcb_scaleq_read_restart
void cs_cdovcb_scaleq_read_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Read additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_cdovcb_scaleq.c:3473
cs_cdo_connect.h
cs_cdovcb_scaleq_init_context
void * cs_cdovcb_scaleq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdovcb_scaleq_t structure storing data useful for building and managing such a scheme...
Definition: cs_cdovcb_scaleq.c:999
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_cdovcb_scaleq_write_restart
void cs_cdovcb_scaleq_write_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Write additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_cdovcb_scaleq.c:3526
cs_cdovcb_scaleq_solve_steady_state
void cs_cdovcb_scaleq_solve_steady_state(bool cur2prev, const cs_mesh_t *mesh, const int field_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build and solve the linear system arising from a scalar steady-state convection/diffusion/reaction eq...
Definition: cs_cdovcb_scaleq.c:1706
cs_cdovcb_scaleq_solve_implicit
void cs_cdovcb_scaleq_solve_implicit(bool cur2prev, const cs_mesh_t *mesh, const int field_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equati...
Definition: cs_cdovcb_scaleq.c:1956
cs_cdo_connect_t
Definition: cs_cdo_connect.h:79
cs_cdovcb_scaleq_boundary_diff_flux
void cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t t_eval, const cs_equation_param_t *eqp, const cs_real_t *pot_v, const cs_real_t *pot_c, cs_equation_builder_t *eqb, void *context, cs_real_t *vf_flux)
Compute for each vertex of a boundary face, the portion of diffusive flux across the boundary face...
Definition: cs_cdovcb_scaleq.c:2746
cs_source_term.h
cs_cdovcb_scaleq_init_values
void cs_cdovcb_scaleq_init_values(cs_real_t t_eval, const int field_id, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Set the initial values of the variable field taking into account the boundary conditions. Case of scalar-valued CDO-VCb schemes.
Definition: cs_cdovcb_scaleq.c:1336
cs_cdovcb_scaleq_diff_flux_dfaces
void cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *values, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_equation_builder_t *eqb, void *context, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux across dual faces Case of scalar-valued CDO-VCb schemes...
Definition: cs_cdovcb_scaleq.c:3247
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:129
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:146
cs_mesh_t
Definition: cs_mesh.h:84
cs_cdovcb_scaleq_diff_flux_in_cells
void cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *values, const cs_equation_param_t *eqp, cs_real_t t_eval, cs_equation_builder_t *eqb, void *context, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux in each cells. Case of scalar-valued CDO-VCb schemes...
Definition: cs_cdovcb_scaleq.c:3147
cs_equation_common.h
cs_cdovcb_scaleq_free_context
void * cs_cdovcb_scaleq_free_context(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition: cs_cdovcb_scaleq.c:1296
cs_cdovcb_scaleq_init_common
void cs_cdovcb_scaleq_init_common(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms)
Allocate work buffer and general structures related to CDO vertex+cell-based schemes Set shared point...
Definition: cs_cdovcb_scaleq.c:889
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:93
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
cs_cdovcb_scaleq_finalize_common
void cs_cdovcb_scaleq_finalize_common(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition: cs_cdovcb_scaleq.c:963
cs_cdo_quantities.h
cs_cdovcb_scaleq_extra_post
void cs_cdovcb_scaleq_extra_post(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Predefined extra-operations related to this equation.
Definition: cs_cdovcb_scaleq.c:3600
cs_cdovcb_scaleq_vtx_gradient
void cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values, cs_equation_builder_t *eqb, void *context, cs_real_t *v_gradient)
Cellwise computation of the discrete gradient at vertices.
Definition: cs_cdovcb_scaleq.c:3350
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdovcb_scaleq_get_cell_values
cs_real_t * cs_cdovcb_scaleq_get_cell_values(void *context, bool previous)
Get the computed values at mesh cells from the inverse operation w.r.t. the static condensation (DoF ...
Definition: cs_cdovcb_scaleq.c:2713
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_cdovcb_scaleq_solve_theta
void cs_cdovcb_scaleq_solve_theta(bool cur2prev, const cs_mesh_t *mesh, const int field_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build and solve the linear system arising from a scalar unsteady convection/diffusion/reaction equati...
Definition: cs_cdovcb_scaleq.c:2277
cs_equation_param.h
cs_cdovcb_scaleq_interpolate
void cs_cdovcb_scaleq_interpolate(const cs_mesh_t *mesh, const cs_real_t *cell_values, const int field_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build and solve the linear system arising from a scalar steady-state equation with a CDO-VCb scheme...
Definition: cs_cdovcb_scaleq.c:1458
cs_cdovcb_scaleq_flux_across_plane
void cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[], const cs_real_t *pdi, const cs_equation_param_t *eqp, int ml_id, cs_equation_builder_t *eqb, void *context, double *d_flux, double *c_flux)
Compute the diffusive and convective flux across a list of faces Case of scalar-valued CDO-Vcb scheme...
Definition: cs_cdovcb_scaleq.c:2955
cs_cdovcb_scaleq_current_to_previous
void cs_cdovcb_scaleq_current_to_previous(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Operate a current to previous operation for the field associated to this equation and potentially for...
Definition: cs_cdovcb_scaleq.c:3568
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:89
mesh
Definition: mesh.f90:26
cs_cdovcb_scaleq_is_initialized
bool cs_cdovcb_scaleq_is_initialized(void)
Check if the generic structures for building a CDO-vertex+cell based scheme are allocated.
Definition: cs_cdovcb_scaleq.c:867