8.0
general documentation
Loading...
Searching...
No Matches
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-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 * 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
48
49/*============================================================================
50 * Macro definitions
51 *============================================================================*/
52
53/*============================================================================
54 * Public function prototypes
55 *============================================================================*/
56
57/*----------------------------------------------------------------------------*/
64/*----------------------------------------------------------------------------*/
65
66bool
68
69/*----------------------------------------------------------------------------*/
79/*----------------------------------------------------------------------------*/
80
81void
83 const cs_cdo_connect_t *connect,
84 const cs_time_step_t *time_step);
85
86/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
95void
98
99/*----------------------------------------------------------------------------*/
104/*----------------------------------------------------------------------------*/
105
106void
108
109/*----------------------------------------------------------------------------*/
121/*----------------------------------------------------------------------------*/
122
123void *
125 int var_id,
126 int bflux_id,
128
129/*----------------------------------------------------------------------------*/
137/*----------------------------------------------------------------------------*/
138
139void *
141
142/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
157void
159 const int field_id,
160 const cs_mesh_t *mesh,
161 const cs_equation_param_t *eqp,
163 void *context);
164
165/*----------------------------------------------------------------------------*/
179/*----------------------------------------------------------------------------*/
180
181void
183 const cs_real_t *cell_values,
184 const int field_id,
185 const cs_equation_param_t *eqp,
187 void *context);
188
189/*----------------------------------------------------------------------------*/
202/*----------------------------------------------------------------------------*/
203
204void
206 const cs_mesh_t *mesh,
207 const int field_id,
208 const cs_equation_param_t *eqp,
210 void *context);
211
212/*----------------------------------------------------------------------------*/
226/*----------------------------------------------------------------------------*/
227
228void
230 const cs_mesh_t *mesh,
231 const int field_id,
232 const cs_equation_param_t *eqp,
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,
258 void *context);
259
260/*----------------------------------------------------------------------------*/
272/*----------------------------------------------------------------------------*/
273
274cs_real_t *
276 bool previous);
277
278/*----------------------------------------------------------------------------*/
292/*----------------------------------------------------------------------------*/
293
294cs_real_t *
296 bool previous);
297
298/*----------------------------------------------------------------------------*/
314/*----------------------------------------------------------------------------*/
315
316void
318 const cs_equation_param_t *eqp,
319 const cs_real_t *pot_v,
320 const cs_real_t *pot_c,
322 void *context,
323 cs_real_t *vf_flux);
324
325/*----------------------------------------------------------------------------*/
339/*----------------------------------------------------------------------------*/
340
341void
343 const cs_real_t *pdi,
344 const cs_equation_param_t *eqp,
345 int ml_id,
347 void *context,
348 double *d_flux,
349 double *c_flux);
350
351/*----------------------------------------------------------------------------*/
363/*----------------------------------------------------------------------------*/
364
365void
367 const cs_equation_param_t *eqp,
368 cs_real_t t_eval,
370 void *context,
371 cs_real_t *diff_flux);
372
373/*----------------------------------------------------------------------------*/
385/*----------------------------------------------------------------------------*/
386
387void
389 const cs_equation_param_t *eqp,
390 cs_real_t t_eval,
392 void *context,
393 cs_real_t *diff_flux);
394
395/*----------------------------------------------------------------------------*/
404/*----------------------------------------------------------------------------*/
405
406void
409 void *context,
410 cs_real_t *v_gradient);
411
412/*----------------------------------------------------------------------------*/
421/*----------------------------------------------------------------------------*/
422
423void
425 const char *eqname,
426 void *scheme_context);
427
428/*----------------------------------------------------------------------------*/
437/*----------------------------------------------------------------------------*/
438
439void
441 const char *eqname,
442 void *scheme_context);
443
444/*----------------------------------------------------------------------------*/
453/*----------------------------------------------------------------------------*/
454
455void
458 void *context);
459
460/*----------------------------------------------------------------------------*/
468/*----------------------------------------------------------------------------*/
469
470void
473 void *context);
474
475/*----------------------------------------------------------------------------*/
476
478
479#endif /* __CS_CDOVCB_SCALEQ_H__ */
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.c:3592
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.c:1974
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.c:3518
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.c:896
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.c:875
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.c:1736
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.c:3345
void cs_cdovcb_scaleq_finalize_sharing(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition cs_cdovcb_scaleq.c:963
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.c:1375
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.c:2708
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.c:2675
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.c:2958
void * cs_cdovcb_scaleq_init_context(const 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.c:999
void * cs_cdovcb_scaleq_free_context(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition cs_cdovcb_scaleq.c:1335
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.c:2283
void cs_cdovcb_scaleq_diff_flux_in_cells(const cs_real_t *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 in each cells. Case of scalar-valued CDO-VCb schemes.
Definition cs_cdovcb_scaleq.c:3150
void cs_cdovcb_scaleq_diff_flux_dfaces(const cs_real_t *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 across dual faces Case of scalar-valued CDO-VCb schemes.
Definition cs_cdovcb_scaleq.c:3246
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.c:3560
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.c:1502
void cs_cdovcb_scaleq_boundary_diff_flux(const cs_real_t t_eval, const cs_equation_param_t *eqp, const cs_real_t *pot_v, const cs_real_t *pot_c, 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.c:2741
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.c:946
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.c:3465
#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_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