8.3
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-2024 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_cdo_toolbox.h"
38#include "cs_equation_builder.h"
39#include "cs_equation_param.h"
40#include "cs_field.h"
41#include "cs_matrix.h"
42#include "cs_mesh.h"
43#include "cs_source_term.h"
44#include "cs_time_step.h"
45
46/*----------------------------------------------------------------------------*/
47
48BEGIN_C_DECLS
49
50/*============================================================================
51 * Macro definitions
52 *============================================================================*/
53
54/*============================================================================
55 * Public function prototypes
56 *============================================================================*/
57
58/*----------------------------------------------------------------------------*/
65/*----------------------------------------------------------------------------*/
66
67bool
68cs_cdovb_scaleq_is_initialized(void);
69
70/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_cdovb_scaleq_init_sharing(const cs_cdo_quantities_t *quant,
83 const cs_cdo_connect_t *connect,
84 const cs_time_step_t *time_step);
85
86/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95void
96cs_cdovb_scaleq_get(cs_cell_sys_t **csys,
97 cs_cell_builder_t **cb);
98
99/*----------------------------------------------------------------------------*/
104/*----------------------------------------------------------------------------*/
105
106void
107cs_cdovb_scaleq_finalize_sharing(void);
108
109/*----------------------------------------------------------------------------*/
121/*----------------------------------------------------------------------------*/
122
123void *
124cs_cdovb_scaleq_init_context(cs_equation_param_t *eqp,
125 int var_id,
126 int bflux_id,
127 cs_equation_builder_t *eqb);
128
129/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139void *
140cs_cdovb_scaleq_free_context(void *scheme_context);
141
142/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
158cs_cdovb_scaleq_setup(cs_real_t t_eval,
159 const cs_mesh_t *mesh,
160 const cs_equation_param_t *eqp,
161 cs_equation_builder_t *eqb,
162 cs_flag_t vtx_bc_flag[]);
163
164/*----------------------------------------------------------------------------*/
175/*----------------------------------------------------------------------------*/
176
177void
178cs_cdovb_scaleq_init_properties(int t_id,
179 cs_real_t t_eval,
180 const cs_equation_param_t *eqp,
181 cs_equation_builder_t *eqb,
182 void *context);
183
184/*----------------------------------------------------------------------------*/
208/*----------------------------------------------------------------------------*/
209
210double
211cs_cdovb_scaleq_build_block_implicit(int t_id,
212 cs_lnum_t c_id,
213 bool diag_block,
214 const cs_real_t f_val[],
215 const cs_equation_param_t *eqp,
216 cs_equation_builder_t *eqb,
217 void *context,
218 cs_cell_builder_t *cb,
219 cs_cell_sys_t *csys);
220
221/*----------------------------------------------------------------------------*/
250/*----------------------------------------------------------------------------*/
251
252double
253cs_cdovb_scaleq_build_block_implicit_incr(int t_id,
254 cs_lnum_t c_id,
255 bool diag_block,
256 const cs_real_t f_val[],
257 const cs_equation_param_t *eqp,
258 cs_equation_builder_t *eqb,
259 void *context,
260 cs_cell_builder_t *cb,
261 cs_cell_sys_t *csys);
262
263/*----------------------------------------------------------------------------*/
276/*----------------------------------------------------------------------------*/
277
278void
279cs_cdovb_scaleq_init_values(cs_real_t t_eval,
280 const int field_id,
281 const cs_mesh_t *mesh,
282 const cs_equation_param_t *eqp,
283 cs_equation_builder_t *eqb,
284 void *context);
285
286/*----------------------------------------------------------------------------*/
299/*----------------------------------------------------------------------------*/
300
301void
302cs_cdovb_scaleq_solve_steady_state(bool cur2prev,
303 const cs_mesh_t *mesh,
304 const int field_id,
305 const cs_equation_param_t *eqp,
306 cs_equation_builder_t *eqb,
307 void *context);
308
309/*----------------------------------------------------------------------------*/
327/*----------------------------------------------------------------------------*/
328
329void
330cs_cdovb_scaleq_solve_steady_state_incr(bool cur2prev,
331 const cs_mesh_t *mesh,
332 const int field_id,
333 const cs_equation_param_t *eqp,
334 cs_equation_builder_t *eqb,
335 void *context);
336
337/*----------------------------------------------------------------------------*/
351/*----------------------------------------------------------------------------*/
352
353void
354cs_cdovb_scaleq_solve_implicit(bool cur2prev,
355 const cs_mesh_t *mesh,
356 const int field_id,
357 const cs_equation_param_t *eqp,
358 cs_equation_builder_t *eqb,
359 void *context);
360
361/*----------------------------------------------------------------------------*/
380/*----------------------------------------------------------------------------*/
381
382void
383cs_cdovb_scaleq_solve_implicit_incr(bool cur2prev,
384 const cs_mesh_t *mesh,
385 const int field_id,
386 const cs_equation_param_t *eqp,
387 cs_equation_builder_t *eqb,
388 void *context);
389
390/*----------------------------------------------------------------------------*/
404/*----------------------------------------------------------------------------*/
405
406void
407cs_cdovb_scaleq_solve_theta(bool cur2prev,
408 const cs_mesh_t *mesh,
409 const int field_id,
410 const cs_equation_param_t *eqp,
411 cs_equation_builder_t *eqb,
412 void *context);
413
414/*----------------------------------------------------------------------------*/
426/*----------------------------------------------------------------------------*/
427
428cs_real_t *
429cs_cdovb_scaleq_get_vertex_values(void *context,
430 bool previous);
431
432/*----------------------------------------------------------------------------*/
445/*----------------------------------------------------------------------------*/
446
447cs_real_t *
448cs_cdovb_scaleq_get_cell_values(void *context,
449 bool previous);
450
451/*----------------------------------------------------------------------------*/
461/*----------------------------------------------------------------------------*/
462
463cs_real_t *
464cs_cdovb_scaleq_get_source_term_values(void *context);
465
466/*----------------------------------------------------------------------------*/
478/*----------------------------------------------------------------------------*/
479
480cs_cdo_balance_t *
481cs_cdovb_scaleq_balance(const cs_equation_param_t *eqp,
482 cs_equation_builder_t *eqb,
483 void *context);
484
485/*----------------------------------------------------------------------------*/
500/*----------------------------------------------------------------------------*/
501
502void
503cs_cdovb_scaleq_apply_stiffness(const cs_equation_param_t *eqp,
504 cs_equation_builder_t *eqb,
505 void *context,
506 const cs_property_t *pty,
507 const cs_real_t *pot,
508 cs_flag_t res_loc,
509 cs_real_t *res);
510
511/*----------------------------------------------------------------------------*/
529/*----------------------------------------------------------------------------*/
530
531void
532cs_cdovb_scaleq_boundary_diff_flux(const cs_real_t *values,
533 const cs_equation_param_t *eqp,
534 const cs_property_t *diff_pty,
535 const cs_real_t t_eval,
536 cs_equation_builder_t *eqb,
537 void *context,
538 cs_real_t *vf_flux);
539
540/*----------------------------------------------------------------------------*/
554/*----------------------------------------------------------------------------*/
555
556void
557cs_cdovb_scaleq_flux_across_plane(const cs_real_t normal[],
558 const cs_real_t *pdi,
559 const cs_equation_param_t *eqp,
560 int ml_id,
561 cs_equation_builder_t *eqb,
562 void *context,
563 double *d_flux,
564 double *c_flux);
565
566/*----------------------------------------------------------------------------*/
580/*----------------------------------------------------------------------------*/
581
582void
583cs_cdovb_scaleq_diff_flux_in_cells(const cs_real_t *values,
584 const cs_equation_param_t *eqp,
585 const cs_property_t *diff_pty,
586 cs_real_t t_eval,
587 cs_equation_builder_t *eqb,
588 void *eq_context,
589 cs_real_t *diff_flux);
590
591/*----------------------------------------------------------------------------*/
605/*----------------------------------------------------------------------------*/
606
607void
608cs_cdovb_scaleq_diff_flux_dfaces(const cs_real_t *values,
609 const cs_equation_param_t *eqp,
610 const cs_property_t *diff_pty,
611 cs_real_t t_eval,
612 cs_equation_builder_t *eqb,
613 void *eq_context,
614 cs_real_t *diff_flux);
615
616/*----------------------------------------------------------------------------*/
625/*----------------------------------------------------------------------------*/
626
627void
628cs_cdovb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
629 cs_equation_builder_t *eqb,
630 void *context);
631
632/*----------------------------------------------------------------------------*/
640/*----------------------------------------------------------------------------*/
641
642void
643cs_cdovb_scaleq_extra_post(const cs_equation_param_t *eqp,
644 cs_equation_builder_t *eqb,
645 void *context);
646
647/*----------------------------------------------------------------------------*/
648
649END_C_DECLS
650
651#endif /* __CS_CDOVB_SCALEQ_H__ */
cs_base.h
cs_cdo_connect.h
cs_cdo_local.h
cs_cdo_quantities.h
cs_cdo_toolbox.h
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.cpp:2744
cs_cdovb_scaleq_init_sharing
void cs_cdovb_scaleq_init_sharing(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Allocate work buffer and general structures related to CDO vertex-based schemes. Set shared pointers.
Definition: cs_cdovb_scaleq.cpp:1372
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, const cs_property_t *diff_pty, cs_real_t t_eval, cs_equation_builder_t *eqb, void *eq_context, cs_real_t *diff_flux)
Cellwise and threaded computation of an approximation of a constant diffusive flux (a vector) in each...
Definition: cs_cdovb_scaleq.cpp:5080
cs_cdovb_scaleq_finalize_sharing
void cs_cdovb_scaleq_finalize_sharing(void)
Free work buffer and general structure related to CDO vertex-based schemes.
Definition: cs_cdovb_scaleq.cpp:1439
cs_cdovb_scaleq_free_context
void * cs_cdovb_scaleq_free_context(void *scheme_context)
Destroy a cs_cdovb_scaleq_t structure.
Definition: cs_cdovb_scaleq.cpp:2140
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.cpp:1422
cs_cdovb_scaleq_apply_stiffness
void cs_cdovb_scaleq_apply_stiffness(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context, const cs_property_t *pty, const cs_real_t *pot, cs_flag_t res_loc, cs_real_t *res)
Compute the cellwise stiffness matrix associated to the property given as a parameter and multiply it...
Definition: cs_cdovb_scaleq.cpp:4479
cs_cdovb_scaleq_boundary_diff_flux
void cs_cdovb_scaleq_boundary_diff_flux(const cs_real_t *values, const cs_equation_param_t *eqp, const cs_property_t *diff_pty, const cs_real_t t_eval, 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.cpp:4640
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.cpp:4061
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.cpp:5386
cs_cdovb_scaleq_init_properties
void cs_cdovb_scaleq_init_properties(int t_id, cs_real_t t_eval, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Set the main properties before the main loop on cells. Case of scalar-valued CDO-Vb schemes.
Definition: cs_cdovb_scaleq.cpp:2223
cs_cdovb_scaleq_solve_steady_state_incr
void cs_cdovb_scaleq_solve_steady_state_incr(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.cpp:2967
cs_cdovb_scaleq_diff_flux_dfaces
void cs_cdovb_scaleq_diff_flux_dfaces(const cs_real_t *values, const cs_equation_param_t *eqp, const cs_property_t *diff_pty, cs_real_t t_eval, cs_equation_builder_t *eqb, void *eq_context, cs_real_t *diff_flux)
Cellwise and threaded computation of the diffusive flux accross dual faces (a scalar) in each cell....
Definition: cs_cdovb_scaleq.cpp:5225
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.cpp:3742
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.cpp:4029
cs_cdovb_scaleq_init_context
void * cs_cdovb_scaleq_init_context(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.cpp:1475
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.cpp:3226
cs_cdovb_scaleq_get_source_term_values
cs_real_t * cs_cdovb_scaleq_get_source_term_values(void *context)
Retrieve the array storing the source term values at dual mesh cells. The lifecycle of this array is ...
Definition: cs_cdovb_scaleq.cpp:4109
cs_cdovb_scaleq_balance
cs_cdo_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.cpp:4134
cs_cdovb_scaleq_setup
void cs_cdovb_scaleq_setup(cs_real_t t_eval, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, cs_flag_t vtx_bc_flag[])
Set the boundary conditions known from the settings Define an indirection array for the enforcement o...
Definition: cs_cdovb_scaleq.cpp:2179
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.cpp:5410
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.cpp:1352
cs_cdovb_scaleq_build_block_implicit_incr
double cs_cdovb_scaleq_build_block_implicit_incr(int t_id, cs_lnum_t c_id, bool diag_block, const cs_real_t f_val[], const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Build the cell system for the given cell id when the build occurs in a coupled system....
Definition: cs_cdovb_scaleq.cpp:2454
cs_cdovb_scaleq_solve_implicit_incr
void cs_cdovb_scaleq_solve_implicit_incr(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.cpp:3462
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.cpp:4898
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....
Definition: cs_cdovb_scaleq.cpp:2632
cs_cdovb_scaleq_build_block_implicit
double cs_cdovb_scaleq_build_block_implicit(int t_id, cs_lnum_t c_id, bool diag_block, const cs_real_t f_val[], const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Build the cell system for the given cell id when the build occurs in a coupled system....
Definition: cs_cdovb_scaleq.cpp:2274
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:335
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:344
cs_equation_builder.h
cs_equation_param.h
cs_field.h
cs_matrix.h
cs_mesh.h
cs_source_term.h
cs_time_step.h
mesh
Definition: mesh.f90:26
cs_cdo_balance_t
Definition: cs_cdo_toolbox.h:68
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:139
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
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:147
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:192
cs_mesh_t
Definition: cs_mesh.h:85
cs_property_t
Structure associated to the definition of a property relying on the cs_xdef_t structure.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64