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-2016 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_mesh.h"
43 #include "cs_field.h"
44 #include "cs_cdo_connect.h"
45 #include "cs_cdo_quantities.h"
46 #include "cs_equation_param.h"
47 #include "cs_source_term.h"
48 
49 /*----------------------------------------------------------------------------*/
50 
52 
53 /*============================================================================
54  * Macro definitions
55  *============================================================================*/
56 
57 /*============================================================================
58  * Type definitions
59  *============================================================================*/
60 
61 /* Algebraic system for CDO face-based discretization */
62 typedef struct _cs_cdofb_scaleq_t cs_cdofb_scaleq_t;
63 
64 /*============================================================================
65  * Public function prototypes
66  *============================================================================*/
67 
68 /*----------------------------------------------------------------------------*/
76 /*----------------------------------------------------------------------------*/
77 
78 void
80  const cs_cdo_connect_t *connect,
81  const cs_time_step_t *time_step);
82 
83 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
92 
93 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 void
102 
103 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void *
116  const cs_mesh_t *mesh);
117 
118 /*----------------------------------------------------------------------------*/
126 /*----------------------------------------------------------------------------*/
127 
128 void *
129 cs_cdofb_scaleq_free(void *builder);
130 
131 /*----------------------------------------------------------------------------*/
138 /*----------------------------------------------------------------------------*/
139 
140 void
141 cs_cdofb_scaleq_free_sysmat(void *builder,
143 
144 /*----------------------------------------------------------------------------*/
150 /*----------------------------------------------------------------------------*/
151 
152 void
153 cs_cdofb_scaleq_compute_source(void *builder);
154 
155 /*----------------------------------------------------------------------------*/
167 /*----------------------------------------------------------------------------*/
168 
169 void
171  const cs_real_t *field_val,
172  double dt_cur,
173  void *builder,
174  cs_real_t **rhs,
175  cs_sla_matrix_t **sla_mat);
176 
177 /*----------------------------------------------------------------------------*/
187 /*----------------------------------------------------------------------------*/
188 
189 void
191  const cs_real_t *rhs,
192  void *builder,
193  cs_real_t *field_val);
194 
195 /*----------------------------------------------------------------------------*/
203 /*----------------------------------------------------------------------------*/
204 
205 void
206 cs_cdofb_scaleq_extra_op(const char *eqname,
207  const cs_field_t *field,
208  void *builder);
209 
210 /*----------------------------------------------------------------------------*/
218 /*----------------------------------------------------------------------------*/
219 
220 double *
221 cs_cdofb_scaleq_get_face_values(const void *builder);
222 
223 /*----------------------------------------------------------------------------*/
224 
226 
227 #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:813
time step descriptor
Definition: cs_time_step.h:51
void cs_cdofb_scaleq_compute_source(void *builder)
Compute the contributions of source terms (store inside builder)
Definition: cs_cdofb_scaleq.c:642
void cs_cdofb_scaleq_finalize(void)
Free work buffer and general structure related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:455
Field descriptor.
Definition: cs_field.h:121
Definition: cs_equation_param.h:102
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_sla_matrix_t **sla_mat)
Build the linear system arising from a scalar convection/diffusion equation with a CDO face-based sch...
Definition: cs_cdofb_scaleq.c:687
#define BEGIN_C_DECLS
Definition: cs_defs.h:448
Definition: cs_cdo_connect.h:67
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:472
double cs_real_t
Floating-point value.
Definition: cs_defs.h:296
Definition: cs_cdo_quantities.h:100
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_sla.h:86
Definition: cs_mesh.h:62
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:424
double * cs_cdofb_scaleq_get_face_values(const void *builder)
Get the computed values at each face.
Definition: cs_cdofb_scaleq.c:856
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:738
void * cs_cdofb_scaleq_free(void *builder)
Destroy a cs_cdofb_scaleq_t structure.
Definition: cs_cdofb_scaleq.c:584
#define END_C_DECLS
Definition: cs_defs.h:449
void cs_cdofb_scaleq_initialize(void)
Allocate work buffer and general structures related to CDO face-based schemes.
Definition: cs_cdofb_scaleq.c:442
void cs_cdofb_scaleq_free_sysmat(void *builder, cs_sla_matrix_t *matrix)
Destroy a cs_sla_matrix_t related to the system to solve.
Definition: cs_cdofb_scaleq.c:624
Definition: mesh.f90:26