8.1
general documentation
cs_equation_builder.h
Go to the documentation of this file.
1 #ifndef __CS_EQUATION_BUILDER_H__
2 #define __CS_EQUATION_BUILDER_H__
3 
4 /*============================================================================
5  * Functions to handle the equation builder structure
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------
29  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_cdo_bc.h"
33 #include "cs_cdo_connect.h"
34 #include "cs_cdo_local.h"
35 #include "cs_cdo_quantities.h"
36 #include "cs_cdo_system.h"
37 #include "cs_enforcement.h"
38 #include "cs_equation_param.h"
39 #include "cs_flag.h"
40 #include "cs_matrix.h"
41 #include "cs_source_term.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
56 
57 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 typedef void
77  const cs_equation_builder_t *eqb,
78  const void *eqc,
79  const cs_cell_mesh_t *cm,
80  void *context,
81  cs_hodge_t *mass_hodge,
82  cs_hodge_t *diff_hodge,
83  cs_cell_sys_t *csys,
84  cs_cell_builder_t *cb);
85 
92 
93  bool init_step;
139 
151 
163 
179 
223 
243 };
244 
245 /*============================================================================
246  * Global variables
247  *============================================================================*/
248 
249 /*============================================================================
250  * Inline public function prototypes
251  *============================================================================*/
252 
253 /*----------------------------------------------------------------------------*/
262 /*----------------------------------------------------------------------------*/
263 
264 static inline cs_eflag_t
266  const cs_equation_builder_t *eqb)
267 {
268  if (cell_flag & CS_FLAG_BOUNDARY_CELL_BY_FACE)
269  return eqb->msh_flag | eqb->src_flag | eqb->bdy_flag;
270  else
271  return eqb->msh_flag | eqb->src_flag;
272 }
273 
274 /*============================================================================
275  * Public function prototypes
276  *============================================================================*/
277 
278 /*----------------------------------------------------------------------------*/
288 /*----------------------------------------------------------------------------*/
289 
290 void
292  cs_eflag_t bdy_flag,
293  cs_eflag_t src_flag);
294 
295 /*----------------------------------------------------------------------------*/
305 /*----------------------------------------------------------------------------*/
306 
309  const cs_mesh_t *mesh);
310 
311 /*----------------------------------------------------------------------------*/
321 /*----------------------------------------------------------------------------*/
322 
323 const cs_matrix_t *
325  int block_id);
326 
327 /*----------------------------------------------------------------------------*/
337 /*----------------------------------------------------------------------------*/
338 
339 const cs_range_set_t *
341  int block_id);
342 /*----------------------------------------------------------------------------*/
349 /*----------------------------------------------------------------------------*/
350 
351 void
353 
354 /*----------------------------------------------------------------------------*/
360 /*----------------------------------------------------------------------------*/
361 
362 void
364 
365 /*----------------------------------------------------------------------------*/
375 /*----------------------------------------------------------------------------*/
376 
377 void
379 
380 /*----------------------------------------------------------------------------*/
388 /*----------------------------------------------------------------------------*/
389 
390 void
392  const cs_equation_builder_t *eqb);
393 
394 /*----------------------------------------------------------------------------*/
410 /*----------------------------------------------------------------------------*/
411 
412 bool
414  const cs_equation_builder_t *eqb,
415  const cs_cell_mesh_t *cm,
416  cs_cell_builder_t *cb);
417 
418 /*----------------------------------------------------------------------------*/
430 /*----------------------------------------------------------------------------*/
431 
432 void
434  const cs_equation_builder_t *eqb,
435  cs_hodge_t *diff_hodge,
436  cs_cell_builder_t *cb);
437 
438 /*----------------------------------------------------------------------------*/
456 /*----------------------------------------------------------------------------*/
457 
458 void
460  cs_cell_builder_t *cb,
461  cs_cell_sys_t *csys);
462 
463 /*----------------------------------------------------------------------------*/
481 /*----------------------------------------------------------------------------*/
482 
483 void
485  cs_cell_builder_t *cb,
486  cs_cell_sys_t *csys);
487 
488 /*----------------------------------------------------------------------------*/
489 
491 
492 #endif /* __CS_EQUATION_BUILDER_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:515
unsigned short int cs_flag_t
Definition: cs_defs.h:321
static cs_eflag_t cs_equation_builder_cell_mesh_flag(cs_flag_t cell_flag, const cs_equation_builder_t *eqb)
Retrieve the flag to give for building a cs_cell_mesh_t structure.
Definition: cs_equation_builder.h:265
void() cs_equation_build_hook_t(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const void *eqc, const cs_cell_mesh_t *cm, void *context, cs_hodge_t *mass_hodge, cs_hodge_t *diff_hodge, cs_cell_sys_t *csys, cs_cell_builder_t *cb)
Generic function prototype for a hook during the cellwise building of the linear system Enable an adv...
Definition: cs_equation_builder.h:76
void cs_equation_builder_free(cs_equation_builder_t **p_builder)
Free a cs_equation_builder_t structure.
Definition: cs_equation_builder.c:333
void cs_equation_builder_enforce_dofs(const cs_equation_builder_t *eqb, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Take into account the enforcement of internal DoFs. Apply an algebraic manipulation....
Definition: cs_equation_builder.c:572
void cs_equation_builder_reset(cs_equation_builder_t *eqb)
Free some members of a cs_equation_builder_t structure.
Definition: cs_equation_builder.c:375
void cs_equation_builder_enforce_block_dofs(const cs_equation_builder_t *eqb, cs_cell_builder_t *cb, cs_cell_sys_t *csys)
Take into account the enforcement of internal DoFs. Case of matrices defined by blocks....
Definition: cs_equation_builder.c:644
cs_equation_builder_t * cs_equation_builder_create(const cs_equation_param_t *eqp, const cs_mesh_t *mesh)
Allocate a new structure to handle the building of algebraic system related to a cs_equation_t struct...
Definition: cs_equation_builder.c:133
void cs_equation_builder_update_default_flags(cs_eflag_t msh_flag, cs_eflag_t bdy_flag, cs_eflag_t src_flag)
Update the default flags used to know which quantities have to be built by each cs_cell_mesh_t struct...
Definition: cs_equation_builder.c:111
const cs_range_set_t * cs_equation_builder_get_range_set(const cs_equation_builder_t *builder, int block_id)
Retrieve the range set structure associated to a builder structure for the block defined in block_id ...
Definition: cs_equation_builder.c:304
void cs_equation_builder_apply_default_flags(cs_equation_builder_t *eqb)
Update the default flags used to know which quantities have to be built by each cs_cell_mesh_t struct...
Definition: cs_equation_builder.c:398
const cs_matrix_t * cs_equation_builder_get_matrix(const cs_equation_builder_t *builder, int block_id)
Retrieve the range set structure associated to a builder structure for the block defined in block_id ...
Definition: cs_equation_builder.c:272
void cs_equation_builder_init_properties(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, cs_hodge_t *diff_hodge, cs_cell_builder_t *cb)
Initialize all properties potentially useful to build the algebraic system. This function is shared a...
Definition: cs_equation_builder.c:508
bool cs_equation_builder_set_reaction_pty_cw(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb, const cs_cell_mesh_t *cm, cs_cell_builder_t *cb)
Initialize all reaction properties. This function is shared across all CDO schemes....
Definition: cs_equation_builder.c:469
void cs_equation_builder_log_performance(const cs_equation_param_t *eqp, const cs_equation_builder_t *eqb)
Print a message in the performance output file related to the monitoring of equation.
Definition: cs_equation_builder.c:419
#define CS_FLAG_BOUNDARY_CELL_BY_FACE
(= 1) boundary cell with at least one border face
Definition: cs_flag.h:62
unsigned char cs_mask_t
Definition: cs_flag.h:158
unsigned int cs_eflag_t
Definition: cs_flag.h:190
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:110
#define CS_CDO_N_MAX_REACTIONS
Definition: cs_param_cdo.h:67
#define CS_N_MAX_SOURCE_TERMS
Definition: cs_source_term.h:49
void() cs_source_term_cellwise_t(const cs_xdef_t *source, const cs_cell_mesh_t *cm, cs_real_t time_eval, cs_cell_builder_t *cb, void *input, double *values)
Compute the contribution for a cell related to a source term and add it to the given array of values.
Definition: cs_source_term.h:70
Definition: mesh.f90:26
Definition: cs_equation_builder.h:91
cs_timer_counter_t tcs
Definition: cs_equation_builder.h:235
bool curlcurl_pty_uniform
Definition: cs_equation_builder.h:117
cs_real_t * enforced_values
Definition: cs_equation_builder.h:162
cs_flag_t sys_flag
Definition: cs_equation_builder.h:108
cs_cdo_bc_face_t * face_bc
Definition: cs_equation_builder.h:193
cs_eflag_t bdy_flag
Definition: cs_equation_builder.h:102
bool init_step
Definition: cs_equation_builder.h:93
cs_mask_t * source_mask
Definition: cs_equation_builder.h:129
cs_real_t * dir_values
Definition: cs_equation_builder.h:196
cs_timer_counter_t tcb
Definition: cs_equation_builder.h:233
bool reac_pty_uniform[CS_CDO_N_MAX_REACTIONS]
Definition: cs_equation_builder.h:120
cs_timer_counter_t tce
Definition: cs_equation_builder.h:237
cs_eflag_t msh_flag
Definition: cs_equation_builder.h:100
cs_real_t * increment
Definition: cs_equation_builder.h:177
cs_cdo_system_helper_t * system_helper
Definition: cs_equation_builder.h:150
bool diff_pty_uniform
Definition: cs_equation_builder.h:116
bool graddiv_pty_uniform
Definition: cs_equation_builder.h:118
bool time_pty_uniform
Definition: cs_equation_builder.h:119
cs_equation_build_hook_t * hook_function
Definition: cs_equation_builder.h:222
cs_iter_algo_t * incremental_algo
Definition: cs_equation_builder.h:178
cs_source_term_cellwise_t * compute_source[CS_N_MAX_SOURCE_TERMS]
Definition: cs_equation_builder.h:138
cs_eflag_t src_flag
Definition: cs_equation_builder.h:105
void * hook_context
Definition: cs_equation_builder.h:221
Definition: cs_cdo_bc.h:109
Definition: cs_cdo_system.h:377
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
Set of local quantities and connectivities related to a mesh cell.
Definition: cs_cdo_local.h:203
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
Structure associated to a discrete Hodge operator *.
Definition: cs_hodge.h:183
Structure to handle the convergence of an iterative algorithm.
Definition: cs_iter_algo.h:289
Definition: cs_mesh.h:85
Definition: cs_range_set.h:57
Definition: cs_timer.h:55