8.0
general documentation
Loading...
Searching...
No Matches
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-2023 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
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
86
87/*----------------------------------------------------------------------------*/
97/*----------------------------------------------------------------------------*/
98
99void
101 const cs_cdo_connect_t *connect,
102 const cs_time_step_t *time_step);
103
104/*----------------------------------------------------------------------------*/
111/*----------------------------------------------------------------------------*/
112
113void
115 cs_cell_builder_t **cb);
116
117/*----------------------------------------------------------------------------*/
122/*----------------------------------------------------------------------------*/
123
124void
126
127/*----------------------------------------------------------------------------*/
139/*----------------------------------------------------------------------------*/
140
141void *
143 int var_id,
144 int bflux_id,
146
147/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void *
159
160/*----------------------------------------------------------------------------*/
173/*----------------------------------------------------------------------------*/
174
175void
177 const int field_id,
178 const cs_mesh_t *mesh,
179 const cs_equation_param_t *eqp,
181 void *context);
182
183/*----------------------------------------------------------------------------*/
197/*----------------------------------------------------------------------------*/
198
199void
201 const cs_real_t *cell_values,
202 const int field_id,
203 const cs_equation_param_t *eqp,
205 void *context);
206
207/*----------------------------------------------------------------------------*/
220/*----------------------------------------------------------------------------*/
221
222void
224 const cs_mesh_t *mesh,
225 const int field_id,
226 const cs_equation_param_t *eqp,
228 void *context);
229
230/*----------------------------------------------------------------------------*/
244/*----------------------------------------------------------------------------*/
245
246void
248 const cs_mesh_t *mesh,
249 const int field_id,
250 const cs_equation_param_t *eqp,
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,
276 void *context);
277
278/*----------------------------------------------------------------------------*/
290/*----------------------------------------------------------------------------*/
291
295 void *context);
296
297/*----------------------------------------------------------------------------*/
311/*----------------------------------------------------------------------------*/
312
313void
315 const cs_equation_param_t *eqp,
316 cs_real_t t_eval,
318 void *context,
319 cs_real_t *diff_flux);
320
321/*----------------------------------------------------------------------------*/
335/*----------------------------------------------------------------------------*/
336
337void
339 const cs_equation_param_t *eqp,
340 const cs_real_t *pot_f,
341 const cs_real_t *pot_c,
343 void *context,
344 cs_real_t *bflux);
345
346/*----------------------------------------------------------------------------*/
355/*----------------------------------------------------------------------------*/
356
357void
360 void *context);
361
362/*----------------------------------------------------------------------------*/
370/*----------------------------------------------------------------------------*/
371
372void
375 void *context);
376
377/*----------------------------------------------------------------------------*/
390/*----------------------------------------------------------------------------*/
391
392cs_real_t *
394 bool previous);
395
396/*----------------------------------------------------------------------------*/
407/*----------------------------------------------------------------------------*/
408
409cs_real_t *
411 bool previous);
412
413/*----------------------------------------------------------------------------*/
422/*----------------------------------------------------------------------------*/
423
424void
426 const char *eqname,
427 void *scheme_context);
428
429/*----------------------------------------------------------------------------*/
438/*----------------------------------------------------------------------------*/
439
440void
442 const char *eqname,
443 void *scheme_context);
444
445/*----------------------------------------------------------------------------*/
446
448
449#endif /* __CS_CDOFB_SCALEQ_H__ */
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.c:1750
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.c:2950
void cs_cdofb_scaleq_finalize_sharing(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition cs_cdofb_scaleq.c:774
void cs_cdofb_scaleq_boundary_diff_flux(const cs_real_t t_eval, const cs_equation_param_t *eqp, const cs_real_t *pot_f, const cs_real_t *pot_c, 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.c:2805
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.c:2379
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.c:1143
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.c:3073
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.c:3043
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.c:757
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.c:3101
void * cs_cdofb_scaleq_free_context(void *data)
Destroy a cs_cdofb_scaleq_t structure.
Definition cs_cdofb_scaleq.c:1102
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.c:2981
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.c:3188
void cs_cdofb_scaleq_diff_flux_faces(const cs_real_t *c_values, const cs_equation_param_t *eqp, 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.c:2680
bool cs_cdofb_scaleq_is_initialized(void)
Check if the generic structures for building a CDO-Fb scheme are allocated.
Definition cs_cdofb_scaleq.c:686
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.c:1283
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.c:1520
void * cs_cdofb_scaleq_init_context(const 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.c:810
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.c:707
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.c:2036
#define BEGIN_C_DECLS
Definition cs_defs.h:509
double cs_real_t
Floating-point value.
Definition cs_defs.h:319
#define END_C_DECLS
Definition cs_defs.h:510
struct _cs_restart_t cs_restart_t
Definition cs_restart.h:95
Definition mesh.f90:26
Definition cs_cdofb_priv.h:51
Definition cs_cdo_toolbox.h:68
Definition cs_cdo_connect.h:61
Definition cs_cdo_quantities.h:137
Set of local and temporary buffers.
Definition cs_cdo_local.h:60
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
Store common elements used when building an algebraic system related to an equation.
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition cs_equation_param.h:192
Definition cs_mesh.h:85
time step descriptor
Definition cs_time_step.h:64