8.3
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-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
31#include "cs_defs.h"
32
33/*----------------------------------------------------------------------------
34 * Standard C library headers
35 *----------------------------------------------------------------------------*/
36
37/*----------------------------------------------------------------------------
38 * Local headers
39 *----------------------------------------------------------------------------*/
40
41#include "cs_base.h"
42#include "cs_cdo_connect.h"
43#include "cs_cdo_local.h"
44#include "cs_cdo_toolbox.h"
45#include "cs_cdo_quantities.h"
46#include "cs_cdofb_priv.h"
47#include "cs_equation_builder.h"
48#include "cs_equation_param.h"
49#include "cs_field.h"
50#include "cs_matrix.h"
51#include "cs_mesh.h"
52#include "cs_restart.h"
53#include "cs_source_term.h"
54#include "cs_time_step.h"
55
56/*----------------------------------------------------------------------------*/
57
58BEGIN_C_DECLS
59
60/*============================================================================
61 * Macro definitions
62 *============================================================================*/
63
64/*============================================================================
65 * Type definitions
66 *============================================================================*/
67
68/* Algebraic system for CDO face-based discretization */
69typedef struct _cs_cdofb_t cs_cdofb_scaleq_t;
70
71/*============================================================================
72 * Public function prototypes
73 *============================================================================*/
74
75/*----------------------------------------------------------------------------*/
82/*----------------------------------------------------------------------------*/
83
84bool
85cs_cdofb_scaleq_is_initialized(void);
86
87/*----------------------------------------------------------------------------*/
97/*----------------------------------------------------------------------------*/
98
99void
100cs_cdofb_scaleq_init_sharing(const cs_cdo_quantities_t *quant,
101 const cs_cdo_connect_t *connect,
102 const cs_time_step_t *time_step);
103
104/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113void
114cs_cdofb_scaleq_get(cs_cell_sys_t **csys,
115 cs_cell_builder_t **cb);
116
117/*----------------------------------------------------------------------------*/
122/*----------------------------------------------------------------------------*/
123
124void
125cs_cdofb_scaleq_finalize_sharing(void);
126
127/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141void *
142cs_cdofb_scaleq_init_context(cs_equation_param_t *eqp,
143 int var_id,
144 int bflux_id,
145 cs_equation_builder_t *eqb);
146
147/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void *
158cs_cdofb_scaleq_free_context(void *data);
159
160/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175void
176cs_cdofb_scaleq_init_values(cs_real_t t_eval,
177 const int field_id,
178 const cs_mesh_t *mesh,
179 const cs_equation_param_t *eqp,
180 cs_equation_builder_t *eqb,
181 void *context);
182
183/*----------------------------------------------------------------------------*/
197/*----------------------------------------------------------------------------*/
198
199void
200cs_cdofb_scaleq_interpolate(const cs_mesh_t *mesh,
201 const cs_real_t *cell_values,
202 const int field_id,
203 const cs_equation_param_t *eqp,
204 cs_equation_builder_t *eqb,
205 void *context);
206
207/*----------------------------------------------------------------------------*/
220/*----------------------------------------------------------------------------*/
221
222void
223cs_cdofb_scaleq_solve_steady_state(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_cdofb_scaleq_solve_implicit(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/*----------------------------------------------------------------------------*/
268/*----------------------------------------------------------------------------*/
269
270void
271cs_cdofb_scaleq_solve_theta(bool cur2prev,
272 const cs_mesh_t *mesh,
273 const int field_id,
274 const cs_equation_param_t *eqp,
275 cs_equation_builder_t *eqb,
276 void *context);
277
278/*----------------------------------------------------------------------------*/
290/*----------------------------------------------------------------------------*/
291
292cs_cdo_balance_t *
293cs_cdofb_scaleq_balance(const cs_equation_param_t *eqp,
294 cs_equation_builder_t *eqb,
295 void *context);
296
297/*----------------------------------------------------------------------------*/
313/*----------------------------------------------------------------------------*/
314
315void
316cs_cdofb_scaleq_diff_flux_faces(const cs_real_t *f_values,
317 const cs_real_t *c_values,
318 const cs_equation_param_t *eqp,
319 const cs_property_t *diff_pty,
320 cs_real_t t_eval,
321 cs_equation_builder_t *eqb,
322 void *context,
323 cs_real_t *diff_flux);
324
325/*----------------------------------------------------------------------------*/
340/*----------------------------------------------------------------------------*/
341
342void
343cs_cdofb_scaleq_boundary_diff_flux(const cs_real_t *pot_f,
344 const cs_real_t *pot_c,
345 const cs_equation_param_t *eqp,
346 const cs_property_t *diff_pty,
347 const cs_real_t t_eval,
348 cs_equation_builder_t *eqb,
349 void *context,
350 cs_real_t *bflux);
351
352/*----------------------------------------------------------------------------*/
361/*----------------------------------------------------------------------------*/
362
363void
364cs_cdofb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
365 cs_equation_builder_t *eqb,
366 void *context);
367
368/*----------------------------------------------------------------------------*/
376/*----------------------------------------------------------------------------*/
377
378void
379cs_cdofb_scaleq_extra_post(const cs_equation_param_t *eqp,
380 cs_equation_builder_t *eqb,
381 void *context);
382
383/*----------------------------------------------------------------------------*/
396/*----------------------------------------------------------------------------*/
397
398cs_real_t *
399cs_cdofb_scaleq_get_cell_values(void *context,
400 bool previous);
401
402/*----------------------------------------------------------------------------*/
413/*----------------------------------------------------------------------------*/
414
415cs_real_t *
416cs_cdofb_scaleq_get_face_values(void *context,
417 bool previous);
418
419/*----------------------------------------------------------------------------*/
429/*----------------------------------------------------------------------------*/
430
431cs_real_t *
432cs_cdofb_scaleq_get_source_term_values(void *context);
433
434/*----------------------------------------------------------------------------*/
443/*----------------------------------------------------------------------------*/
444
445void
446cs_cdofb_scaleq_read_restart(cs_restart_t *restart,
447 const char *eqname,
448 void *scheme_context);
449
450/*----------------------------------------------------------------------------*/
459/*----------------------------------------------------------------------------*/
460
461void
462cs_cdofb_scaleq_write_restart(cs_restart_t *restart,
463 const char *eqname,
464 void *scheme_context);
465
466/*----------------------------------------------------------------------------*/
467
468END_C_DECLS
469
470#endif /* __CS_CDOFB_SCALEQ_H__ */
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:1752
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:3003
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:772
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:2383
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:1143
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:3125
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 the diffusive flux across each boundary face. Case of scalar-valued C...
Definition: cs_cdofb_scaleq.cpp:2839
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:3095
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:755
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:2687
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:3176
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:1102
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:3154
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:3034
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:3264
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:686
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:1283
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:1521
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:707
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:2039
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:808
cs_defs.h
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_matrix.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_cdofb_t
Definition: cs_cdofb_priv.h:51
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