9.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-2026 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 "alge/cs_matrix.h"
34#include "alge/cs_matrix_assembler.h"
35#include "base/cs_base.h"
36#include "base/cs_field.h"
37#include "base/cs_restart.h"
38#include "base/cs_time_step.h"
39#include "cdo/cs_cdo_connect.h"
40#include "cdo/cs_cdo_local.h"
41#include "cdo/cs_cdo_quantities.h"
42#include "cdo/cs_equation_builder.h"
43#include "cdo/cs_equation_param.h"
44#include "cdo/cs_hho_builder.h"
45#include "cdo/cs_source_term.h"
46#include "mesh/cs_mesh.h"
47
48/*============================================================================
49 * Macro definitions
50 *============================================================================*/
51
52/*============================================================================
53 * Type definitions
54 *============================================================================*/
55
56/* Algebraic system for HHO discretization */
57typedef struct _cs_hho_vecteq_t cs_hho_vecteq_t;
58
59/*============================================================================
60 * Public function prototypes
61 *============================================================================*/
62
63/*----------------------------------------------------------------------------*/
74/*----------------------------------------------------------------------------*/
75
76void
77cs_hho_vecteq_init_sharing(cs_flag_t scheme_flag,
78 const cs_cdo_quantities_t *quant,
79 const cs_cdo_connect_t *connect,
80 const cs_time_step_t *time_step);
81
82/*----------------------------------------------------------------------------*/
90/*----------------------------------------------------------------------------*/
91
92void
93cs_hho_vecteq_get(cs_cell_sys_t **csys,
94 cs_cell_builder_t **cb,
95 cs_hho_builder_t **hhob);
96
97/*----------------------------------------------------------------------------*/
101/*----------------------------------------------------------------------------*/
102
103void
104cs_hho_vecteq_finalize_sharing(void);
105
106/*----------------------------------------------------------------------------*/
118/*----------------------------------------------------------------------------*/
119
120void *
121cs_hho_vecteq_init_context(cs_equation_param_t *eqp,
122 int var_id,
123 int bflux_id,
124 cs_equation_builder_t *eqb);
125
126/*----------------------------------------------------------------------------*/
134/*----------------------------------------------------------------------------*/
135
136void *
137cs_hho_vecteq_free_context(void *data);
138
139/*----------------------------------------------------------------------------*/
152/*----------------------------------------------------------------------------*/
153
154void
155cs_hho_vecteq_init_values(cs_real_t t_eval,
156 const int field_id,
157 const cs_mesh_t *mesh,
158 const cs_equation_param_t *eqp,
159 cs_equation_builder_t *eqb,
160 void *context);
161
162/*----------------------------------------------------------------------------*/
170/*----------------------------------------------------------------------------*/
171
172void
173cs_hho_vecteq_compute_source(const cs_equation_param_t *eqp,
174 cs_equation_builder_t *eqb,
175 void *data);
176
177/*----------------------------------------------------------------------------*/
189/*----------------------------------------------------------------------------*/
190
191void
192cs_hho_vecteq_build_system(const cs_mesh_t *mesh,
193 const cs_real_t *field_val,
194 const cs_equation_param_t *eqp,
195 cs_equation_builder_t *eqb,
196 void *context);
197
198/*----------------------------------------------------------------------------*/
210/*----------------------------------------------------------------------------*/
211
212void
213cs_hho_vecteq_update_field(const cs_real_t *solu,
214 const cs_real_t *rhs,
215 const cs_equation_param_t *eqp,
216 cs_equation_builder_t *eqb,
217 void *data,
218 cs_real_t *field_val);
219
220/*----------------------------------------------------------------------------*/
230/*----------------------------------------------------------------------------*/
231
232cs_real_t *
233cs_hho_vecteq_get_face_values(void *data,
234 bool previous);
235
236/*----------------------------------------------------------------------------*/
246/*----------------------------------------------------------------------------*/
247
248cs_real_t *
249cs_hho_vecteq_get_cell_values(void *data,
250 bool previous);
251
252/*----------------------------------------------------------------------------*/
261/*----------------------------------------------------------------------------*/
262
263void
264cs_hho_vecteq_read_restart(cs_restart_t *restart,
265 const char *eqname,
266 void *scheme_context);
267
268/*----------------------------------------------------------------------------*/
277/*----------------------------------------------------------------------------*/
278
279void
280cs_hho_vecteq_write_restart(cs_restart_t *restart,
281 const char *eqname,
282 void *scheme_context);
283
284/*----------------------------------------------------------------------------*/
292/*----------------------------------------------------------------------------*/
293
294void
295cs_hho_vecteq_extra_post(const cs_equation_param_t *eqp,
296 cs_equation_builder_t *eqb,
297 void *context);
298
299#endif /* CS_HHO_VECTEQ_H */
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:60
cs_base.h
cs_cdo_connect.h
cs_cdo_local.h
cs_cdo_quantities.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_flag_t
unsigned short int cs_flag_t
Definition: cs_defs.h:334
cs_equation_builder.h
cs_equation_param.h
cs_field.h
cs_hho_builder.h
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.cpp:1389
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.cpp:1516
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.cpp:1569
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.cpp:686
cs_hho_vecteq_free_context
void * cs_hho_vecteq_free_context(void *data)
Destroy a cs_hho_vecteq_t structure.
Definition: cs_hho_vecteq.cpp:924
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.cpp:1543
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....
Definition: cs_hho_vecteq.cpp:962
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.cpp:1652
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.cpp:1713
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.cpp:584
cs_hho_vecteq_init_context
void * cs_hho_vecteq_init_context(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.cpp:743
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.cpp:1008
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.cpp:704
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.cpp:1100
cs_matrix.h
cs_matrix_assembler.h
cs_mesh.h
cs_restart.h
cs_restart_t
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:91
cs_source_term.h
cs_time_step.h
atincl::solu
double precision, dimension(:,:), pointer solu
Definition: atincl.f90:260
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:57
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:142
cs_cell_builder_t
Set of local and temporary buffers.
Definition: cs_cdo_local.h:56
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:163
cs_equation_builder_t
Store common elements used when building an algebraic system related to an equation.
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:190
cs_hho_builder_t
Definition: cs_hho_builder.h:50
cs_mesh_t
Definition: cs_mesh.h:85