My Project
programmer's 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-2019 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 
49 BEGIN_C_DECLS
50 
51 /*============================================================================
52  * Macro definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Type definitions
57  *============================================================================*/
58 
59 /* Algebraic system for HHO discretization */
60 typedef struct _cs_hho_stokes_t cs_hho_stokes_t;
61 
62 /*============================================================================
63  * Public function prototypes
64  *============================================================================*/
65 
66 /*----------------------------------------------------------------------------*/
83 /*----------------------------------------------------------------------------*/
84 
85 void
86 cs_hho_stokes_initialize(cs_flag_t scheme_flag,
87  const cs_cdo_quantities_t *quant,
88  const cs_cdo_connect_t *connect,
89  const cs_time_step_t *time_step,
90  const cs_matrix_assembler_t *ma0,
91  const cs_matrix_assembler_t *ma1,
92  const cs_matrix_assembler_t *ma2,
93  const cs_matrix_structure_t *ms0,
94  const cs_matrix_structure_t *ms1,
95  const cs_matrix_structure_t *ms2);
96 
97 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void
108 cs_hho_stokes_get(cs_cell_sys_t **csys,
109  cs_cell_builder_t **cb,
110  cs_hho_builder_t **hhob);
111 
112 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void
119 cs_hho_stokes_finalize(void);
120 
121 /*----------------------------------------------------------------------------*/
131 /*----------------------------------------------------------------------------*/
132 
133 void *
134 cs_hho_stokes_init_context(const cs_equation_param_t *eqp,
135  cs_equation_builder_t *eqb);
136 
137 /*----------------------------------------------------------------------------*/
145 /*----------------------------------------------------------------------------*/
146 
147 void *
148 cs_hho_stokes_free_context(void *data);
149 
150 /*----------------------------------------------------------------------------*/
158 /*----------------------------------------------------------------------------*/
159 
160 void
161 cs_hho_stokes_compute_source(const cs_equation_param_t *eqp,
162  cs_equation_builder_t *eqb,
163  void *data);
164 
165 /*----------------------------------------------------------------------------*/
177 /*----------------------------------------------------------------------------*/
178 
179 void
180 cs_hho_stokes_initialize_system(const cs_equation_param_t *eqp,
181  cs_equation_builder_t *eqb,
182  void *data,
183  cs_matrix_t **system_matrix,
184  cs_real_t **system_rhs);
185 
186 /*----------------------------------------------------------------------------*/
201 /*----------------------------------------------------------------------------*/
202 
203 void
204 cs_hho_stokes_build_system(const cs_mesh_t *mesh,
205  const cs_real_t *field_val,
206  double dt_cur,
207  const cs_equation_param_t *eqp,
208  cs_equation_builder_t *eqb,
209  void *data,
210  cs_real_t *rhs,
211  cs_matrix_t *matrix);
212 
213 /*----------------------------------------------------------------------------*/
225 /*----------------------------------------------------------------------------*/
226 
227 void
228 cs_hho_stokes_update_field(const cs_real_t *solu,
229  const cs_real_t *rhs,
230  const cs_equation_param_t *eqp,
231  cs_equation_builder_t *eqb,
232  void *data,
233  cs_real_t *field_val);
234 
235 /*----------------------------------------------------------------------------*/
244 /*----------------------------------------------------------------------------*/
245 
246 double *
247 cs_hho_stokes_get_face_values(const void *data);
248 
249 /*----------------------------------------------------------------------------*/
258 /*----------------------------------------------------------------------------*/
259 
260 double *
261 cs_hho_stokes_get_cell_values(const void *data);
262 
263 /*----------------------------------------------------------------------------*/
273 /*----------------------------------------------------------------------------*/
274 
275 void
276 cs_hho_stokes_extra_op(const char *eqname,
277  const cs_field_t *field,
278  const cs_equation_param_t *eqp,
279  cs_equation_builder_t *eqb,
280  void *data);
281 
282 /*----------------------------------------------------------------------------*/
283 
284 END_C_DECLS
285 
286 #endif /* __CS_HHO_STOKES_H__ */
cs_hho_stokes_build_system
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, 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_stokes.c:729
cs_hho_stokes_finalize
void cs_hho_stokes_finalize(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_stokes.c:442
cs_hho_stokes_init_context
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:479
cs_equation_common.h
cs_hho_builder.h
field
Definition: field.f90:27
cs_matrix_structure_t
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
cs_hho_stokes_extra_op
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:874
cs_source_term.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:467
cs_matrix_t
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:90
cs_hho_stokes_compute_source
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:646
cs_matrix_assembler.h
cs_cdo_quantities.h
mesh
Definition: mesh.f90:26
cs_mesh.h
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:148
cs_hho_stokes_update_field
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:788
cs_hho_stokes_initialize_system
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...
Definition: cs_hho_stokes.c:683
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_hho_stokes_initialize
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:305
cs_field.h
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_hho_stokes_get
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:419
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
cs_cell_builder_t
Set of local and temporary buffers useful for building the algebraic system with a cellwise process....
Definition: cs_cdo_local.h:56
cs_cdo_connect.h
cs_hho_stokes_get_cell_values
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:851
cs_time_step.h
cs_matrix_assembler_t
struct _cs_matrix_assembler_t cs_matrix_assembler_t
Definition: cs_matrix_assembler.h:61
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:61
cs_hho_builder_t
Definition: cs_hho_builder.h:53
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:304
atincl::solu
double precision, dimension(:,:), allocatable solu
Definition: atincl.f90:265
cs_matrix.h
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_hho_stokes_free_context
void * cs_hho_stokes_free_context(void *data)
Destroy a cs_hho_stokes_t structure.
Definition: cs_hho_stokes.c:613
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:93
cs_field_t
Field descriptor.
Definition: cs_field.h:124
cs_mesh_t
Definition: cs_mesh.h:63
cs_base.h
cs_hho_stokes_get_face_values
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:829
cs_cdo_local.h
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16