8.3
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-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_time_step.h"
35#include "cs_mesh.h"
36#include "cs_equation_builder.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
47BEGIN_C_DECLS
48
49/*============================================================================
50 * Macro definitions
51 *============================================================================*/
52
53/*============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66bool
67cs_cdovcb_scaleq_is_initialized(void);
68
69/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
82cs_cdovcb_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_cdovcb_scaleq_get(cs_cell_sys_t **csys,
97 cs_cell_builder_t **cb);
98
99/*----------------------------------------------------------------------------*/
104/*----------------------------------------------------------------------------*/
105
106void
107cs_cdovcb_scaleq_finalize_sharing(void);
108
109/*----------------------------------------------------------------------------*/
121/*----------------------------------------------------------------------------*/
122
123void *
124cs_cdovcb_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_cdovcb_scaleq_free_context(void *data);
141
142/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
158cs_cdovcb_scaleq_init_values(cs_real_t t_eval,
159 const int field_id,
160 const cs_mesh_t *mesh,
161 const cs_equation_param_t *eqp,
162 cs_equation_builder_t *eqb,
163 void *context);
164
165/*----------------------------------------------------------------------------*/
179/*----------------------------------------------------------------------------*/
180
181void
182cs_cdovcb_scaleq_interpolate(const cs_mesh_t *mesh,
183 const cs_real_t *cell_values,
184 const int field_id,
185 const cs_equation_param_t *eqp,
186 cs_equation_builder_t *eqb,
187 void *context);
188
189/*----------------------------------------------------------------------------*/
202/*----------------------------------------------------------------------------*/
203
204void
205cs_cdovcb_scaleq_solve_steady_state(bool cur2prev,
206 const cs_mesh_t *mesh,
207 const int field_id,
208 const cs_equation_param_t *eqp,
209 cs_equation_builder_t *eqb,
210 void *context);
211
212/*----------------------------------------------------------------------------*/
226/*----------------------------------------------------------------------------*/
227
228void
229cs_cdovcb_scaleq_solve_implicit(bool cur2prev,
230 const cs_mesh_t *mesh,
231 const int field_id,
232 const cs_equation_param_t *eqp,
233 cs_equation_builder_t *eqb,
234 void *context);
235
236/*----------------------------------------------------------------------------*/
250/*----------------------------------------------------------------------------*/
251
252void
253cs_cdovcb_scaleq_solve_theta(bool cur2prev,
254 const cs_mesh_t *mesh,
255 const int field_id,
256 const cs_equation_param_t *eqp,
257 cs_equation_builder_t *eqb,
258 void *context);
259
260/*----------------------------------------------------------------------------*/
272/*----------------------------------------------------------------------------*/
273
274cs_real_t *
275cs_cdovcb_scaleq_get_vertex_values(void *context,
276 bool previous);
277
278/*----------------------------------------------------------------------------*/
292/*----------------------------------------------------------------------------*/
293
294cs_real_t *
295cs_cdovcb_scaleq_get_cell_values(void *context,
296 bool previous);
297
298/*----------------------------------------------------------------------------*/
308/*----------------------------------------------------------------------------*/
309
310cs_real_t *
311cs_cdovcb_scaleq_get_source_term_values(void *context);
312
313/*----------------------------------------------------------------------------*/
330/*----------------------------------------------------------------------------*/
331
332void
333cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t *pot_v,
334 const cs_real_t *pot_c,
335 const cs_equation_param_t *eqp,
336 const cs_property_t *diff_pty,
337 const cs_real_t t_eval,
338 cs_equation_builder_t *eqb,
339 void *context,
340 cs_real_t *vf_flux);
341
342/*----------------------------------------------------------------------------*/
356/*----------------------------------------------------------------------------*/
357
358void
359cs_cdovcb_scaleq_flux_across_plane(const cs_real_t normal[],
360 const cs_real_t *pdi,
361 const cs_equation_param_t *eqp,
362 int ml_id,
363 cs_equation_builder_t *eqb,
364 void *context,
365 double *d_flux,
366 double *c_flux);
367
368/*----------------------------------------------------------------------------*/
382/*----------------------------------------------------------------------------*/
383
384void
385cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *v_values,
386 const cs_real_t *c_values,
387 const cs_equation_param_t *eqp,
388 const cs_property_t *diff_pty,
389 cs_real_t t_eval,
390 cs_equation_builder_t *eqb,
391 void *context,
392 cs_real_t *diff_flux);
393
394/*----------------------------------------------------------------------------*/
410/*----------------------------------------------------------------------------*/
411
412void
413cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *v_values,
414 const cs_real_t *c_values,
415 const cs_equation_param_t *eqp,
416 const cs_property_t *diff_pty,
417 cs_real_t t_eval,
418 cs_equation_builder_t *eqb,
419 void *context,
420 cs_real_t *diff_flux);
421
422/*----------------------------------------------------------------------------*/
431/*----------------------------------------------------------------------------*/
432
433void
434cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values,
435 cs_equation_builder_t *eqb,
436 void *context,
437 cs_real_t *v_gradient);
438
439/*----------------------------------------------------------------------------*/
448/*----------------------------------------------------------------------------*/
449
450void
451cs_cdovcb_scaleq_read_restart(cs_restart_t *restart,
452 const char *eqname,
453 void *scheme_context);
454
455/*----------------------------------------------------------------------------*/
464/*----------------------------------------------------------------------------*/
465
466void
467cs_cdovcb_scaleq_write_restart(cs_restart_t *restart,
468 const char *eqname,
469 void *scheme_context);
470
471/*----------------------------------------------------------------------------*/
480/*----------------------------------------------------------------------------*/
481
482void
483cs_cdovcb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
484 cs_equation_builder_t *eqb,
485 void *context);
486
487/*----------------------------------------------------------------------------*/
495/*----------------------------------------------------------------------------*/
496
497void
498cs_cdovcb_scaleq_extra_post(const cs_equation_param_t *eqp,
499 cs_equation_builder_t *eqb,
500 void *context);
501
502/*----------------------------------------------------------------------------*/
503
504END_C_DECLS
505
506#endif /* __CS_CDOVCB_SCALEQ_H__ */
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:3686
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:3313
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:3186
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:1970
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:2733
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:3612
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:895
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:874
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:1731
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:3438
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:960
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:1372
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:2706
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:2673
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:2994
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:1332
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:2280
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:2763
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:3654
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:1496
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:996
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:943
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:3558
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_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:95
cs_source_term.h
cs_time_step.h
mesh
Definition: mesh.f90:26
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