9.2
general documentation
cs_cdofb_scaleq.h
Go to the documentation of this file.
1#ifndef CS_CDOFB_SCALEQ_H
2#define CS_CDOFB_SCALEQ_H
3
4/*============================================================================
5 * Build an algebraic CDO face-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-2026 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
31#include "base/cs_defs.h"
32
33/*----------------------------------------------------------------------------
34 * Standard C library headers
35 *----------------------------------------------------------------------------*/
36
37/*----------------------------------------------------------------------------
38 * Local headers
39 *----------------------------------------------------------------------------*/
40
41#include "alge/cs_matrix.h"
42#include "base/cs_base.h"
43#include "base/cs_field.h"
44#include "base/cs_restart.h"
45#include "base/cs_time_step.h"
46#include "cdo/cs_cdo_connect.h"
47#include "cdo/cs_cdo_local.h"
48#include "cdo/cs_cdo_quantities.h"
49#include "cdo/cs_cdo_toolbox.h"
50#include "cdo/cs_cdofb_priv.h"
51#include "cdo/cs_equation_builder.h"
52#include "cdo/cs_equation_param.h"
53#include "cdo/cs_source_term.h"
54#include "mesh/cs_mesh.h"
55
56/*============================================================================
57 * Macro definitions
58 *============================================================================*/
59
60/*============================================================================
61 * Type definitions
62 *============================================================================*/
63
64/* Algebraic system for CDO face-based discretization */
65typedef struct _cs_cdofb_t cs_cdofb_scaleq_t;
66
67/*============================================================================
68 * Public function prototypes
69 *============================================================================*/
70
71/*----------------------------------------------------------------------------*/
78/*----------------------------------------------------------------------------*/
79
80bool
81cs_cdofb_scaleq_is_initialized(void);
82
83/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95void
96cs_cdofb_scaleq_init_sharing(const cs_cdo_quantities_t *quant,
97 const cs_cdo_connect_t *connect,
98 const cs_time_step_t *time_step);
99
100/*----------------------------------------------------------------------------*/
107/*----------------------------------------------------------------------------*/
108
109void
110cs_cdofb_scaleq_get(cs_cell_sys_t **csys,
111 cs_cell_builder_t **cb);
112
113/*----------------------------------------------------------------------------*/
118/*----------------------------------------------------------------------------*/
119
120void
121cs_cdofb_scaleq_finalize_sharing(void);
122
123/*----------------------------------------------------------------------------*/
135/*----------------------------------------------------------------------------*/
136
137void *
138cs_cdofb_scaleq_init_context(cs_equation_param_t *eqp,
139 int var_id,
140 int bflux_id,
141 cs_equation_builder_t *eqb);
142
143/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
153void *
154cs_cdofb_scaleq_free_context(void *data);
155
156/*----------------------------------------------------------------------------*/
169/*----------------------------------------------------------------------------*/
170
171void
172cs_cdofb_scaleq_init_values(cs_real_t t_eval,
173 const int field_id,
174 const cs_mesh_t *mesh,
175 const cs_equation_param_t *eqp,
176 cs_equation_builder_t *eqb,
177 void *context);
178
179/*----------------------------------------------------------------------------*/
193/*----------------------------------------------------------------------------*/
194
195void
196cs_cdofb_scaleq_interpolate(const cs_mesh_t *mesh,
197 const cs_real_t *cell_values,
198 const int field_id,
199 const cs_equation_param_t *eqp,
200 cs_equation_builder_t *eqb,
201 void *context);
202
203/*----------------------------------------------------------------------------*/
216/*----------------------------------------------------------------------------*/
217
218void
219cs_cdofb_scaleq_solve_steady_state(bool cur2prev,
220 const cs_mesh_t *mesh,
221 const int field_id,
222 const cs_equation_param_t *eqp,
223 cs_equation_builder_t *eqb,
224 void *context);
225
226/*----------------------------------------------------------------------------*/
240/*----------------------------------------------------------------------------*/
241
242void
243cs_cdofb_scaleq_solve_implicit(bool cur2prev,
244 const cs_mesh_t *mesh,
245 const int field_id,
246 const cs_equation_param_t *eqp,
247 cs_equation_builder_t *eqb,
248 void *context);
249
250/*----------------------------------------------------------------------------*/
264/*----------------------------------------------------------------------------*/
265
266void
267cs_cdofb_scaleq_solve_theta(bool cur2prev,
268 const cs_mesh_t *mesh,
269 const int field_id,
270 const cs_equation_param_t *eqp,
271 cs_equation_builder_t *eqb,
272 void *context);
273
274/*----------------------------------------------------------------------------*/
286/*----------------------------------------------------------------------------*/
287
288cs_cdo_balance_t *
289cs_cdofb_scaleq_balance(const cs_equation_param_t *eqp,
290 cs_equation_builder_t *eqb,
291 void *context);
292
293/*----------------------------------------------------------------------------*/
309/*----------------------------------------------------------------------------*/
310
311void
312cs_cdofb_scaleq_diff_flux_faces(const cs_real_t *f_values,
313 const cs_real_t *c_values,
314 const cs_equation_param_t *eqp,
315 const cs_property_t *diff_pty,
316 cs_real_t t_eval,
317 cs_equation_builder_t *eqb,
318 void *context,
319 cs_real_t *diff_flux);
320
321/*----------------------------------------------------------------------------*/
336/*----------------------------------------------------------------------------*/
337
338void
339cs_cdofb_scaleq_boundary_diff_flux(const cs_real_t *pot_f,
340 const cs_real_t *pot_c,
341 const cs_equation_param_t *eqp,
342 const cs_property_t *diff_pty,
343 const cs_real_t t_eval,
344 cs_equation_builder_t *eqb,
345 void *context,
346 cs_real_t *bflux);
347
348/*----------------------------------------------------------------------------*/
357/*----------------------------------------------------------------------------*/
358
359void
360cs_cdofb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
361 cs_equation_builder_t *eqb,
362 void *context);
363
364/*----------------------------------------------------------------------------*/
372/*----------------------------------------------------------------------------*/
373
374void
375cs_cdofb_scaleq_extra_post(const cs_equation_param_t *eqp,
376 cs_equation_builder_t *eqb,
377 void *context);
378
379/*----------------------------------------------------------------------------*/
392/*----------------------------------------------------------------------------*/
393
394cs_real_t *
395cs_cdofb_scaleq_get_cell_values(void *context,
396 bool previous);
397
398/*----------------------------------------------------------------------------*/
409/*----------------------------------------------------------------------------*/
410
411cs_real_t *
412cs_cdofb_scaleq_get_face_values(void *context,
413 bool previous);
414
415/*----------------------------------------------------------------------------*/
425/*----------------------------------------------------------------------------*/
426
427cs_real_t *
428cs_cdofb_scaleq_get_source_term_values(void *context);
429
430/*----------------------------------------------------------------------------*/
439/*----------------------------------------------------------------------------*/
440
441void
442cs_cdofb_scaleq_read_restart(cs_restart_t *restart,
443 const char *eqname,
444 void *scheme_context);
445
446/*----------------------------------------------------------------------------*/
455/*----------------------------------------------------------------------------*/
456
457void
458cs_cdofb_scaleq_write_restart(cs_restart_t *restart,
459 const char *eqname,
460 void *scheme_context);
461
462#endif /* CS_CDOFB_SCALEQ_H */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
cs_base.h
cs_cdo_connect.h
cs_cdo_local.h
cs_cdo_quantities.h
cs_cdo_toolbox.h
cs_cdofb_priv.h
cs_cdofb_scaleq_solve_implicit
void cs_cdofb_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 convection/diffusion/reaction equation with a...
Definition: cs_cdofb_scaleq.cpp:1759
cs_cdofb_scaleq_current_to_previous
void cs_cdofb_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_cdofb_scaleq.cpp:3048
cs_cdofb_scaleq_finalize_sharing
void cs_cdofb_scaleq_finalize_sharing(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.cpp:778
cs_cdofb_scaleq_balance
cs_cdo_balance_t * cs_cdofb_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_cdofb_scaleq.cpp:2390
cs_cdofb_scaleq_init_values
void cs_cdofb_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_cdofb_scaleq.cpp:1148
cs_cdofb_scaleq_get_face_values
cs_real_t * cs_cdofb_scaleq_get_face_values(void *context, bool previous)
Retrieve an array of values at mesh faces for the current context. The lifecycle of this array is man...
Definition: cs_cdofb_scaleq.cpp:3170
cs_cdofb_scaleq_boundary_diff_flux
void cs_cdofb_scaleq_boundary_diff_flux(const cs_real_t *pot_f, const cs_real_t *pot_c, 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 *bflux)
Compute an approximation of the diffusive flux across each boundary face. Case of scalar-valued CDO-F...
Definition: cs_cdofb_scaleq.cpp:2854
cs_cdofb_scaleq_get_cell_values
cs_real_t * cs_cdofb_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_cdofb_scaleq.cpp:3140
cs_cdofb_scaleq_get
void cs_cdofb_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdofb_scaleq.cpp:761
cs_cdofb_scaleq_diff_flux_faces
void cs_cdofb_scaleq_diff_flux_faces(const cs_real_t *f_values, const cs_real_t *c_values, const cs_equation_param_t *eqp, const cs_property_t *diff_pty, cs_real_t t_eval, cs_equation_builder_t *eqb, void *context, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux accross primal faces. Interior faces first and then bounda...
Definition: cs_cdofb_scaleq.cpp:2702
cs_cdofb_scaleq_read_restart
void cs_cdofb_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_cdofb_scaleq.cpp:3221
cs_cdofb_scaleq_free_context
void * cs_cdofb_scaleq_free_context(void *data)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.cpp:1107
cs_cdofb_scaleq_get_source_term_values
cs_real_t * cs_cdofb_scaleq_get_source_term_values(void *context)
Retrieve the array storing the source term values at mesh cells. The lifecycle of this array is manag...
Definition: cs_cdofb_scaleq.cpp:3199
cs_cdofb_scaleq_extra_post
void cs_cdofb_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_cdofb_scaleq.cpp:3079
cs_cdofb_scaleq_write_restart
void cs_cdofb_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_cdofb_scaleq.cpp:3309
cs_cdofb_scaleq_is_initialized
bool cs_cdofb_scaleq_is_initialized(void)
Check if the generic structures for building a CDO-Fb scheme are allocated.
Definition: cs_cdofb_scaleq.cpp:692
cs_cdofb_scaleq_interpolate
void cs_cdofb_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 convection/diffusion/reaction eq...
Definition: cs_cdofb_scaleq.cpp:1288
cs_cdofb_scaleq_solve_steady_state
void cs_cdofb_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_cdofb_scaleq.cpp:1527
cs_cdofb_scaleq_init_sharing
void cs_cdofb_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 scalar-valued face-based schemes....
Definition: cs_cdofb_scaleq.cpp:713
cs_cdofb_scaleq_solve_theta
void cs_cdofb_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 convection/diffusion/reaction equation with a...
Definition: cs_cdofb_scaleq.cpp:2046
cs_cdofb_scaleq_init_context
void * cs_cdofb_scaleq_init_context(cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdofb_scaleq_t structure storing data useful for building and managing such a scheme.
Definition: cs_cdofb_scaleq.cpp:814
cs_defs.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_equation_builder.h
cs_equation_param.h
cs_field.h
cs_matrix.h
cs_mesh.h
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:91
cs_source_term.h
cs_time_step.h
mesh
Definition: mesh.f90:26
_cs_cdofb_t
Definition: cs_cdofb_priv.h:47
cs_cdo_balance_t
Definition: cs_cdo_toolbox.h:64
cs_cdo_connect_t
Definition: cs_cdo_connect.h:57
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:142
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:56
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:163
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:190
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.