programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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 convection/diffusion equation
6  * 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_quantities.h"
44 #include "cs_equation_common.h"
45 #include "cs_equation_param.h"
46 #include "cs_field.h"
47 #include "cs_matrix.h"
48 #include "cs_mesh.h"
49 #include "cs_source_term.h"
50 #include "cs_time_step.h"
51 
52 /*----------------------------------------------------------------------------*/
53 
55 
56 /*============================================================================
57  * Macro definitions
58  *============================================================================*/
59 
60 /*============================================================================
61  * Type definitions
62  *============================================================================*/
63 
64 /* Algebraic system for CDO face-based discretization */
65 typedef struct _cs_cdofb_scaleq_t cs_cdofb_scaleq_t;
66 
67 /*============================================================================
68  * Public function prototypes
69  *============================================================================*/
70 
71 /*----------------------------------------------------------------------------*/
79 /*----------------------------------------------------------------------------*/
80 
81 void
83  const cs_cdo_connect_t *connect,
84  const cs_time_step_t *time_step);
85 
86 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 void
95 
96 /*----------------------------------------------------------------------------*/
101 /*----------------------------------------------------------------------------*/
102 
103 void
105 
106 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void *
120  cs_equation_builder_t *eqb);
121 
122 /*----------------------------------------------------------------------------*/
130 /*----------------------------------------------------------------------------*/
131 
132 void *
133 cs_cdofb_scaleq_free_data(void *data);
134 
135 /*----------------------------------------------------------------------------*/
143 /*----------------------------------------------------------------------------*/
144 
145 void
148  void *data);
149 
150 /*----------------------------------------------------------------------------*/
162 /*----------------------------------------------------------------------------*/
163 
164 void
167  void *data,
168  cs_matrix_t **system_matrix,
169  cs_real_t **system_rhs);
170 
171 /*----------------------------------------------------------------------------*/
186 /*----------------------------------------------------------------------------*/
187 
188 void
190  const cs_real_t *field_val,
191  double dt_cur,
192  const cs_equation_param_t *eqp,
194  void *data,
195  cs_real_t *rhs,
197 
198 /*----------------------------------------------------------------------------*/
210 /*----------------------------------------------------------------------------*/
211 
212 void
214  const cs_real_t *rhs,
215  const cs_equation_param_t *eqp,
217  void *data,
218  cs_real_t *field_val);
219 
220 /*----------------------------------------------------------------------------*/
230 /*----------------------------------------------------------------------------*/
231 
232 void
233 cs_cdofb_scaleq_extra_op(const char *eqname,
234  const cs_field_t *field,
235  const cs_equation_param_t *eqp,
237  void *data);
238 
239 /*----------------------------------------------------------------------------*/
247 /*----------------------------------------------------------------------------*/
248 
249 double *
250 cs_cdofb_scaleq_get_face_values(const void *data);
251 
252 /*----------------------------------------------------------------------------*/
253 
255 
256 #endif /* __CS_CDOFB_SCALEQ_H__ */
Definition: cs_equation_common.h:57
time step descriptor
Definition: cs_time_step.h:51
void cs_cdofb_scaleq_finalize(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:395
Field descriptor.
Definition: cs_field.h:124
Definition: cs_equation_param.h:101
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
void * cs_cdofb_scaleq_free_data(void *data)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:567
Definition: cs_cdo_connect.h:55
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:89
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:929
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_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:704
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:980
void cs_cdofb_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_cdofb_scaleq.c:330
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:597
#define END_C_DECLS
Definition: cs_defs.h:454
void * cs_cdofb_scaleq_init_data(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:430
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:656
void cs_cdofb_scaleq_initialize(void)
Allocate work buffer and general structures related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:348
double * cs_cdofb_scaleq_get_face_values(const void *data)
Get the computed values at each face.
Definition: cs_cdofb_scaleq.c:1031