7.1
general documentation
cs_cdovb_scaleq.h
Go to the documentation of this file.
1 #ifndef __CS_CDOVB_SCALEQ_H__
2 #define __CS_CDOVB_SCALEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO vertex-based system for unsteady convection diffusion
6  * 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_cdo_connect.h"
35 #include "cs_cdo_local.h"
36 #include "cs_cdo_quantities.h"
37 #include "cs_equation_common.h"
38 #include "cs_equation_param.h"
39 #include "cs_field.h"
40 #include "cs_matrix.h"
41 #include "cs_mesh.h"
42 #include "cs_source_term.h"
43 #include "cs_time_step.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_cdovb_scaleq_is_initialized(void);
68 
69 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_cdovb_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_cdovb_scaleq_get(cs_cell_sys_t **csys,
99  cs_cell_builder_t **cb);
100 
101 /*----------------------------------------------------------------------------*/
106 /*----------------------------------------------------------------------------*/
107 
108 void
109 cs_cdovb_scaleq_finalize_common(void);
110 
111 /*----------------------------------------------------------------------------*/
123 /*----------------------------------------------------------------------------*/
124 
125 void *
126 cs_cdovb_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_cdovb_scaleq_free_context(void *builder);
143 
144 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
160 cs_cdovb_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 /*----------------------------------------------------------------------------*/
180 /*----------------------------------------------------------------------------*/
181 
182 void
183 cs_cdovb_scaleq_solve_steady_state(bool cur2prev,
184  const cs_mesh_t *mesh,
185  const int field_id,
186  const cs_equation_param_t *eqp,
187  cs_equation_builder_t *eqb,
188  void *context);
189 
190 /*----------------------------------------------------------------------------*/
204 /*----------------------------------------------------------------------------*/
205 
206 void
207 cs_cdovb_scaleq_solve_implicit(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_cdovb_scaleq_solve_theta(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 /*----------------------------------------------------------------------------*/
250 /*----------------------------------------------------------------------------*/
251 
252 cs_real_t *
253 cs_cdovb_scaleq_get_vertex_values(void *context,
254  bool previous);
255 
256 /*----------------------------------------------------------------------------*/
269 /*----------------------------------------------------------------------------*/
270 
271 cs_real_t *
272 cs_cdovb_scaleq_get_cell_values(void *context,
273  bool previous);
274 
275 /*----------------------------------------------------------------------------*/
287 /*----------------------------------------------------------------------------*/
288 
289 cs_equation_balance_t *
290 cs_cdovb_scaleq_balance(const cs_equation_param_t *eqp,
291  cs_equation_builder_t *eqb,
292  void *context);
293 
294 /*----------------------------------------------------------------------------*/
309 /*----------------------------------------------------------------------------*/
310 
311 void
312 cs_cdovb_scaleq_boundary_diff_flux(const cs_real_t t_eval,
313  const cs_equation_param_t *eqp,
314  const cs_real_t *pdi,
315  cs_equation_builder_t *eqb,
316  void *context,
317  cs_real_t *vf_flux);
318 
319 /*----------------------------------------------------------------------------*/
333 /*----------------------------------------------------------------------------*/
334 
335 void
336 cs_cdovb_scaleq_flux_across_plane(const cs_real_t normal[],
337  const cs_real_t *pdi,
338  const cs_equation_param_t *eqp,
339  int ml_id,
340  cs_equation_builder_t *eqb,
341  void *context,
342  double *d_flux,
343  double *c_flux);
344 
345 /*----------------------------------------------------------------------------*/
358 /*----------------------------------------------------------------------------*/
359 
360 void
361 cs_cdovb_scaleq_diff_flux_in_cells(const cs_real_t *values,
362  const cs_equation_param_t *eqp,
363  cs_real_t t_eval,
364  cs_equation_builder_t *eqb,
365  void *context,
366  cs_real_t *diff_flux);
367 
368 /*----------------------------------------------------------------------------*/
381 /*----------------------------------------------------------------------------*/
382 
383 void
384 cs_cdovb_scaleq_diff_flux_dfaces(const cs_real_t *values,
385  const cs_equation_param_t *eqp,
386  cs_real_t t_eval,
387  cs_equation_builder_t *eqb,
388  void *context,
389  cs_real_t *diff_flux);
390 
391 /*----------------------------------------------------------------------------*/
400 /*----------------------------------------------------------------------------*/
401 
402 void
403 cs_cdovb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
404  cs_equation_builder_t *eqb,
405  void *context);
406 
407 /*----------------------------------------------------------------------------*/
415 /*----------------------------------------------------------------------------*/
416 
417 void
418 cs_cdovb_scaleq_extra_post(const cs_equation_param_t *eqp,
419  cs_equation_builder_t *eqb,
420  void *context);
421 
422 /*----------------------------------------------------------------------------*/
423 
424 END_C_DECLS
425 
426 #endif /* __CS_CDOVB_SCALEQ_H__ */
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_cdovb_scaleq_boundary_diff_flux
void cs_cdovb_scaleq_boundary_diff_flux(const cs_real_t t_eval, const cs_equation_param_t *eqp, const cs_real_t *pdi, 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_cdovb_scaleq.c:2796
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_base.h
cs_cdovb_scaleq_balance
cs_equation_balance_t * cs_cdovb_scaleq_balance(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Compute the balance for an equation over the full computational domain between time t_cur and t_cur +...
Definition: cs_cdovb_scaleq.c:2448
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_cdo_connect.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_cdovb_scaleq_current_to_previous
void cs_cdovb_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_cdovb_scaleq.c:3464
cs_cdo_connect_t
Definition: cs_cdo_connect.h:79
cs_cdovb_scaleq_solve_steady_state
void cs_cdovb_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_cdovb_scaleq.c:1480
cs_cdovb_scaleq_diff_flux_dfaces
void cs_cdovb_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 accross dual faces (a scalar) in each cell. Case of scalar-valued CDO-Vb schemes.
Definition: cs_cdovb_scaleq.c:3333
cs_cdovb_scaleq_finalize_common
void cs_cdovb_scaleq_finalize_common(void)
Free work buffer and general structure related to CDO vertex-based schemes.
Definition: cs_cdovb_scaleq.c:803
cs_matrix.h
cs_source_term.h
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_cdovb_scaleq_extra_post
void cs_cdovb_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_cdovb_scaleq.c:3488
cs_mesh_t
Definition: cs_mesh.h:84
cs_cdovb_scaleq_get
void cs_cdovb_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdovb_scaleq.c:781
cs_equation_balance_t
Definition: cs_equation_common.h:233
cs_equation_common.h
cs_cdovb_scaleq_free_context
void * cs_cdovb_scaleq_free_context(void *builder)
Destroy a cs_cdovb_scaleq_t structure.
Definition: cs_cdovb_scaleq.c:1330
cs_cdovb_scaleq_diff_flux_in_cells
void cs_cdovb_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 an approximation of a constant diffusive flux (a vector) in each cell...
Definition: cs_cdovb_scaleq.c:3211
cs_cdovb_scaleq_flux_across_plane
void cs_cdovb_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-Vb schemes...
Definition: cs_cdovb_scaleq.c:3031
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
cs_cdovb_scaleq_get_cell_values
cs_real_t * cs_cdovb_scaleq_get_cell_values(void *context, bool previous)
Compute an array of values at mesh cells by interpolating the variable field associated to the given ...
Definition: cs_cdovb_scaleq.c:2399
cs_cdovb_scaleq_init_context
void * cs_cdovb_scaleq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdovb_scaleq_t structure storing data useful for building and managing such a scheme...
Definition: cs_cdovb_scaleq.c:839
cs_cdo_quantities.h
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdovb_scaleq_init_common
void cs_cdovb_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-based schemes Set shared pointers...
Definition: cs_cdovb_scaleq.c:727
cs_cdo_local.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_cdovb_scaleq_solve_theta
void cs_cdovb_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_cdovb_scaleq.c:2000
cs_cdovb_scaleq_solve_implicit
void cs_cdovb_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_cdovb_scaleq.c:1711
cs_cdovb_scaleq_is_initialized
bool cs_cdovb_scaleq_is_initialized(void)
Check if the generic structures for building a CDO-Vb scheme are allocated.
Definition: cs_cdovb_scaleq.c:705
cs_cdovb_scaleq_init_values
void cs_cdovb_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-Vb schemes.
Definition: cs_cdovb_scaleq.c:1369
cs_equation_param.h
cs_cdovb_scaleq_get_vertex_values
cs_real_t * cs_cdovb_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_cdovb_scaleq.c:2367
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:89
mesh
Definition: mesh.f90:26