programmer's documentation
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-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  * Local headers
31  *----------------------------------------------------------------------------*/
32 
33 #include "cs_base.h"
34 #include "cs_time_step.h"
35 #include "cs_mesh.h"
36 #include "cs_equation_common.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_source_term.h"
43 
44 /*----------------------------------------------------------------------------*/
45 
47 
48 /*============================================================================
49  * Macro definitions
50  *============================================================================*/
51 
52 /*============================================================================
53  * Type definitions
54  *============================================================================*/
55 
56 /* Algebraic system for CDO vertex-based discretization */
57 typedef struct _cs_cdovcb_scaleq_t cs_cdovcb_scaleq_t;
58 
59 /*============================================================================
60  * Public function prototypes
61  *============================================================================*/
62 
63 /*----------------------------------------------------------------------------*/
74 /*----------------------------------------------------------------------------*/
75 
76 void
78  const cs_cdo_connect_t *connect,
79  const cs_time_step_t *time_step,
80  const cs_matrix_structure_t *ms);
81 
82 /*----------------------------------------------------------------------------*/
89 /*----------------------------------------------------------------------------*/
90 
91 void
93  cs_cell_builder_t **cb);
94 
95 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
104 
105 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 void *
119  cs_equation_builder_t *eqb);
120 
121 /*----------------------------------------------------------------------------*/
129 /*----------------------------------------------------------------------------*/
130 
131 void *
133 
134 /*----------------------------------------------------------------------------*/
142 /*----------------------------------------------------------------------------*/
143 
144 void
147  void *data);
148 
149 /*----------------------------------------------------------------------------*/
161 /*----------------------------------------------------------------------------*/
162 
163 void
166  void *data,
167  cs_matrix_t **system_matrix,
168  cs_real_t **system_rhs);
169 
170 /*----------------------------------------------------------------------------*/
185 /*----------------------------------------------------------------------------*/
186 
187 void
189  const cs_real_t *field_val,
190  double dt_cur,
191  const cs_equation_param_t *eqp,
193  void *data,
194  cs_real_t *rhs,
196 
197 /*----------------------------------------------------------------------------*/
209 /*----------------------------------------------------------------------------*/
210 
211 void
213  const cs_real_t *rhs,
214  const cs_equation_param_t *eqp,
216  void *data,
217  cs_real_t *field_val);
218 
219 /*----------------------------------------------------------------------------*/
229 /*----------------------------------------------------------------------------*/
230 
231 double *
232 cs_cdovcb_scaleq_get_cell_values(const void *data);
233 
234 /*----------------------------------------------------------------------------*/
247 /*----------------------------------------------------------------------------*/
248 
249 void
251  const cs_real_t *pdi,
252  int ml_id,
253  const cs_equation_param_t *eqp,
255  void *data,
256  double *d_flux,
257  double *c_flux);
258 
259 /*----------------------------------------------------------------------------*/
270 /*----------------------------------------------------------------------------*/
271 
272 void
274  const cs_equation_param_t *eqp,
276  void *data,
277  cs_flag_t location,
278  cs_real_t *diff_flux);
279 
280 /*----------------------------------------------------------------------------*/
289 /*----------------------------------------------------------------------------*/
290 
291 void
294  void *data,
295  cs_real_t *v_gradient);
296 
297 /*----------------------------------------------------------------------------*/
307 /*----------------------------------------------------------------------------*/
308 
309 void
310 cs_cdovcb_scaleq_extra_op(const char *eqname,
311  const cs_field_t *field,
312  const cs_equation_param_t *eqp,
314  void *data);
315 
316 /*----------------------------------------------------------------------------*/
317 
319 
320 #endif /* __CS_CDOVCB_SCALEQ_H__ */
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:62
time step descriptor
Definition: cs_time_step.h:51
void cs_cdovcb_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 vertex+cell-ba...
Definition: cs_cdovcb_scaleq.c:807
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:408
void cs_cdovcb_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_cdovcb_scaleq.c:1610
Field descriptor.
Definition: cs_field.h:124
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:150
double * cs_cdovcb_scaleq_get_cell_values(const void *data)
Get the computed values at cell centers (DoF used in the linear system are located at primal vertices...
Definition: cs_cdovcb_scaleq.c:1170
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
void cs_cdovcb_scaleq_cellwise_diff_flux(const cs_real_t *values, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, cs_flag_t location, cs_real_t *diff_flux)
Cellwise computation of the diffusive flux.
Definition: cs_cdovcb_scaleq.c:1374
void cs_cdovcb_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_cdovcb_scaleq.c:1130
Definition: cs_cdo_connect.h:69
Definition: field.f90:27
void cs_cdovcb_scaleq_compute_source(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Compute the contributions of source terms (store inside data)
Definition: cs_cdovcb_scaleq.c:665
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_cdovcb_scaleq_compute_flux_across_plane(const cs_real_t normal[], const cs_real_t *pdi, int ml_id, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data, double *d_flux, double *c_flux)
Compute the diffusive and convective flux across a list of faces.
Definition: cs_cdovcb_scaleq.c:1196
Definition: cs_cdo_quantities.h:94
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
Definition: cs_cdo_local.h:94
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
Definition: cs_mesh.h:63
struct _cs_cdovcb_scaleq_t cs_cdovcb_scaleq_t
Definition: cs_cdovcb_scaleq.h:57
void * cs_cdovcb_scaleq_free_context(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition: cs_cdovcb_scaleq.c:635
void cs_cdovcb_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 vertex+cell-based schemes Set shared point...
Definition: cs_cdovcb_scaleq.c:358
void cs_cdovcb_scaleq_vtx_gradient(const cs_real_t *v_values, cs_equation_builder_t *eqb, void *data, cs_real_t *v_gradient)
Cellwise computation of the discrete gradient at vertices.
Definition: cs_cdovcb_scaleq.c:1489
Definition: cs_cdo_local.h:71
void * cs_cdovcb_scaleq_init_context(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_cdovb_scaleq_t structure storing data useful for managing such a scheme.
Definition: cs_cdovcb_scaleq.c:462
void cs_cdovcb_scaleq_finalize_common(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition: cs_cdovcb_scaleq.c:430
#define END_C_DECLS
Definition: cs_defs.h:462
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_cdovcb_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_cdovcb_scaleq.c:763
Structure and routines handling the specific settings related to a cs_equation_t structure.
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
Definition: mesh.f90:26