9.1
general documentation
cs_cdofb_vecteq.h
Go to the documentation of this file.
1#ifndef __CS_CDOFB_VECTEQ_H__
2#define __CS_CDOFB_VECTEQ_H__
3
4/*============================================================================
5 * Build an algebraic CDO face-based system for unsteady convection/diffusion
6 * reaction of vector-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-2025 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 "base/cs_defs.h"
32
33/*----------------------------------------------------------------------------
34 * Standard C library headers
35 *----------------------------------------------------------------------------*/
36
37/*----------------------------------------------------------------------------
38 * Local headers
39 *----------------------------------------------------------------------------*/
40
41#include "base/cs_base.h"
42#include "cdo/cs_cdo_assembly.h"
43#include "cdo/cs_cdo_connect.h"
44#include "cdo/cs_cdo_quantities.h"
45#include "cdo/cs_cdofb_priv.h"
46#include "cdo/cs_equation_builder.h"
47#include "cdo/cs_equation_param.h"
48#include "base/cs_field.h"
49#include "alge/cs_matrix.h"
50#include "mesh/cs_mesh.h"
51#include "base/cs_restart.h"
52#include "alge/cs_sles.h"
53#include "cdo/cs_source_term.h"
54#include "base/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 */
69
70typedef struct _cs_cdofb_t cs_cdofb_vecteq_t;
71
72/*============================================================================
73 * Static inline public function prototypes
74 *============================================================================*/
75
76/*----------------------------------------------------------------------------*/
91/*----------------------------------------------------------------------------*/
92
93static inline void
94cs_cdofb_vecteq_sourceterm(const cs_cell_mesh_t *cm,
95 const cs_equation_param_t *eqp,
96 const cs_real_t t_eval,
97 const cs_real_t coef,
98 cs_hodge_t *mass_hodge,
99 cs_cell_builder_t *cb,
100 cs_equation_builder_t *eqb,
101 cs_cell_sys_t *csys)
102{
103 /* Reset the local contribution */
104
105 memset(csys->source, 0, csys->n_dofs*sizeof(cs_real_t));
106
107 cs_source_term_compute_cellwise(eqp->n_source_terms,
108 (cs_xdef_t *const *)eqp->source_terms,
109 cm,
110 eqb->source_mask,
111 eqb->compute_source,
112 t_eval,
113 mass_hodge, /* Mass matrix context */
114 cb,
115 csys->source);
116
117 /* Only cell-DoFs are involved */
118
119 const short int _off = 3*cm->n_fc;
120 csys->rhs[_off ] += coef * csys->source[_off ];
121 csys->rhs[_off + 1] += coef * csys->source[_off + 1];
122 csys->rhs[_off + 2] += coef * csys->source[_off + 2];
123}
124
125/*============================================================================
126 * Public function prototypes
127 *============================================================================*/
128
129/*----------------------------------------------------------------------------*/
136/*----------------------------------------------------------------------------*/
137
138bool
139cs_cdofb_vecteq_is_initialized(void);
140
141/*----------------------------------------------------------------------------*/
151/*----------------------------------------------------------------------------*/
152
153void
154cs_cdofb_vecteq_init_sharing(const cs_cdo_quantities_t *quant,
155 const cs_cdo_connect_t *connect,
156 const cs_time_step_t *time_step);
157
158/*----------------------------------------------------------------------------*/
165/*----------------------------------------------------------------------------*/
166
167void
168cs_cdofb_vecteq_get(cs_cell_sys_t **csys,
169 cs_cell_builder_t **cb);
170
171/*----------------------------------------------------------------------------*/
176/*----------------------------------------------------------------------------*/
177
178void
179cs_cdofb_vecteq_finalize_sharing(void);
180
181/*----------------------------------------------------------------------------*/
193/*----------------------------------------------------------------------------*/
194
195void *
196cs_cdofb_vecteq_init_context(cs_equation_param_t *eqp,
197 int var_id,
198 int bflux_id,
199 cs_equation_builder_t *eqb);
200
201/*----------------------------------------------------------------------------*/
209/*----------------------------------------------------------------------------*/
210
211void *
212cs_cdofb_vecteq_free_context(void *data);
213
214/*----------------------------------------------------------------------------*/
227/*----------------------------------------------------------------------------*/
228
229void
230cs_cdofb_vecteq_init_values(cs_real_t t_eval,
231 const int field_id,
232 const cs_mesh_t *mesh,
233 const cs_equation_param_t *eqp,
234 cs_equation_builder_t *eqb,
235 void *context);
236
237/*----------------------------------------------------------------------------*/
255/*----------------------------------------------------------------------------*/
256
257void
258cs_cdofb_vecteq_init_cell_system(const cs_cell_mesh_t *cm,
259 const cs_equation_param_t *eqp,
260 const cs_equation_builder_t *eqb,
261 const cs_real_t val_f_n[],
262 const cs_real_t val_c_n[],
263 const cs_real_t val_f_nm1[],
264 const cs_real_t val_c_nm1[],
265 cs_cell_sys_t *csys,
266 cs_cell_builder_t *cb);
267
268/*----------------------------------------------------------------------------*/
283/*----------------------------------------------------------------------------*/
284
285void
286cs_cdofb_vecteq_init_turb_bc(const cs_cell_mesh_t *cm,
287 const cs_equation_param_t *eqp,
288 const cs_equation_builder_t *eqb,
289 const cs_real_t nu,
290 const cs_real_t k,
291 const cs_real_t *uc,
292 cs_cell_sys_t *csys,
293 cs_cell_builder_t *cb,
294 cs_lnum_t *icodcl_vel,
295 cs_real_t *rcodcl1_vel);
296
297/*----------------------------------------------------------------------------*/
308/*----------------------------------------------------------------------------*/
309
310void
311cs_cdofb_vecteq_setup(cs_real_t t_eval,
312 const cs_mesh_t *mesh,
313 const cs_equation_param_t *eqp,
314 cs_equation_builder_t *eqb);
315
316/*----------------------------------------------------------------------------*/
329/*----------------------------------------------------------------------------*/
330
331void
332cs_cdofb_vecteq_diffusion(const cs_equation_param_t *eqp,
333 const cs_equation_builder_t *eqb,
334 const cs_cdofb_vecteq_t *eqc,
335 const cs_cell_mesh_t *cm,
336 cs_hodge_t *diff_hodge,
337 cs_cell_sys_t *csys,
338 cs_cell_builder_t *cb);
339
340/*----------------------------------------------------------------------------*/
356/*----------------------------------------------------------------------------*/
357
358void
359cs_cdofb_vecteq_conv_diff_reac(const cs_equation_param_t *eqp,
360 const cs_equation_builder_t *eqb,
361 const cs_cdofb_vecteq_t *eqc,
362 const cs_cell_mesh_t *cm,
363 cs_hodge_t *mass_hodge,
364 cs_hodge_t *diff_hodge,
365 cs_cell_sys_t *csys,
366 cs_cell_builder_t *cb);
367
368/*----------------------------------------------------------------------------*/
379/*----------------------------------------------------------------------------*/
380
381void
382cs_cdofb_vecteq_assembly(const cs_cell_sys_t *csys,
383 cs_cdo_system_block_t *block,
384 cs_real_t *rhs,
385 cs_cdofb_vecteq_t *eqc,
386 cs_cdo_assembly_t *asb);
387
388/*----------------------------------------------------------------------------*/
398/*----------------------------------------------------------------------------*/
399
400void
401cs_cdofb_vecteq_update_cell_fields(cs_timer_counter_t *tce,
402 cs_field_t *fld,
403 cs_cdofb_vecteq_t *eqc,
404 bool cur2prev);
405
406/*----------------------------------------------------------------------------*/
419/*----------------------------------------------------------------------------*/
420
421void
422cs_cdofb_vecteq_solve_steady_state(bool cur2prev,
423 const cs_mesh_t *mesh,
424 const int field_id,
425 const cs_equation_param_t *eqp,
426 cs_equation_builder_t *eqb,
427 void *context);
428
429/*----------------------------------------------------------------------------*/
442/*----------------------------------------------------------------------------*/
443
444void
445cs_cdofb_vecteq_solve_implicit(bool cur2prev,
446 const cs_mesh_t *mesh,
447 const int field_id,
448 const cs_equation_param_t *eqp,
449 cs_equation_builder_t *eqb,
450 void *context);
451
452/*----------------------------------------------------------------------------*/
465/*----------------------------------------------------------------------------*/
466
467void
468cs_cdofb_vecteq_solve_theta(bool cur2prev,
469 const cs_mesh_t *mesh,
470 const int field_id,
471 const cs_equation_param_t *eqp,
472 cs_equation_builder_t *eqb,
473 void *context);
474
475/*----------------------------------------------------------------------------*/
487/*----------------------------------------------------------------------------*/
488
489cs_cdo_balance_t *
490cs_cdofb_vecteq_balance(const cs_equation_param_t *eqp,
491 cs_equation_builder_t *eqb,
492 void *context);
493
494/*----------------------------------------------------------------------------*/
503/*----------------------------------------------------------------------------*/
504
505void
506cs_cdofb_vecteq_current_to_previous(const cs_equation_param_t *eqp,
507 cs_equation_builder_t *eqb,
508 void *context);
509
510/*----------------------------------------------------------------------------*/
518/*----------------------------------------------------------------------------*/
519
520void
521cs_cdofb_vecteq_extra_post(const cs_equation_param_t *eqp,
522 cs_equation_builder_t *eqb,
523 void *context);
524
525/*----------------------------------------------------------------------------*/
538/*----------------------------------------------------------------------------*/
539
540cs_real_t *
541cs_cdofb_vecteq_get_cell_values(void *context,
542 bool previous);
543
544/*----------------------------------------------------------------------------*/
555/*----------------------------------------------------------------------------*/
556
557cs_real_t *
558cs_cdofb_vecteq_get_face_values(void *context,
559 bool previous);
560
561/*----------------------------------------------------------------------------*/
570/*----------------------------------------------------------------------------*/
571
572void
573cs_cdofb_vecteq_read_restart(cs_restart_t *restart,
574 const char *eqname,
575 void *scheme_context);
576
577/*----------------------------------------------------------------------------*/
586/*----------------------------------------------------------------------------*/
587
588void
589cs_cdofb_vecteq_write_restart(cs_restart_t *restart,
590 const char *eqname,
591 void *scheme_context);
592
593/*----------------------------------------------------------------------------*/
594
595END_C_DECLS
596
597#endif /* __CS_CDOFB_VECTEQ_H__ */
cs_base.h
cs_cdo_assembly.h
cs_cdo_connect.h
cs_cdo_quantities.h
cs_cdofb_priv.h
cs_cdofb_vecteq_init_sharing
void cs_cdofb_vecteq_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 vector-valued face-based schemes....
Definition: cs_cdofb_vecteq.cpp:1924
cs_cdofb_vecteq_get_cell_values
cs_real_t * cs_cdofb_vecteq_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_vecteq.cpp:2602
cs_cdofb_vecteq_assembly
void cs_cdofb_vecteq_assembly(const cs_cell_sys_t *csys, cs_cdo_system_block_t *block, cs_real_t *rhs, cs_cdofb_vecteq_t *eqc, cs_cdo_assembly_t *asb)
Perform the assembly stage for a vector-valued system obtained with CDO-Fb scheme.
Definition: cs_cdofb_vecteq.cpp:737
cs_cdofb_vecteq_balance
cs_cdo_balance_t * cs_cdofb_vecteq_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_vecteq.cpp:1560
cs_cdofb_vecteq_free_context
void * cs_cdofb_vecteq_free_context(void *data)
Destroy a cs_cdofb_vecteq_t structure.
Definition: cs_cdofb_vecteq.cpp:2340
cs_cdofb_vecteq_update_cell_fields
void cs_cdofb_vecteq_update_cell_fields(cs_timer_counter_t *tce, cs_field_t *fld, cs_cdofb_vecteq_t *eqc, bool cur2prev)
Update the variables associated to cells in case of a CDO-Fb scheme. This has to be done after a reso...
Definition: cs_cdofb_vecteq.cpp:785
cs_cdofb_vecteq_sourceterm
static void cs_cdofb_vecteq_sourceterm(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_real_t t_eval, const cs_real_t coef, cs_hodge_t *mass_hodge, cs_cell_builder_t *cb, cs_equation_builder_t *eqb, cs_cell_sys_t *csys)
Compute the source term for a vector-valued CDO-Fb scheme and add it to the local rhs Mass matrix is ...
Definition: cs_cdofb_vecteq.h:94
cs_cdofb_vecteq_init_cell_system
void cs_cdofb_vecteq_init_cell_system(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_real_t val_f_n[], const cs_real_t val_c_n[], const cs_real_t val_f_nm1[], const cs_real_t val_c_nm1[], cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Initialize the local structure for the current cell The algebraic system for time t^{n+1} is going to...
Definition: cs_cdofb_vecteq.cpp:338
cs_cdofb_vecteq_conv_diff_reac
void cs_cdofb_vecteq_conv_diff_reac(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cdofb_vecteq_t *eqc, const cs_cell_mesh_t *cm, cs_hodge_t *mass_hodge, cs_hodge_t *diff_hodge, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Build the local matrices arising from the convection, diffusion, reaction terms in vector-valued CDO-...
Definition: cs_cdofb_vecteq.cpp:580
cs_cdofb_vecteq_finalize_sharing
void cs_cdofb_vecteq_finalize_sharing(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_vecteq.cpp:2002
cs_cdofb_vecteq_read_restart
void cs_cdofb_vecteq_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_vecteq.cpp:2660
cs_cdofb_vecteq_get_face_values
cs_real_t * cs_cdofb_vecteq_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_vecteq.cpp:2632
cs_cdofb_vecteq_is_initialized
bool cs_cdofb_vecteq_is_initialized(void)
Check if the generic structures for building a CDO-Fb scheme are allocated.
Definition: cs_cdofb_vecteq.cpp:1903
cs_cdofb_vecteq_solve_steady_state
void cs_cdofb_vecteq_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 vector steady-state diffusion equation with a CDO-Fb...
Definition: cs_cdofb_vecteq.cpp:826
cs_cdofb_vecteq_init_context
void * cs_cdofb_vecteq_init_context(cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_cdofb_vecteq_t structure storing data useful for building and managing such a scheme.
Definition: cs_cdofb_vecteq.cpp:2038
cs_cdofb_vecteq_write_restart
void cs_cdofb_vecteq_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_vecteq.cpp:2749
cs_cdofb_vecteq_solve_implicit
void cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and a...
Definition: cs_cdofb_vecteq.cpp:1032
cs_cdofb_vecteq_extra_post
void cs_cdofb_vecteq_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_vecteq.cpp:2541
cs_cdofb_vecteq_init_values
void cs_cdofb_vecteq_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_vecteq.cpp:2379
cs_cdofb_vecteq_diffusion
void cs_cdofb_vecteq_diffusion(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cdofb_vecteq_t *eqc, const cs_cell_mesh_t *cm, cs_hodge_t *diff_hodge, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Build the local matrices arising from the diffusion term in the vector-valued CDO-Fb schemes.
Definition: cs_cdofb_vecteq.cpp:513
cs_cdofb_vecteq_setup
void cs_cdofb_vecteq_setup(cs_real_t t_eval, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Set the boundary conditions known from the settings Define an indirection array for the enforcement o...
Definition: cs_cdofb_vecteq.cpp:290
cs_cdofb_vecteq_current_to_previous
void cs_cdofb_vecteq_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_vecteq.cpp:2510
cs_cdofb_vecteq_get
void cs_cdofb_vecteq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_cdofb_vecteq.cpp:1985
cs_cdofb_vecteq_init_turb_bc
void cs_cdofb_vecteq_init_turb_bc(const cs_cell_mesh_t *cm, const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_real_t nu, const cs_real_t k, const cs_real_t *uc, cs_cell_sys_t *csys, cs_cell_builder_t *cb, cs_lnum_t *icodcl_vel, cs_real_t *rcodcl1_vel)
Initialize the modelled wall BC related coefficients.
Definition: cs_cdofb_vecteq.cpp:441
cs_cdofb_vecteq_solve_theta
void cs_cdofb_vecteq_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 vector diffusion equation with a CDO-Fb scheme and a...
Definition: cs_cdofb_vecteq.cpp:1274
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:357
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:350
cs_equation_builder.h
cs_equation_param.h
cs_field.h
k
@ k
Definition: cs_field_pointer.h:72
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_sles.h
cs_source_term_compute_cellwise
void cs_source_term_compute_cellwise(const int n_source_terms, cs_xdef_t *const *source_terms, const cs_cell_mesh_t *cm, const cs_mask_t *source_mask, cs_source_term_cellwise_t *compute_source[], cs_real_t time_eval, void *input, cs_cell_builder_t *cb, cs_real_t *result)
Compute the local contributions of source terms in a cell.
Definition: cs_source_term.cpp:1002
cs_source_term.h
cs_time_step.h
mesh
Definition: mesh.f90:26
_cs_cdofb_t
Definition: cs_cdofb_priv.h:51
_cs_cdofb_t::mass_hodge
cs_hodge_t ** mass_hodge
Definition: cs_cdofb_priv.h:104
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:145
cs_cdo_system_block_t
Definition: cs_cdo_system.h:335
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
cs_cell_mesh_t
Set of local quantities and connectivities related to a mesh cell.
Definition: cs_cdo_local.h:203
cs_cell_mesh_t::n_fc
short int n_fc
Definition: cs_cdo_local.h:238
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_cell_sys_t::source
double * source
Definition: cs_cdo_local.h:157
cs_cell_sys_t::rhs
double * rhs
Definition: cs_cdo_local.h:156
cs_cell_sys_t::n_dofs
int n_dofs
Definition: cs_cdo_local.h:151
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:194
cs_equation_param_t::source_terms
cs_xdef_t ** source_terms
Definition: cs_equation_param.h:748
cs_equation_param_t::n_source_terms
int n_source_terms
Definition: cs_equation_param.h:747
cs_field_t
Field descriptor.
Definition: cs_field.h:156
cs_hodge_t
Structure associated to a discrete Hodge operator *.
Definition: cs_hodge.h:183
cs_mesh_t
Definition: cs_mesh.h:85
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_timer_counter_t
Definition: cs_timer.h:55
cs_xdef_t
Structure storing medata for defining a quantity in a very flexible way.
Definition: cs_xdef.h:160