9.2
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-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 * Local headers
31 *----------------------------------------------------------------------------*/
32
33#include "base/cs_base.h"
34#include "base/cs_field.h"
35#include "base/cs_restart.h"
36#include "base/cs_time_step.h"
37#include "cdo/cs_cdo_connect.h"
38#include "cdo/cs_cdo_quantities.h"
39#include "cdo/cs_equation_builder.h"
40#include "cdo/cs_equation_param.h"
41#include "cdo/cs_source_term.h"
42#include "mesh/cs_mesh.h"
43
44/*============================================================================
45 * Macro definitions
46 *============================================================================*/
47
48/*============================================================================
49 * Public function prototypes
50 *============================================================================*/
51
52/*----------------------------------------------------------------------------*/
59/*----------------------------------------------------------------------------*/
60
61bool
62cs_cdovcb_scaleq_is_initialized(void);
63
64/*----------------------------------------------------------------------------*/
74/*----------------------------------------------------------------------------*/
75
76void
77cs_cdovcb_scaleq_init_sharing(const cs_cdo_quantities_t *quant,
78 const cs_cdo_connect_t *connect,
79 const cs_time_step_t *time_step);
80
81/*----------------------------------------------------------------------------*/
88/*----------------------------------------------------------------------------*/
89
90void
91cs_cdovcb_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb);
92
93/*----------------------------------------------------------------------------*/
98/*----------------------------------------------------------------------------*/
99
100void
101cs_cdovcb_scaleq_finalize_sharing(void);
102
103/*----------------------------------------------------------------------------*/
115/*----------------------------------------------------------------------------*/
116
117void *
118cs_cdovcb_scaleq_init_context(cs_equation_param_t *eqp,
119 int var_id,
120 int bflux_id,
121 cs_equation_builder_t *eqb);
122
123/*----------------------------------------------------------------------------*/
131/*----------------------------------------------------------------------------*/
132
133void *
134cs_cdovcb_scaleq_free_context(void *data);
135
136/*----------------------------------------------------------------------------*/
149/*----------------------------------------------------------------------------*/
150
151void
152cs_cdovcb_scaleq_init_values(cs_real_t t_eval,
153 const int field_id,
154 const cs_mesh_t *mesh,
155 const cs_equation_param_t *eqp,
156 cs_equation_builder_t *eqb,
157 void *context);
158
159/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175void
176cs_cdovcb_scaleq_interpolate(const cs_mesh_t *mesh,
177 const cs_real_t *cell_values,
178 const int field_id,
179 const cs_equation_param_t *eqp,
180 cs_equation_builder_t *eqb,
181 void *context);
182
183/*----------------------------------------------------------------------------*/
196/*----------------------------------------------------------------------------*/
197
198void
199cs_cdovcb_scaleq_solve_steady_state(bool cur2prev,
200 const cs_mesh_t *mesh,
201 const int field_id,
202 const cs_equation_param_t *eqp,
203 cs_equation_builder_t *eqb,
204 void *context);
205
206/*----------------------------------------------------------------------------*/
220/*----------------------------------------------------------------------------*/
221
222void
223cs_cdovcb_scaleq_solve_implicit(bool cur2prev,
224 const cs_mesh_t *mesh,
225 const int field_id,
226 const cs_equation_param_t *eqp,
227 cs_equation_builder_t *eqb,
228 void *context);
229
230/*----------------------------------------------------------------------------*/
244/*----------------------------------------------------------------------------*/
245
246void
247cs_cdovcb_scaleq_solve_theta(bool cur2prev,
248 const cs_mesh_t *mesh,
249 const int field_id,
250 const cs_equation_param_t *eqp,
251 cs_equation_builder_t *eqb,
252 void *context);
253
254/*----------------------------------------------------------------------------*/
266/*----------------------------------------------------------------------------*/
267
268cs_real_t *
269cs_cdovcb_scaleq_get_vertex_values(void *context, bool previous);
270
271/*----------------------------------------------------------------------------*/
285/*----------------------------------------------------------------------------*/
286
287cs_real_t *
288cs_cdovcb_scaleq_get_cell_values(void *context, bool previous);
289
290/*----------------------------------------------------------------------------*/
300/*----------------------------------------------------------------------------*/
301
302cs_real_t *
303cs_cdovcb_scaleq_get_source_term_values(void *context);
304
305/*----------------------------------------------------------------------------*/
322/*----------------------------------------------------------------------------*/
323
324void
325cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t *pot_v,
326 const cs_real_t *pot_c,
327 const cs_equation_param_t *eqp,
328 const cs_property_t *diff_pty,
329 const cs_real_t t_eval,
330 cs_equation_builder_t *eqb,
331 void *context,
332 cs_real_t *vf_flux);
333
334/*----------------------------------------------------------------------------*/
348/*----------------------------------------------------------------------------*/
349
350void
351cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[],
352 const cs_real_t *pdi,
353 const cs_equation_param_t *eqp,
354 int ml_id,
355 cs_equation_builder_t *eqb,
356 void *context,
357 double *d_flux,
358 double *c_flux);
359
360/*----------------------------------------------------------------------------*/
374/*----------------------------------------------------------------------------*/
375
376void
377cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *v_values,
378 const cs_real_t *c_values,
379 const cs_equation_param_t *eqp,
380 const cs_property_t *diff_pty,
381 cs_real_t t_eval,
382 cs_equation_builder_t *eqb,
383 void *context,
384 cs_real_t *diff_flux);
385
386/*----------------------------------------------------------------------------*/
402/*----------------------------------------------------------------------------*/
403
404void
405cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *v_values,
406 const cs_real_t *c_values,
407 const cs_equation_param_t *eqp,
408 const cs_property_t *diff_pty,
409 cs_real_t t_eval,
410 cs_equation_builder_t *eqb,
411 void *context,
412 cs_real_t *diff_flux);
413
414/*----------------------------------------------------------------------------*/
423/*----------------------------------------------------------------------------*/
424
425void
426cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values,
427 cs_equation_builder_t *eqb,
428 void *context,
429 cs_real_t *v_gradient);
430
431/*----------------------------------------------------------------------------*/
440/*----------------------------------------------------------------------------*/
441
442void
443cs_cdovcb_scaleq_read_restart(cs_restart_t *restart,
444 const char *eqname,
445 void *scheme_context);
446
447/*----------------------------------------------------------------------------*/
456/*----------------------------------------------------------------------------*/
457
458void
459cs_cdovcb_scaleq_write_restart(cs_restart_t *restart,
460 const char *eqname,
461 void *scheme_context);
462
463/*----------------------------------------------------------------------------*/
472/*----------------------------------------------------------------------------*/
473
474void
475cs_cdovcb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
476 cs_equation_builder_t *eqb,
477 void *context);
478
479/*----------------------------------------------------------------------------*/
487/*----------------------------------------------------------------------------*/
488
489void
490cs_cdovcb_scaleq_extra_post(const cs_equation_param_t *eqp,
491 cs_equation_builder_t *eqb,
492 void *context);
493
494#endif /* CS_CDOVCB_SCALEQ_H */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
cs_base.h
cs_cdo_connect.h
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.cpp:3676
cs_cdovcb_scaleq_diff_flux_dfaces
void cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *v_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 and threaded computation of the diffusive flux across dual faces. This is only an interpolat...
Definition: cs_cdovcb_scaleq.cpp:3303
cs_cdovcb_scaleq_diff_flux_in_cells
void cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *v_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 and threaed computation of the diffusive flux in each cells. Case of scalar-valued CDO-VCb s...
Definition: cs_cdovcb_scaleq.cpp:3176
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.cpp:1961
cs_cdovcb_scaleq_get_source_term_values
cs_real_t * cs_cdovcb_scaleq_get_source_term_values(void *context)
Retrieve the array storing the source term values associated to each DoF. The lifecycle of this array...
Definition: cs_cdovcb_scaleq.cpp:2724
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.cpp:3602
cs_cdovcb_scaleq_init_sharing
void cs_cdovcb_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+cell-based schemes Set shared point...
Definition: cs_cdovcb_scaleq.cpp:887
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.cpp:866
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.cpp:1722
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.cpp:3428
cs_cdovcb_scaleq_finalize_sharing
void cs_cdovcb_scaleq_finalize_sharing(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition: cs_cdovcb_scaleq.cpp:952
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....
Definition: cs_cdovcb_scaleq.cpp:1363
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.cpp:2697
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.cpp:2664
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.cpp:2983
cs_cdovcb_scaleq_free_context
void * cs_cdovcb_scaleq_free_context(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition: cs_cdovcb_scaleq.cpp:1323
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.cpp:2271
cs_cdovcb_scaleq_boundary_diff_flux
void cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t *pot_v, 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 *vf_flux)
Compute for each vertex of a boundary face, the portion of diffusive flux across the boundary face....
Definition: cs_cdovcb_scaleq.cpp:2754
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.cpp:3644
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.cpp:1487
cs_cdovcb_scaleq_init_context
void * cs_cdovcb_scaleq_init_context(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.cpp:988
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.cpp:935
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.cpp:3548
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_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_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.