programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 scalar conv./diff. eq.
6  *============================================================================*/
7 
8 /*
9  This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2018 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_base.h"
33 #include "cs_time_step.h"
34 #include "cs_mesh.h"
35 #include "cs_equation_common.h"
36 #include "cs_equation_param.h"
37 #include "cs_field.h"
38 #include "cs_cdo_connect.h"
39 #include "cs_cdo_quantities.h"
40 #include "cs_equation_param.h"
41 #include "cs_source_term.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
55 /* Algebraic system for CDO vertex-based discretization */
56 typedef struct _cs_cdovcb_scaleq_t cs_cdovcb_scaleq_t;
57 
58 /*============================================================================
59  * Public function prototypes
60  *============================================================================*/
61 
62 /*----------------------------------------------------------------------------*/
70 /*----------------------------------------------------------------------------*/
71 
72 void
74  const cs_cdo_connect_t *connect,
75  const cs_time_step_t *time_step);
76 
77 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86 
87 /*----------------------------------------------------------------------------*/
92 /*----------------------------------------------------------------------------*/
93 
94 void
96 
97 /*----------------------------------------------------------------------------*/
107 /*----------------------------------------------------------------------------*/
108 
109 void *
111  cs_equation_builder_t *eqb);
112 
113 /*----------------------------------------------------------------------------*/
121 /*----------------------------------------------------------------------------*/
122 
123 void *
124 cs_cdovcb_scaleq_free_data(void *data);
125 
126 /*----------------------------------------------------------------------------*/
134 /*----------------------------------------------------------------------------*/
135 
136 void
139  void *data);
140 
141 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 void
158  void *data,
159  cs_matrix_t **system_matrix,
160  cs_real_t **system_rhs);
161 
162 /*----------------------------------------------------------------------------*/
177 /*----------------------------------------------------------------------------*/
178 
179 void
181  const cs_real_t *field_val,
182  double dt_cur,
183  const cs_equation_param_t *eqp,
185  void *data,
186  cs_real_t *rhs,
188 
189 /*----------------------------------------------------------------------------*/
201 /*----------------------------------------------------------------------------*/
202 
203 void
205  const cs_real_t *rhs,
206  const cs_equation_param_t *eqp,
208  void *data,
209  cs_real_t *field_val);
210 
211 /*----------------------------------------------------------------------------*/
221 /*----------------------------------------------------------------------------*/
222 
223 double *
224 cs_cdovcb_scaleq_get_cell_values(const void *builder);
225 
226 /*----------------------------------------------------------------------------*/
239 /*----------------------------------------------------------------------------*/
240 
241 void
243  const cs_real_t *pdi,
244  int ml_id,
245  const cs_equation_param_t *eqp,
247  void *data,
248  double *d_flux,
249  double *c_flux);
250 
251 /*----------------------------------------------------------------------------*/
262 /*----------------------------------------------------------------------------*/
263 
264 void
266  const cs_equation_param_t *eqp,
268  void *data,
269  cs_flag_t location,
270  cs_real_t *diff_flux);
271 
272 /*----------------------------------------------------------------------------*/
281 /*----------------------------------------------------------------------------*/
282 
283 void
286  void *data,
287  cs_real_t *v_gradient);
288 
289 /*----------------------------------------------------------------------------*/
299 /*----------------------------------------------------------------------------*/
300 
301 void
302 cs_cdovcb_scaleq_extra_op(const char *eqname,
303  const cs_field_t *field,
304  const cs_equation_param_t *eqp,
306  void *data);
307 
308 /*----------------------------------------------------------------------------*/
309 
311 
312 #endif /* __CS_CDOVCB_SCALEQ_H__ */
Definition: cs_equation_common.h:57
time step descriptor
Definition: cs_time_step.h:51
void cs_cdovcb_scaleq_set_shared_pointers(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Set shared pointers from the main domain members.
Definition: cs_cdovcb_scaleq.c:426
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:884
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:1701
Field descriptor.
Definition: cs_field.h:124
Definition: cs_equation_param.h:101
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
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:1465
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:1206
Definition: cs_cdo_connect.h:55
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:735
void cs_cdovcb_scaleq_initialize(void)
Allocate work buffer and general structures related to CDO vertex+cell-based schemes.
Definition: cs_cdovcb_scaleq.c:444
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:1287
Definition: cs_cdo_quantities.h:89
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
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
Definition: cs_mesh.h:63
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:1580
void * cs_cdovcb_scaleq_free_data(void *data)
Destroy a cs_cdovcb_scaleq_t structure.
Definition: cs_cdovcb_scaleq.c:704
#define END_C_DECLS
Definition: cs_defs.h:454
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_cdovcb_scaleq_finalize(void)
Free buffers and generic structures related to CDO vertex+cell-based schemes.
Definition: cs_cdovcb_scaleq.c:490
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:833
double * cs_cdovcb_scaleq_get_cell_values(const void *builder)
Get the computed values at cell centers (DoF used in the linear system are located at primal vertices...
Definition: cs_cdovcb_scaleq.c:1261
void * cs_cdovcb_scaleq_init_data(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:525