My Project
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-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_restart.h"
46 #include "cs_source_term.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_scaleq_t cs_hho_scaleq_t;
62 
63 /*============================================================================
64  * Public function prototypes
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------*/
81 /*----------------------------------------------------------------------------*/
82 
83 void
84 cs_hho_scaleq_init_common(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  const cs_matrix_structure_t *ms0,
89  const cs_matrix_structure_t *ms1,
90  const cs_matrix_structure_t *ms2);
91 
92 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
103 cs_hho_scaleq_get(cs_cell_sys_t **csys,
104  cs_cell_builder_t **cb,
105  cs_hho_builder_t **hhob);
106 
107 /*----------------------------------------------------------------------------*/
111 /*----------------------------------------------------------------------------*/
112 
113 void
114 cs_hho_scaleq_finalize_common(void);
115 
116 /*----------------------------------------------------------------------------*/
128 /*----------------------------------------------------------------------------*/
129 
130 void *
131 cs_hho_scaleq_init_context(const cs_equation_param_t *eqp,
132  int var_id,
133  int bflux_id,
134  cs_equation_builder_t *eqb);
135 
136 /*----------------------------------------------------------------------------*/
144 /*----------------------------------------------------------------------------*/
145 
146 void *
147 cs_hho_scaleq_free_context(void *data);
148 
149 /*----------------------------------------------------------------------------*/
162 /*----------------------------------------------------------------------------*/
163 
164 void
165 cs_hho_scaleq_init_values(cs_real_t t_eval,
166  const int field_id,
167  const cs_mesh_t *mesh,
168  const cs_equation_param_t *eqp,
169  cs_equation_builder_t *eqb,
170  void *context);
171 
172 /*----------------------------------------------------------------------------*/
184 /*----------------------------------------------------------------------------*/
185 
186 void
187 cs_hho_scaleq_initialize_system(const cs_equation_param_t *eqp,
188  cs_equation_builder_t *eqb,
189  void *data,
190  cs_matrix_t **system_matrix,
191  cs_real_t **system_rhs);
192 
193 /*----------------------------------------------------------------------------*/
207 /*----------------------------------------------------------------------------*/
208 
209 void
210 cs_hho_scaleq_build_system(const cs_mesh_t *mesh,
211  const cs_real_t *field_val,
212  const cs_equation_param_t *eqp,
213  cs_equation_builder_t *eqb,
214  void *data,
215  cs_real_t *rhs,
216  cs_matrix_t *matrix);
217 
218 /*----------------------------------------------------------------------------*/
230 /*----------------------------------------------------------------------------*/
231 
232 void
233 cs_hho_scaleq_update_field(const cs_real_t *solu,
234  const cs_real_t *rhs,
235  const cs_equation_param_t *eqp,
236  cs_equation_builder_t *eqb,
237  void *data,
238  cs_real_t *field_val);
239 
240 /*----------------------------------------------------------------------------*/
249 /*----------------------------------------------------------------------------*/
250 
251 cs_real_t *
252 cs_hho_scaleq_get_face_values(void *data);
253 
254 /*----------------------------------------------------------------------------*/
263 /*----------------------------------------------------------------------------*/
264 
265 cs_real_t *
266 cs_hho_scaleq_get_cell_values(void *data);
267 
268 /*----------------------------------------------------------------------------*/
277 /*----------------------------------------------------------------------------*/
278 
279 void
280 cs_hho_scaleq_read_restart(cs_restart_t *restart,
281  const char *eqname,
282  void *scheme_context);
283 
284 /*----------------------------------------------------------------------------*/
293 /*----------------------------------------------------------------------------*/
294 
295 void
296 cs_hho_scaleq_write_restart(cs_restart_t *restart,
297  const char *eqname,
298  void *scheme_context);
299 
300 /*----------------------------------------------------------------------------*/
310 /*----------------------------------------------------------------------------*/
311 
312 void
313 cs_hho_scaleq_extra_op(const char *eqname,
314  const cs_field_t *field,
315  const cs_equation_param_t *eqp,
316  cs_equation_builder_t *eqb,
317  void *data);
318 
319 /*----------------------------------------------------------------------------*/
320 
321 END_C_DECLS
322 
323 #endif /* __CS_HHO_SCALEQ_H__ */
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_source_term.h
cs_hho_scaleq_init_values
void cs_hho_scaleq_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....
Definition: cs_hho_scaleq.c:991
cs_hho_scaleq_get_face_values
cs_real_t * cs_hho_scaleq_get_face_values(void *data)
Get the computed values at faces (DoF used in the linear system are located at primal faces)
Definition: cs_hho_scaleq.c:1436
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:468
cs_hho_scaleq_init_context
void * cs_hho_scaleq_init_context(const cs_equation_param_t *eqp, int var_id, int bflux_id, cs_equation_builder_t *eqb)
Initialize a cs_hho_scaleq_t structure storing data useful for building and managing such a scheme.
Definition: cs_hho_scaleq.c:778
cs_hho_scaleq_write_restart
void cs_hho_scaleq_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_scaleq.c:1562
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:302
cs_hho_scaleq_build_system
void cs_hho_scaleq_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 *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:1078
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_matrix_assembler.h
cs_cdo_quantities.h
mesh
Definition: mesh.f90:26
cs_hho_scaleq_finalize_common
void cs_hho_scaleq_finalize_common(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_scaleq.c:739
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_scaleq_update_field
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:1319
cs_hho_scaleq_extra_op
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:1625
cs_hho_scaleq_init_common
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:608
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_hho_scaleq_get_cell_values
cs_real_t * cs_hho_scaleq_get_cell_values(void *data)
Get the computed values at cells (DoF used in the linear system are located at primal faces)
Definition: cs_hho_scaleq.c:1458
cs_field.h
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:87
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_time_step.h
cs_hho_scaleq_initialize_system
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:1033
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_hho_scaleq_get
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:716
cs_matrix.h
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
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_restart.h
cs_field_t
Field descriptor.
Definition: cs_field.h:124
cs_hho_scaleq_read_restart
void cs_hho_scaleq_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_scaleq.c:1480
cs_hho_scaleq_free_context
void * cs_hho_scaleq_free_context(void *data)
Destroy a cs_hho_scaleq_t structure.
Definition: cs_hho_scaleq.c:953
cs_mesh_t
Definition: cs_mesh.h:63
cs_base.h
cs_cdo_local.h
Generated on Thu Apr 9 2020 17:26:56 for My Project by   doxygen 1.8.16