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_source_term.h"
51 #include "cs_time_step.h"
52 
53 /*----------------------------------------------------------------------------*/
54 
56 
57 /*============================================================================
58  * Macro definitions
59  *============================================================================*/
60 
61 /*============================================================================
62  * Type definitions
63  *============================================================================*/
64 
65 /* Algebraic system for CDO face-based discretization */
66 typedef struct _cs_cdofb_t cs_cdofb_scaleq_t;
67 
68 /*============================================================================
69  * Public function prototypes
70  *============================================================================*/
71 
72 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
85 void
87  const cs_cdo_connect_t *connect,
88  const cs_time_step_t *time_step,
89  const cs_matrix_structure_t *ms);
90 
91 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 void
102  cs_cell_builder_t **cb);
103 
104 /*----------------------------------------------------------------------------*/
109 /*----------------------------------------------------------------------------*/
110 
111 void
113 
114 /*----------------------------------------------------------------------------*/
124 /*----------------------------------------------------------------------------*/
125 
126 void *
128  cs_equation_builder_t *eqb);
129 
130 /*----------------------------------------------------------------------------*/
138 /*----------------------------------------------------------------------------*/
139 
140 void *
141 cs_cdofb_scaleq_free_context(void *data);
142 
143 /*----------------------------------------------------------------------------*/
151 /*----------------------------------------------------------------------------*/
152 
153 void
156  void *data);
157 
158 /*----------------------------------------------------------------------------*/
170 /*----------------------------------------------------------------------------*/
171 
172 void
175  void *data,
176  cs_matrix_t **system_matrix,
177  cs_real_t **system_rhs);
178 
179 /*----------------------------------------------------------------------------*/
194 /*----------------------------------------------------------------------------*/
195 
196 void
198  const cs_real_t *field_val,
199  double dt_cur,
200  const cs_equation_param_t *eqp,
202  void *data,
203  cs_real_t *rhs,
205 
206 /*----------------------------------------------------------------------------*/
218 /*----------------------------------------------------------------------------*/
219 
220 void
222  const cs_real_t *rhs,
223  const cs_equation_param_t *eqp,
225  void *data,
226  cs_real_t *field_val);
227 
228 /*----------------------------------------------------------------------------*/
238 /*----------------------------------------------------------------------------*/
239 
240 void
241 cs_cdofb_scaleq_extra_op(const char *eqname,
242  const cs_field_t *field,
243  const cs_equation_param_t *eqp,
245  void *data);
246 
247 /*----------------------------------------------------------------------------*/
255 /*----------------------------------------------------------------------------*/
256 
257 double *
258 cs_cdofb_scaleq_get_face_values(const void *data);
259 
260 /*----------------------------------------------------------------------------*/
261 
263 
264 #endif /* __CS_CDOFB_SCALEQ_H__ */
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:62
void * cs_cdofb_scaleq_init_context(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_cdofb_scaleq_t structure storing data useful for managing such a scheme.
Definition: cs_cdofb_scaleq.c:363
time step descriptor
Definition: cs_time_step.h:51
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
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:259
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
Definition: cs_cdo_connect.h:69
void cs_cdofb_scaleq_finalize_common(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:331
Definition: field.f90:27
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:94
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:879
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
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:628
void * cs_cdofb_scaleq_free_context(void *data)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:495
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:922
Definition: cs_cdo_local.h:71
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:309
void cs_cdofb_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_cdofb_scaleq.c:524
#define END_C_DECLS
Definition: cs_defs.h:462
Definition: cs_cdofb_priv.h:51
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:583
Structure and routines handling the specific settings related to a cs_equation_t structure.
double * cs_cdofb_scaleq_get_face_values(const void *data)
Get the computed values at each face.
Definition: cs_cdofb_scaleq.c:973
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
Definition: mesh.f90:26