programmer's documentation
cs_hho_scaleq.h
Go to the documentation of this file.
1 #ifndef __CS_HHO_SCALEQ_H__
2 #define __CS_HHO_SCALEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic system for scalar conv./diff. eq. with Hybrid High Order
6  * space discretization
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  * Local headers
31  *----------------------------------------------------------------------------*/
32 
33 #include "cs_base.h"
34 #include "cs_time_step.h"
35 #include "cs_mesh.h"
36 #include "cs_field.h"
37 #include "cs_cdo_connect.h"
38 #include "cs_cdo_local.h"
39 #include "cs_cdo_quantities.h"
40 #include "cs_equation_common.h"
41 #include "cs_equation_param.h"
42 #include "cs_hho_builder.h"
43 #include "cs_matrix.h"
44 #include "cs_matrix_assembler.h"
45 #include "cs_source_term.h"
46 
47 /*----------------------------------------------------------------------------*/
48 
50 
51 /*============================================================================
52  * Macro definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
59 /* Algebraic system for HHO discretization */
60 typedef struct _cs_hho_scaleq_t cs_hho_scaleq_t;
61 
62 /*============================================================================
63  * Public function prototypes
64  *============================================================================*/
65 
66 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
84  const cs_cdo_quantities_t *quant,
85  const cs_cdo_connect_t *connect,
86  const cs_time_step_t *time_step,
87  const cs_matrix_structure_t *ms0,
88  const cs_matrix_structure_t *ms1,
89  const cs_matrix_structure_t *ms2);
90 
91 /*----------------------------------------------------------------------------*/
99 /*----------------------------------------------------------------------------*/
100 
101 void
103  cs_cell_builder_t **cb,
104  cs_hho_builder_t **hhob);
105 
106 /*----------------------------------------------------------------------------*/
110 /*----------------------------------------------------------------------------*/
111 
112 void
114 
115 /*----------------------------------------------------------------------------*/
125 /*----------------------------------------------------------------------------*/
126 
127 void *
129  cs_equation_builder_t *eqb);
130 
131 /*----------------------------------------------------------------------------*/
139 /*----------------------------------------------------------------------------*/
140 
141 void *
142 cs_hho_scaleq_free_context(void *data);
143 
144 /*----------------------------------------------------------------------------*/
152 /*----------------------------------------------------------------------------*/
153 
154 void
157  void *data);
158 
159 /*----------------------------------------------------------------------------*/
171 /*----------------------------------------------------------------------------*/
172 
173 void
176  void *data,
177  cs_matrix_t **system_matrix,
178  cs_real_t **system_rhs);
179 
180 /*----------------------------------------------------------------------------*/
195 /*----------------------------------------------------------------------------*/
196 
197 void
199  const cs_real_t *field_val,
200  double dt_cur,
201  const cs_equation_param_t *eqp,
203  void *data,
204  cs_real_t *rhs,
206 
207 /*----------------------------------------------------------------------------*/
219 /*----------------------------------------------------------------------------*/
220 
221 void
223  const cs_real_t *rhs,
224  const cs_equation_param_t *eqp,
226  void *data,
227  cs_real_t *field_val);
228 
229 /*----------------------------------------------------------------------------*/
238 /*----------------------------------------------------------------------------*/
239 
240 double *
241 cs_hho_scaleq_get_face_values(const void *data);
242 
243 /*----------------------------------------------------------------------------*/
252 /*----------------------------------------------------------------------------*/
253 
254 double *
255 cs_hho_scaleq_get_cell_values(const void *data);
256 
257 /*----------------------------------------------------------------------------*/
267 /*----------------------------------------------------------------------------*/
268 
269 void
270 cs_hho_scaleq_extra_op(const char *eqname,
271  const cs_field_t *field,
272  const cs_equation_param_t *eqp,
274  void *data);
275 
276 /*----------------------------------------------------------------------------*/
277 
279 
280 #endif /* __CS_HHO_SCALEQ_H__ */
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:62
time step descriptor
Definition: cs_time_step.h:51
void cs_hho_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 HHO scheme...
Definition: cs_hho_scaleq.c:1061
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_hho_scaleq_get(cs_cell_sys_t **csys, cs_cell_builder_t **cb, cs_hho_builder_t **hhob)
Retrieve work buffers used for building a CDO system cellwise.
Definition: cs_hho_scaleq.c:694
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
Definition: cs_cdo_connect.h:69
Definition: field.f90:27
void cs_hho_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 required for ...
Definition: cs_hho_scaleq.c:1290
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
Definition: cs_cdo_quantities.h:94
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
void * cs_hho_scaleq_init_context(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_hho_scaleq_t structure storing data useful for managing such a scheme.
Definition: cs_hho_scaleq.c:754
void cs_hho_scaleq_compute_source(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Compute the contributions of source terms (store inside builder)
Definition: cs_hho_scaleq.c:918
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
Definition: cs_mesh.h:63
void cs_hho_scaleq_finalize_common(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_scaleq.c:717
double * cs_hho_scaleq_get_cell_values(const void *data)
Get the computed values at cells (DoF used in the linear system are located at primal faces) ...
Definition: cs_hho_scaleq.c:1421
double * cs_hho_scaleq_get_face_values(const void *data)
Get the computed values at faces (DoF used in the linear system are located at primal faces) ...
Definition: cs_hho_scaleq.c:1399
Definition: cs_hho_builder.h:53
void cs_hho_scaleq_init_common(cs_flag_t scheme_flag, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *ms0, const cs_matrix_structure_t *ms1, const cs_matrix_structure_t *ms2)
Allocate work buffer and general structures related to HHO schemes Set shared pointers.
Definition: cs_hho_scaleq.c:586
Definition: cs_cdo_local.h:71
void cs_hho_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_hho_scaleq.c:1444
#define END_C_DECLS
Definition: cs_defs.h:462
unsigned short int cs_flag_t
Definition: cs_defs.h:299
void cs_hho_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_hho_scaleq.c:1015
Structure and routines handling the specific settings related to a cs_equation_t structure.
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
Definition: mesh.f90:26
void * cs_hho_scaleq_free_context(void *data)
Destroy a cs_hho_scaleq_t structure.
Definition: cs_hho_scaleq.c:885