8.3
general 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-2024 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_builder.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
51
52/*============================================================================
53 * Macro definitions
54 *============================================================================*/
55
56/*============================================================================
57 * Type definitions
58 *============================================================================*/
59
60/* Algebraic system for HHO discretization */
61typedef struct _cs_hho_scaleq_t cs_hho_scaleq_t;
62
63/*============================================================================
64 * Public function prototypes
65 *============================================================================*/
66
67/*----------------------------------------------------------------------------*/
78/*----------------------------------------------------------------------------*/
79
80void
82 const cs_cdo_quantities_t *quant,
83 const cs_cdo_connect_t *connect,
84 const cs_time_step_t *time_step);
85
86/*----------------------------------------------------------------------------*/
94/*----------------------------------------------------------------------------*/
95
96void
99 cs_hho_builder_t **hhob);
100
101/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
107void
109
110/*----------------------------------------------------------------------------*/
122/*----------------------------------------------------------------------------*/
123
124void *
126 int var_id,
127 int bflux_id,
129
130/*----------------------------------------------------------------------------*/
138/*----------------------------------------------------------------------------*/
139
140void *
142
143/*----------------------------------------------------------------------------*/
156/*----------------------------------------------------------------------------*/
157
158void
160 const int field_id,
161 const cs_mesh_t *mesh,
162 const cs_equation_param_t *eqp,
164 void *context);
165
166/*----------------------------------------------------------------------------*/
178/*----------------------------------------------------------------------------*/
179
180void
183 void *data,
184 cs_matrix_t **system_matrix,
185 cs_real_t **system_rhs);
186
187/*----------------------------------------------------------------------------*/
199/*----------------------------------------------------------------------------*/
200
201void
203 const cs_real_t *field_val,
204 const cs_equation_param_t *eqp,
206 void *context);
207
208/*----------------------------------------------------------------------------*/
220/*----------------------------------------------------------------------------*/
221
222void
224 const cs_real_t *rhs,
225 const cs_equation_param_t *eqp,
227 void *data,
228 cs_real_t *field_val);
229
230/*----------------------------------------------------------------------------*/
240/*----------------------------------------------------------------------------*/
241
242cs_real_t *
244 bool previous);
245
246/*----------------------------------------------------------------------------*/
256/*----------------------------------------------------------------------------*/
257
258cs_real_t *
260 bool previous);
261
262/*----------------------------------------------------------------------------*/
271/*----------------------------------------------------------------------------*/
272
273void
275 const char *eqname,
276 void *scheme_context);
277
278/*----------------------------------------------------------------------------*/
287/*----------------------------------------------------------------------------*/
288
289void
291 const char *eqname,
292 void *scheme_context);
293
294/*----------------------------------------------------------------------------*/
302/*----------------------------------------------------------------------------*/
303
304void
307 void *context);
308
309/*----------------------------------------------------------------------------*/
310
312
313#endif /* __CS_HHO_SCALEQ_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543
unsigned short int cs_flag_t
Definition: cs_defs.h:344
cs_real_t * cs_hho_scaleq_get_cell_values(void *context, bool previous)
Get the computed values at cells (DoF used in the linear system are located at primal faces)
Definition: cs_hho_scaleq.cpp:1495
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.cpp:696
cs_real_t * cs_hho_scaleq_get_face_values(void *context, bool previous)
Get the computed values at faces (DoF used in the linear system are located at primal faces)
Definition: cs_hho_scaleq.cpp:1468
void cs_hho_scaleq_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_scaleq.cpp:1665
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.cpp:1521
void * cs_hho_scaleq_free_context(void *data)
Destroy a cs_hho_scaleq_t structure.
Definition: cs_hho_scaleq.cpp:956
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.cpp:994
void cs_hho_scaleq_finalize_sharing(void)
Free buffers and generic structures related to HHO schemes.
Definition: cs_hho_scaleq.cpp:719
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 *context)
Build the linear system arising from a scalar convection/diffusion equation with a HHO scheme....
Definition: cs_hho_scaleq.cpp:1087
void * cs_hho_scaleq_init_context(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.cpp:758
void cs_hho_scaleq_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_scaleq.cpp:594
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.cpp:1044
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.cpp:1604
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.cpp:1354
struct _cs_matrix_t cs_matrix_t
Definition: cs_matrix.h:110
struct _cs_restart_t cs_restart_t
Definition: cs_restart.h:95
double precision, dimension(:,:), pointer solu
Definition: atincl.f90:308
Definition: mesh.f90:26
Definition: cs_cdo_connect.h:61
Definition: cs_cdo_quantities.h:139
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
Definition: cs_hho_builder.h:54
Definition: cs_mesh.h:85
time step descriptor
Definition: cs_time_step.h:64