programmer's 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-2018 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_equation_common.h"
46 #include "cs_equation_param.h"
47 #include "cs_field.h"
48 #include "cs_matrix.h"
49 #include "cs_mesh.h"
50 #include "cs_restart.h"
51 #include "cs_source_term.h"
52 #include "cs_time_step.h"
53 
54 /*----------------------------------------------------------------------------*/
55 
56 BEGIN_C_DECLS
57 
58 /*============================================================================
59  * Macro definitions
60  *============================================================================*/
61 
62 /*============================================================================
63  * Type definitions
64  *============================================================================*/
65 
66 /* Algebraic system for CDO face-based discretization */
67 typedef struct _cs_cdofb_t cs_cdofb_scaleq_t;
68 
69 /*============================================================================
70  * Public function prototypes
71  *============================================================================*/
72 
73 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 bool
83 cs_cdofb_scaleq_is_initialized(void);
84 
85 /*----------------------------------------------------------------------------*/
96 /*----------------------------------------------------------------------------*/
97 
98 void
99 cs_cdofb_scaleq_init_common(const cs_cdo_quantities_t *quant,
100  const cs_cdo_connect_t *connect,
101  const cs_time_step_t *time_step,
102  const cs_matrix_structure_t *ms);
103 
104 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 const cs_matrix_structure_t *
113 cs_cdofb_scaleq_matrix_structure(void);
114 
115 /*----------------------------------------------------------------------------*/
122 /*----------------------------------------------------------------------------*/
123 
124 void
125 cs_cdofb_scaleq_get(cs_cell_sys_t **csys,
126  cs_cell_builder_t **cb);
127 
128 /*----------------------------------------------------------------------------*/
133 /*----------------------------------------------------------------------------*/
134 
135 void
136 cs_cdofb_scaleq_finalize_common(void);
137 
138 /*----------------------------------------------------------------------------*/
150 /*----------------------------------------------------------------------------*/
151 
152 void *
153 cs_cdofb_scaleq_init_context(const cs_equation_param_t *eqp,
154  int var_id,
155  int bflux_id,
156  cs_equation_builder_t *eqb);
157 
158 /*----------------------------------------------------------------------------*/
166 /*----------------------------------------------------------------------------*/
167 
168 void *
169 cs_cdofb_scaleq_free_context(void *data);
170 
171 /*----------------------------------------------------------------------------*/
183 /*----------------------------------------------------------------------------*/
184 
185 void
186 cs_cdofb_scaleq_initialize_system(const cs_equation_param_t *eqp,
187  cs_equation_builder_t *eqb,
188  void *data,
189  cs_matrix_t **system_matrix,
190  cs_real_t **system_rhs);
191 
192 /*----------------------------------------------------------------------------*/
203 /*----------------------------------------------------------------------------*/
204 
205 void
206 cs_cdofb_scaleq_set_dir_bc(const cs_mesh_t *mesh,
207  const cs_equation_param_t *eqp,
208  cs_equation_builder_t *eqb,
209  cs_real_t t_eval,
210  cs_real_t field_val[]);
211 
212 /*----------------------------------------------------------------------------*/
225 /*----------------------------------------------------------------------------*/
226 
227 void
228 cs_cdofb_scaleq_solve_steady_state(double dt_cur,
229  const cs_mesh_t *mesh,
230  const int field_id,
231  const cs_equation_param_t *eqp,
232  cs_equation_builder_t *eqb,
233  void *context);
234 
235 /*----------------------------------------------------------------------------*/
249 /*----------------------------------------------------------------------------*/
250 
251 void
252 cs_cdofb_scaleq_solve_implicit(double dt_cur,
253  const cs_mesh_t *mesh,
254  const int field_id,
255  const cs_equation_param_t *eqp,
256  cs_equation_builder_t *eqb,
257  void *context);
258 
259 /*----------------------------------------------------------------------------*/
273 /*----------------------------------------------------------------------------*/
274 
275 void
276 cs_cdofb_scaleq_solve_theta(double dt_cur,
277  const cs_mesh_t *mesh,
278  const int field_id,
279  const cs_equation_param_t *eqp,
280  cs_equation_builder_t *eqb,
281  void *context);
282 
283 /*----------------------------------------------------------------------------*/
298 /*----------------------------------------------------------------------------*/
299 
300 void
301 cs_cdofb_scaleq_build_system(const cs_mesh_t *mesh,
302  const cs_real_t *field_val,
303  double dt_cur,
304  const cs_equation_param_t *eqp,
305  cs_equation_builder_t *eqb,
306  void *data,
307  cs_real_t *rhs,
308  cs_matrix_t *matrix);
309 
310 /*----------------------------------------------------------------------------*/
322 /*----------------------------------------------------------------------------*/
323 
324 void
325 cs_cdofb_scaleq_update_field(const cs_real_t *solu,
326  const cs_real_t *rhs,
327  const cs_equation_param_t *eqp,
328  cs_equation_builder_t *eqb,
329  void *data,
330  cs_real_t *field_val);
331 
332 /*----------------------------------------------------------------------------*/
345 /*----------------------------------------------------------------------------*/
346 
347 cs_equation_balance_t *
348 cs_cdofb_scaleq_balance(const cs_equation_param_t *eqp,
349  cs_equation_builder_t *eqb,
350  void *context,
351  cs_real_t dt_cur);
352 
353 /*----------------------------------------------------------------------------*/
363 /*----------------------------------------------------------------------------*/
364 
365 void
366 cs_cdofb_scaleq_extra_op(const char *eqname,
367  const cs_field_t *field,
368  const cs_equation_param_t *eqp,
369  cs_equation_builder_t *eqb,
370  void *data);
371 
372 /*----------------------------------------------------------------------------*/
384 /*----------------------------------------------------------------------------*/
385 
386 cs_real_t *
387 cs_cdofb_scaleq_get_cell_values(void *context);
388 
389 /*----------------------------------------------------------------------------*/
399 /*----------------------------------------------------------------------------*/
400 
401 cs_real_t *
402 cs_cdofb_scaleq_get_face_values(void *context);
403 
404 /*----------------------------------------------------------------------------*/
413 /*----------------------------------------------------------------------------*/
414 
415 void
416 cs_cdofb_scaleq_read_restart(cs_restart_t *restart,
417  const char *eqname,
418  void *scheme_context);
419 
420 /*----------------------------------------------------------------------------*/
429 /*----------------------------------------------------------------------------*/
430 
431 void
432 cs_cdofb_scaleq_write_restart(cs_restart_t *restart,
433  const char *eqname,
434  void *scheme_context);
435 
436 /*----------------------------------------------------------------------------*/
437 
438 END_C_DECLS
439 
440 #endif /* __CS_CDOFB_SCALEQ_H__ */
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:639
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:63
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_base.h
cs_restart.h
cs_field_t
Field descriptor.
Definition: cs_field.h:124
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:159
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:661
cs_cdo_connect.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
cs_cdofb_scaleq_solve_theta
void cs_cdofb_scaleq_solve_theta(double dt_cur, 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:1593
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
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:747
field
Definition: field.f90:27
cs_matrix.h
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, cs_real_t dt_cur)
Compute the balance for an equation over the full computational domain between time t_cur and t_cur +...
Definition: cs_cdofb_scaleq.c:2240
cs_source_term.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
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:2647
cs_cdofb_scaleq_update_field
void cs_cdofb_scaleq_update_field(const cs_real_t *solu, const cs_real_t *rhs, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *field_val)
Store solution(s) of the linear system into a field structure Update extra-field values if required (...
Definition: cs_cdofb_scaleq.c:2194
matrix
void matrix(const int *iconvp, const int *idiffp, const int *ndircp, const int *isym, const cs_real_t *thetap, const int *imucpp, const cs_real_t coefbp[], const cs_real_t cofbfp[], const cs_real_t rovsdt[], const cs_real_t i_massflux[], const cs_real_t b_massflux[], const cs_real_t i_visc[], const cs_real_t b_visc[], const cs_real_t xcpp[], cs_real_t da[], cs_real_t xa[])
Definition: cs_matrix_building.c:111
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:112
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
cs_cdofb_scaleq_set_dir_bc
void cs_cdofb_scaleq_set_dir_bc(const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, cs_real_t t_eval, cs_real_t field_val[])
Set the boundary conditions known from the settings when the fields stem from a scalar CDO face-based...
Definition: cs_cdofb_scaleq.c:1093
cs_mesh_t
Definition: cs_mesh.h:63
cs_cdofb_scaleq_build_system
void cs_cdofb_scaleq_build_system(const cs_mesh_t *mesh, const cs_real_t *field_val, double dt_cur, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_real_t *rhs, cs_matrix_t *matrix)
Build the linear system arising from a scalar convection/diffusion equation with a CDO face-based sch...
Definition: cs_cdofb_scaleq.c:1888
cs_equation_balance_t
Definition: cs_equation_common.h:155
cs_equation_common.h
cs_cdofb_scaleq_get_face_values
cs_real_t * cs_cdofb_scaleq_get_face_values(void *context)
Retrieve an array of values at mesh faces for the current context. The lifecycle of this array is man...
Definition: cs_cdofb_scaleq.c:2544
cs_cdofb_scaleq_solve_steady_state
void cs_cdofb_scaleq_solve_steady_state(double dt_cur, 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:1134
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:1019
cs_cdofb_scaleq_extra_op
void cs_cdofb_scaleq_extra_op(const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Predefined extra-operations related to this equation.
Definition: cs_cdofb_scaleq.c:2468
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:86
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:75
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:725
cs_cdofb_scaleq_get_cell_values
cs_real_t * cs_cdofb_scaleq_get_cell_values(void *context)
Get the computed values at mesh cells from the inverse operation w.r.t. the static condensation (DoF ...
Definition: cs_cdofb_scaleq.c:2523
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:783
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:710
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdo_local.h
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:2566
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:463
_cs_cdofb_t
Definition: cs_cdofb_priv.h:51
cs_cdofb_scaleq_initialize_system
void cs_cdofb_scaleq_initialize_system(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_matrix_t **system_matrix, cs_real_t **system_rhs)
Create the matrix of the current algebraic system. Allocate and initialize the right-hand side associ...
Definition: cs_cdofb_scaleq.c:1052
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_cdofb_scaleq_solve_implicit
void cs_cdofb_scaleq_solve_implicit(double dt_cur, 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:1344
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
mesh
Definition: mesh.f90:26
Generated on Sat Feb 2 2019 15:43:25 by   doxygen 1.8.13