8.1
general documentation
cs_hho_stokes.h
Go to the documentation of this file.
1 #ifndef __CS_HHO_STOKES_H__
2 #define __CS_HHO_STOKES_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-2023 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_param.h"
41 #include "cs_hho_builder.h"
42 #include "cs_matrix.h"
43 #include "cs_matrix_assembler.h"
44 #include "cs_source_term.h"
45 
46 /*----------------------------------------------------------------------------*/
47 
49 
50 /*============================================================================
51  * Macro definitions
52  *============================================================================*/
53 
54 /*============================================================================
55  * Type definitions
56  *============================================================================*/
57 
58 /* Algebraic system for HHO discretization */
59 typedef struct _cs_hho_stokes_t cs_hho_stokes_t;
60 
61 /*============================================================================
62  * Public function prototypes
63  *============================================================================*/
64 
65 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86  const cs_cdo_quantities_t *quant,
87  const cs_cdo_connect_t *connect,
88  const cs_time_step_t *time_step,
89  const cs_matrix_assembler_t *ma0,
90  const cs_matrix_assembler_t *ma1,
91  const cs_matrix_assembler_t *ma2,
92  const cs_matrix_structure_t *ms0,
93  const cs_matrix_structure_t *ms1,
94  const cs_matrix_structure_t *ms2);
95 
96 /*----------------------------------------------------------------------------*/
104 /*----------------------------------------------------------------------------*/
105 
106 void
108  cs_cell_builder_t **cb,
109  cs_hho_builder_t **hhob);
110 
111 /*----------------------------------------------------------------------------*/
115 /*----------------------------------------------------------------------------*/
116 
117 void
119 
120 /*----------------------------------------------------------------------------*/
130 /*----------------------------------------------------------------------------*/
131 
132 void *
134  cs_equation_builder_t *eqb);
135 
136 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void *
147 cs_hho_stokes_free_context(void *data);
148 
149 /*----------------------------------------------------------------------------*/
157 /*----------------------------------------------------------------------------*/
158 
159 void
162  void *data);
163 
164 /*----------------------------------------------------------------------------*/
176 /*----------------------------------------------------------------------------*/
177 
178 void
181  void *data,
182  cs_matrix_t **system_matrix,
183  cs_real_t **system_rhs);
184 
185 /*----------------------------------------------------------------------------*/
198 /*----------------------------------------------------------------------------*/
199 
200 void
202  const cs_real_t *field_val,
203  double dt_cur,
204  const cs_equation_param_t *eqp,
206  void *data);
207 
208 /*----------------------------------------------------------------------------*/
220 /*----------------------------------------------------------------------------*/
221 
222 void
224  const cs_real_t *rhs,
225  const cs_equation_param_t *eqp,
227  void *data,
228  cs_real_t *field_val);
229 
230 /*----------------------------------------------------------------------------*/
239 /*----------------------------------------------------------------------------*/
240 
241 double *
242 cs_hho_stokes_get_face_values(const void *data);
243 
244 /*----------------------------------------------------------------------------*/
253 /*----------------------------------------------------------------------------*/
254 
255 double *
256 cs_hho_stokes_get_cell_values(const void *data);
257 
258 /*----------------------------------------------------------------------------*/
268 /*----------------------------------------------------------------------------*/
269 
270 void
271 cs_hho_stokes_extra_op(const char *eqname,
272  const cs_field_t *field,
273  const cs_equation_param_t *eqp,
275  void *data);
276 
277 /*----------------------------------------------------------------------------*/
278 
280 
281 #endif /* __CS_HHO_STOKES_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:515
unsigned short int cs_flag_t
Definition: cs_defs.h:321
void cs_hho_stokes_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_stokes.c:711
void cs_hho_stokes_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...
double * cs_hho_stokes_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_stokes.c:752
void cs_hho_stokes_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_stokes.c:618
void cs_hho_stokes_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)
Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme....
Definition: cs_hho_stokes.c:656
void * cs_hho_stokes_free_context(void *data)
Destroy a cs_hho_stokes_t structure.
Definition: cs_hho_stokes.c:585
void cs_hho_stokes_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_stokes.c:406
void * cs_hho_stokes_init_context(const cs_equation_param_t *eqp, cs_equation_builder_t *eqb)
Initialize a cs_hho_stokes_t structure storing data useful for managing such a scheme.
Definition: cs_hho_stokes.c:461
void cs_hho_stokes_finalize(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_stokes.c:424
void cs_hho_stokes_initialize(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_assembler_t *ma0, const cs_matrix_assembler_t *ma1, const cs_matrix_assembler_t *ma2, 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_stokes.c:292
void cs_hho_stokes_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_stokes.c:797
double * cs_hho_stokes_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_stokes.c:774
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:106
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:110
struct _cs_matrix_assembler_t cs_matrix_assembler_t
Definition: cs_matrix_assembler.h:61
double precision, dimension(:,:), pointer solu
Definition: atincl.f90:311
Definition: field.f90:27
Definition: mesh.f90:26
Definition: cs_cdo_connect.h:61
Definition: cs_cdo_quantities.h:137
Set of local and temporary buffers.
Definition: cs_cdo_local.h:60
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
Store common elements used when building an algebraic system related to an equation.
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:192
Field descriptor.
Definition: cs_field.h:131
Definition: cs_hho_builder.h:54
Definition: cs_mesh.h:85
time step descriptor
Definition: cs_time_step.h:64