7.2
general documentation
cs_hho_vecteq.h
Go to the documentation of this file.
1 #ifndef __CS_HHO_VECTEQ_H__
2 #define __CS_HHO_VECTEQ_H__
3 
4 /*============================================================================
5  * Build an algebraic system for vector 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-2022 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_cdo_connect.h"
35 #include "cs_cdo_local.h"
36 #include "cs_cdo_quantities.h"
37 #include "cs_equation_builder.h"
38 #include "cs_equation_param.h"
39 #include "cs_field.h"
40 #include "cs_hho_builder.h"
41 #include "cs_matrix.h"
42 #include "cs_matrix_assembler.h"
43 #include "cs_mesh.h"
44 #include "cs_restart.h"
45 #include "cs_source_term.h"
46 #include "cs_time_step.h"
47 
48 /*----------------------------------------------------------------------------*/
49 
50 BEGIN_C_DECLS
51 
52 /*============================================================================
53  * Macro definitions
54  *============================================================================*/
55 
56 /*============================================================================
57  * Type definitions
58  *============================================================================*/
59 
60 /* Algebraic system for HHO discretization */
61 typedef struct _cs_hho_vecteq_t cs_hho_vecteq_t;
62 
63 /*============================================================================
64  * Public function prototypes
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 void
84 cs_hho_vecteq_init_sharing(cs_flag_t scheme_flag,
85  const cs_cdo_quantities_t *quant,
86  const cs_cdo_connect_t *connect,
87  const cs_time_step_t *time_step);
88 
89 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
100 cs_hho_vecteq_get(cs_cell_sys_t **csys,
101  cs_cell_builder_t **cb,
102  cs_hho_builder_t **hhob);
103 
104 /*----------------------------------------------------------------------------*/
108 /*----------------------------------------------------------------------------*/
109 
110 void
111 cs_hho_vecteq_finalize_sharing(void);
112 
113 /*----------------------------------------------------------------------------*/
125 /*----------------------------------------------------------------------------*/
126 
127 void *
128 cs_hho_vecteq_init_context(const cs_equation_param_t *eqp,
129  int var_id,
130  int bflux_id,
131  cs_equation_builder_t *eqb);
132 
133 /*----------------------------------------------------------------------------*/
141 /*----------------------------------------------------------------------------*/
142 
143 void *
144 cs_hho_vecteq_free_context(void *data);
145 
146 /*----------------------------------------------------------------------------*/
159 /*----------------------------------------------------------------------------*/
160 
161 void
162 cs_hho_vecteq_init_values(cs_real_t t_eval,
163  const int field_id,
164  const cs_mesh_t *mesh,
165  const cs_equation_param_t *eqp,
166  cs_equation_builder_t *eqb,
167  void *context);
168 
169 /*----------------------------------------------------------------------------*/
177 /*----------------------------------------------------------------------------*/
178 
179 void
180 cs_hho_vecteq_compute_source(const cs_equation_param_t *eqp,
181  cs_equation_builder_t *eqb,
182  void *data);
183 
184 /*----------------------------------------------------------------------------*/
196 /*----------------------------------------------------------------------------*/
197 
198 void
199 cs_hho_vecteq_build_system(const cs_mesh_t *mesh,
200  const cs_real_t *field_val,
201  const cs_equation_param_t *eqp,
202  cs_equation_builder_t *eqb,
203  void *context);
204 
205 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 void
220 cs_hho_vecteq_update_field(const cs_real_t *solu,
221  const cs_real_t *rhs,
222  const cs_equation_param_t *eqp,
223  cs_equation_builder_t *eqb,
224  void *data,
225  cs_real_t *field_val);
226 
227 /*----------------------------------------------------------------------------*/
237 /*----------------------------------------------------------------------------*/
238 
239 cs_real_t *
240 cs_hho_vecteq_get_face_values(void *data,
241  bool previous);
242 
243 /*----------------------------------------------------------------------------*/
253 /*----------------------------------------------------------------------------*/
254 
255 cs_real_t *
256 cs_hho_vecteq_get_cell_values(void *data,
257  bool previous);
258 
259 /*----------------------------------------------------------------------------*/
268 /*----------------------------------------------------------------------------*/
269 
270 void
271 cs_hho_vecteq_read_restart(cs_restart_t *restart,
272  const char *eqname,
273  void *scheme_context);
274 
275 /*----------------------------------------------------------------------------*/
284 /*----------------------------------------------------------------------------*/
285 
286 void
287 cs_hho_vecteq_write_restart(cs_restart_t *restart,
288  const char *eqname,
289  void *scheme_context);
290 
291 /*----------------------------------------------------------------------------*/
299 /*----------------------------------------------------------------------------*/
300 
301 void
302 cs_hho_vecteq_extra_post(const cs_equation_param_t *eqp,
303  cs_equation_builder_t *eqb,
304  void *context);
305 
306 /*----------------------------------------------------------------------------*/
307 
308 END_C_DECLS
309 
310 #endif /* __CS_HHO_VECTEQ_H__ */
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:64
cs_base.h
cs_restart.h
cs_hho_vecteq_get_cell_values
cs_real_t * cs_hho_vecteq_get_cell_values(void *data, bool previous)
Get the computed values at cells (DoF used in the linear system are located at primal faces) ...
Definition: cs_hho_vecteq.c:1560
cs_hho_vecteq_read_restart
void cs_hho_vecteq_read_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Read additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_hho_vecteq.c:1586
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:186
cs_hho_vecteq_get_face_values
cs_real_t * cs_hho_vecteq_get_face_values(void *data, bool previous)
Get the computed values at faces (DoF used in the linear system are located at primal faces) ...
Definition: cs_hho_vecteq.c:1533
cs_cdo_connect.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:510
cs_hho_vecteq_update_field
void cs_hho_vecteq_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_vecteq.c:1402
cs_hho_vecteq_finalize_sharing
void cs_hho_vecteq_finalize_sharing(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_vecteq.c:716
cs_hho_vecteq_init_values
void cs_hho_vecteq_init_values(cs_real_t t_eval, const int field_id, const cs_mesh_t *mesh, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Set the initial values of the variable field taking into account the boundary conditions. Case of vector-valued HHO schemes.
Definition: cs_hho_vecteq.c:969
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_matrix.h
cs_hho_vecteq_write_restart
void cs_hho_vecteq_write_restart(cs_restart_t *restart, const char *eqname, void *scheme_context)
Write additional arrays (not defined as fields) but useful for the checkpoint/restart process...
Definition: cs_hho_vecteq.c:1668
cs_source_term.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:322
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:132
cs_cell_sys_t
Set of arrays and local (small) dense matrices related to a mesh cell This is a key structure for bui...
Definition: cs_cdo_local.h:147
cs_mesh_t
Definition: cs_mesh.h:84
cs_hho_builder_t
Definition: cs_hho_builder.h:54
cs_hho_vecteq_init_sharing
void cs_hho_vecteq_init_sharing(cs_flag_t scheme_flag, const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Allocate work buffer and general structures related to HHO schemes Set shared pointers.
Definition: cs_hho_vecteq.c:591
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:93
cs_hho_vecteq_free_context
void * cs_hho_vecteq_free_context(void *data)
Destroy a cs_hho_vecteq_t structure.
Definition: cs_hho_vecteq.c:931
cs_hho_vecteq_get
void cs_hho_vecteq_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_vecteq.c:693
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
cs_hho_vecteq_extra_post
void cs_hho_vecteq_extra_post(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Predefined extra-operations related to this equation.
Definition: cs_hho_vecteq.c:1729
cs_hho_builder.h
cs_cdo_quantities.h
cs_hho_vecteq_init_context
void * cs_hho_vecteq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_hho_vecteq_t structure storing data useful for managing such a scheme.
Definition: cs_hho_vecteq.c:755
atincl::solu
double precision, dimension(:,:), allocatable solu
Definition: atincl.f90:321
cs_field.h
cs_mesh.h
cs_time_step.h
cs_cdo_local.h
cs_hho_vecteq_compute_source
void cs_hho_vecteq_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_vecteq.c:1015
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:511
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:324
cs_equation_param.h
cs_hho_vecteq_build_system
void cs_hho_vecteq_build_system(const cs_mesh_t *mesh, const cs_real_t *field_val, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *context)
Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme...
Definition: cs_hho_vecteq.c:1111
mesh
Definition: mesh.f90:26
cs_matrix_assembler.h
cs_equation_builder.h