7.0
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-2021 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_quantities.h"
45 #include "cs_cdofb_priv.h"
46 #include "cs_equation_common.h"
47 #include "cs_equation_param.h"
48 #include "cs_field.h"
49 #include "cs_matrix.h"
50 #include "cs_mesh.h"
51 #include "cs_restart.h"
52 #include "cs_source_term.h"
53 #include "cs_time_step.h"
54 
55 /*----------------------------------------------------------------------------*/
56 
57 BEGIN_C_DECLS
58 
59 /*============================================================================
60  * Macro definitions
61  *============================================================================*/
62 
63 /*============================================================================
64  * Type definitions
65  *============================================================================*/
66 
67 /* Algebraic system for CDO face-based discretization */
68 typedef struct _cs_cdofb_t cs_cdofb_scaleq_t;
69 
70 /*============================================================================
71  * Public function prototypes
72  *============================================================================*/
73 
74 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 bool
84 cs_cdofb_scaleq_is_initialized(void);
85 
86 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
100 cs_cdofb_scaleq_init_common(const cs_cdo_quantities_t *quant,
101  const cs_cdo_connect_t *connect,
102  const cs_time_step_t *time_step,
103  const cs_matrix_structure_t *ms);
104 
105 /*----------------------------------------------------------------------------*/
111 /*----------------------------------------------------------------------------*/
112 
113 const cs_matrix_structure_t *
114 cs_cdofb_scaleq_matrix_structure(void);
115 
116 /*----------------------------------------------------------------------------*/
123 /*----------------------------------------------------------------------------*/
124 
125 void
126 cs_cdofb_scaleq_get(cs_cell_sys_t **csys,
127  cs_cell_builder_t **cb);
128 
129 /*----------------------------------------------------------------------------*/
134 /*----------------------------------------------------------------------------*/
135 
136 void
137 cs_cdofb_scaleq_finalize_common(void);
138 
139 /*----------------------------------------------------------------------------*/
151 /*----------------------------------------------------------------------------*/
152 
153 void *
154 cs_cdofb_scaleq_init_context(const cs_equation_param_t *eqp,
155  int var_id,
156  int bflux_id,
157  cs_equation_builder_t *eqb);
158 
159 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 void *
170 cs_cdofb_scaleq_free_context(void *data);
171 
172 /*----------------------------------------------------------------------------*/
185 /*----------------------------------------------------------------------------*/
186 
187 void
188 cs_cdofb_scaleq_init_values(cs_real_t t_eval,
189  const int field_id,
190  const cs_mesh_t *mesh,
191  const cs_equation_param_t *eqp,
192  cs_equation_builder_t *eqb,
193  void *context);
194 
195 /*----------------------------------------------------------------------------*/
209 /*----------------------------------------------------------------------------*/
210 
211 void
212 cs_cdofb_scaleq_interpolate(const cs_mesh_t *mesh,
213  const cs_real_t *cell_values,
214  const int field_id,
215  const cs_equation_param_t *eqp,
216  cs_equation_builder_t *eqb,
217  void *context);
218 
219 /*----------------------------------------------------------------------------*/
232 /*----------------------------------------------------------------------------*/
233 
234 void
235 cs_cdofb_scaleq_solve_steady_state(bool cur2prev,
236  const cs_mesh_t *mesh,
237  const int field_id,
238  const cs_equation_param_t *eqp,
239  cs_equation_builder_t *eqb,
240  void *context);
241 
242 /*----------------------------------------------------------------------------*/
256 /*----------------------------------------------------------------------------*/
257 
258 void
259 cs_cdofb_scaleq_solve_implicit(bool cur2prev,
260  const cs_mesh_t *mesh,
261  const int field_id,
262  const cs_equation_param_t *eqp,
263  cs_equation_builder_t *eqb,
264  void *context);
265 
266 /*----------------------------------------------------------------------------*/
280 /*----------------------------------------------------------------------------*/
281 
282 void
283 cs_cdofb_scaleq_solve_theta(bool cur2prev,
284  const cs_mesh_t *mesh,
285  const int field_id,
286  const cs_equation_param_t *eqp,
287  cs_equation_builder_t *eqb,
288  void *context);
289 
290 /*----------------------------------------------------------------------------*/
302 /*----------------------------------------------------------------------------*/
303 
304 cs_equation_balance_t *
305 cs_cdofb_scaleq_balance(const cs_equation_param_t *eqp,
306  cs_equation_builder_t *eqb,
307  void *context);
308 
309 /*----------------------------------------------------------------------------*/
322 /*----------------------------------------------------------------------------*/
323 
324 void
325 cs_cdofb_scaleq_boundary_diff_flux(const cs_real_t t_eval,
326  const cs_equation_param_t *eqp,
327  const cs_real_t *pot_f,
328  const cs_real_t *pot_c,
329  cs_equation_builder_t *eqb,
330  void *context,
331  cs_real_t *bflux);
332 
333 /*----------------------------------------------------------------------------*/
342 /*----------------------------------------------------------------------------*/
343 
344 void
345 cs_cdofb_scaleq_current_to_previous(const cs_equation_param_t *eqp,
346  cs_equation_builder_t *eqb,
347  void *context);
348 
349 /*----------------------------------------------------------------------------*/
357 /*----------------------------------------------------------------------------*/
358 
359 void
360 cs_cdofb_scaleq_extra_post(const cs_equation_param_t *eqp,
361  cs_equation_builder_t *eqb,
362  void *context);
363 
364 /*----------------------------------------------------------------------------*/
377 /*----------------------------------------------------------------------------*/
378 
379 cs_real_t *
380 cs_cdofb_scaleq_get_cell_values(void *context,
381  bool previous);
382 
383 /*----------------------------------------------------------------------------*/
394 /*----------------------------------------------------------------------------*/
395 
396 cs_real_t *
397 cs_cdofb_scaleq_get_face_values(void *context,
398  bool previous);
399 
400 /*----------------------------------------------------------------------------*/
409 /*----------------------------------------------------------------------------*/
410 
411 void
412 cs_cdofb_scaleq_read_restart(cs_restart_t *restart,
413  const char *eqname,
414  void *scheme_context);
415 
416 /*----------------------------------------------------------------------------*/
425 /*----------------------------------------------------------------------------*/
426 
427 void
428 cs_cdofb_scaleq_write_restart(cs_restart_t *restart,
429  const char *eqname,
430  void *scheme_context);
431 
432 /*----------------------------------------------------------------------------*/
433 
434 END_C_DECLS
435 
436 #endif /* __CS_CDOFB_SCALEQ_H__ */
cs_cdofb_scaleq_boundary_diff_flux
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 the diffusive flux across each boundary face. Case of scalar-valued CDO-Fb schemes...
Definition: cs_cdofb_scaleq.c:2589
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.c:689
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_base.h
cs_restart.h
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.c:1978
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.c:2821
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:202
cs_cdofb_scaleq_init_common
void cs_cdofb_scaleq_init_common(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms)
Allocate work buffer and general structures related to CDO scalar-valued face-based schemes...
Definition: cs_cdofb_scaleq.c:711
cs_cdo_connect.h
cs_cdofb_priv.h
cs_defs.h
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. Case of scalar-valued CDO-Fb schemes.
Definition: cs_cdofb_scaleq.c:1111
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
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.c:1243
cs_cdofb_scaleq_balance
cs_equation_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:2308
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.c:2766
cs_cdo_connect_t
Definition: cs_cdo_connect.h:76
cs_cdofb_scaleq_finalize_common
void cs_cdofb_scaleq_finalize_common(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:797
cs_matrix.h
cs_source_term.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:307
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:124
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.c:2960
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:107
cs_mesh_t
Definition: cs_mesh.h:84
cs_equation_balance_t
Definition: cs_equation_common.h:220
cs_equation_common.h
cs_cdofb_scaleq_free_context
void * cs_cdofb_scaleq_free_context(void *data)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:1071
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:93
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.c:2736
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.c:2851
cs_cell_builder_t
Set of local and temporary buffers useful for building the algebraic system with a cellwise process...
Definition: cs_cdo_local.h:69
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.c:1472
cs_cdo_quantities.h
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.c:775
cs_cdofb_scaleq_init_context
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:833
cs_cdofb_scaleq_matrix_structure
const cs_matrix_structure_t * cs_cdofb_scaleq_matrix_structure(void)
Get the pointer to the related cs_matrix_structure_t.
Definition: cs_cdofb_scaleq.c:760
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdo_local.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.c:1697
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.c:2879
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496
_cs_cdofb_t
Definition: cs_cdofb_priv.h:52
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:90
mesh
Definition: mesh.f90:26