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 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_param.h"
45 #include "cs_field.h"
46 #include "cs_matrix.h"
47 #include "cs_mesh.h"
48 #include "cs_source_term.h"
49 #include "cs_time_step.h"
50 
51 /*----------------------------------------------------------------------------*/
52 
54 
55 /*============================================================================
56  * Macro definitions
57  *============================================================================*/
58 
59 /*============================================================================
60  * Type definitions
61  *============================================================================*/
62 
63 /* Algebraic system for CDO face-based discretization */
64 typedef struct _cs_cdofb_scaleq_t cs_cdofb_scaleq_t;
65 
66 /*============================================================================
67  * Public function prototypes
68  *============================================================================*/
69 
70 /*----------------------------------------------------------------------------*/
78 /*----------------------------------------------------------------------------*/
79 
80 void
82  const cs_cdo_connect_t *connect,
83  const cs_time_step_t *time_step);
84 
85 /*----------------------------------------------------------------------------*/
90 /*----------------------------------------------------------------------------*/
91 
92 void
94 
95 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
104 
105 /*----------------------------------------------------------------------------*/
114 /*----------------------------------------------------------------------------*/
115 
116 void *
118  const cs_mesh_t *mesh);
119 
120 /*----------------------------------------------------------------------------*/
128 /*----------------------------------------------------------------------------*/
129 
130 void *
131 cs_cdofb_scaleq_free(void *builder);
132 
133 /*----------------------------------------------------------------------------*/
140 /*----------------------------------------------------------------------------*/
141 
142 void
143 cs_cdofb_scaleq_monitor(const char *eqname,
144  const void *builder);
145 
146 /*----------------------------------------------------------------------------*/
152 /*----------------------------------------------------------------------------*/
153 
154 void
155 cs_cdofb_scaleq_compute_source(void *builder);
156 
157 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 void
171  cs_matrix_t **system_matrix,
172  cs_real_t **system_rhs);
173 
174 /*----------------------------------------------------------------------------*/
187 /*----------------------------------------------------------------------------*/
188 
189 void
191  const cs_real_t *field_val,
192  double dt_cur,
193  void *builder,
194  cs_real_t *rhs,
196 
197 /*----------------------------------------------------------------------------*/
207 /*----------------------------------------------------------------------------*/
208 
209 void
211  const cs_real_t *rhs,
212  void *builder,
213  cs_real_t *field_val);
214 
215 /*----------------------------------------------------------------------------*/
223 /*----------------------------------------------------------------------------*/
224 
225 void
226 cs_cdofb_scaleq_extra_op(const char *eqname,
227  const cs_field_t *field,
228  void *builder);
229 
230 /*----------------------------------------------------------------------------*/
238 /*----------------------------------------------------------------------------*/
239 
240 double *
241 cs_cdofb_scaleq_get_face_values(const void *builder);
242 
243 /*----------------------------------------------------------------------------*/
244 
246 
247 #endif /* __CS_CDOFB_SCALEQ_H__ */
void cs_cdofb_scaleq_extra_op(const char *eqname, const cs_field_t *field, void *builder)
Predefined extra-operations related to this equation.
Definition: cs_cdofb_scaleq.c:1058
time step descriptor
Definition: cs_time_step.h:51
void cs_cdofb_scaleq_initialize_system(void *builder, 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:891
void cs_cdofb_scaleq_compute_source(void *builder)
Compute the contributions of source terms (store inside builder)
Definition: cs_cdofb_scaleq.c:842
void cs_cdofb_scaleq_finalize(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:612
void cs_cdofb_scaleq_build_system(const cs_mesh_t *mesh, const cs_real_t *field_val, double dt_cur, void *builder, 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:933
Field descriptor.
Definition: cs_field.h:124
Definition: cs_equation_param.h:100
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
Definition: cs_cdo_connect.h:56
Definition: field.f90:27
void * cs_cdofb_scaleq_init(const cs_equation_param_t *eqp, const cs_mesh_t *mesh)
Initialize a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:629
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:102
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_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:581
double * cs_cdofb_scaleq_get_face_values(const void *builder)
Get the computed values at each face.
Definition: cs_cdofb_scaleq.c:1102
void cs_cdofb_scaleq_update_field(const cs_real_t *solu, const cs_real_t *rhs, void *builder, 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:983
void cs_cdofb_scaleq_monitor(const char *eqname, const void *builder)
Display information related to the monitoring of the current system.
Definition: cs_cdofb_scaleq.c:822
void * cs_cdofb_scaleq_free(void *builder)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:779
#define END_C_DECLS
Definition: cs_defs.h:452
void cs_cdofb_scaleq_initialize(void)
Allocate work buffer and general structures related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:599
Definition: mesh.f90:26