8.1
general documentation
cs_cdofb_monolithic_sles.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_MONOLITHIC_SLES_H__
2 #define __CS_CDOFB_MONOLITHIC_SLES_H__
3 
4 /*============================================================================
5  * Functions dedicated to the linear algebra settings and operations in case
6  * of CDO face-based schemes with a monolithic velocity-pressure coupling
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 
31 #include "cs_defs.h"
32 
33 /*----------------------------------------------------------------------------
34  * Standard C library headers
35  *----------------------------------------------------------------------------*/
36 
37 /*----------------------------------------------------------------------------
38  * Local headers
39  *----------------------------------------------------------------------------*/
40 
41 #include "cs_cdofb_monolithic_priv.h"
42 
43 /*----------------------------------------------------------------------------*/
44 
45 BEGIN_C_DECLS
46 
47 /*============================================================================
48  * Macro definitions
49  *============================================================================*/
50 
51 /*============================================================================
52  * Type definitions
53  *============================================================================*/
54 
55 /*============================================================================
56  * Public function prototypes
57  *============================================================================*/
58 
59 /*----------------------------------------------------------------------------*/
68 /*----------------------------------------------------------------------------*/
69 
70 cs_cdofb_monolithic_sles_t *
71 cs_cdofb_monolithic_sles_create(cs_lnum_t n_faces,
72  cs_lnum_t n_cells);
73 
74 /*----------------------------------------------------------------------------*/
80 /*----------------------------------------------------------------------------*/
81 
82 void
83 cs_cdofb_monolithic_sles_clean(cs_cdofb_monolithic_sles_t *msles);
84 
85 /*----------------------------------------------------------------------------*/
91 /*----------------------------------------------------------------------------*/
92 
93 void
94 cs_cdofb_monolithic_sles_free(cs_cdofb_monolithic_sles_t **p_msles);
95 
96 /*----------------------------------------------------------------------------*/
104 /*----------------------------------------------------------------------------*/
105 
106 void
107 cs_cdofb_monolithic_sles_init_sharing(const cs_mesh_t *mesh,
108  const cs_cdo_connect_t *connect,
109  const cs_cdo_quantities_t *quant);
110 
111 /*----------------------------------------------------------------------------*/
116 /*----------------------------------------------------------------------------*/
117 
118 void
119 cs_cdofb_monolithic_sles_finalize(void);
120 
121 /*----------------------------------------------------------------------------*/
132 /*----------------------------------------------------------------------------*/
133 
134 void
135 cs_cdofb_monolithic_set_sles(cs_navsto_param_t *nsp,
136  void *context);
137 
138 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 int
156 cs_cdofb_monolithic_solve(const cs_navsto_param_t *nsp,
157  const cs_equation_param_t *eqp,
158  const cs_cdo_system_helper_t *sh,
159  cs_param_sles_t *slesp,
160  cs_cdofb_monolithic_sles_t *msles);
161 
162 /*----------------------------------------------------------------------------*/
178 /*----------------------------------------------------------------------------*/
179 
180 int
181 cs_cdofb_monolithic_block_krylov(const cs_navsto_param_t *nsp,
182  const cs_equation_param_t *eqp,
183  const cs_cdo_system_helper_t *sh,
184  cs_param_sles_t *slesp,
185  cs_cdofb_monolithic_sles_t *msles);
186 
187 /*----------------------------------------------------------------------------*/
201 /*----------------------------------------------------------------------------*/
202 
203 int
204 cs_cdofb_monolithic_gkb_solve(const cs_navsto_param_t *nsp,
205  const cs_equation_param_t *eqp,
206  const cs_cdo_system_helper_t *sh,
207  cs_param_sles_t *slesp,
208  cs_cdofb_monolithic_sles_t *msles);
209 
210 /*----------------------------------------------------------------------------*/
227 /*----------------------------------------------------------------------------*/
228 
229 int
230 cs_cdofb_monolithic_uzawa_cg_solve(const cs_navsto_param_t *nsp,
231  const cs_equation_param_t *eqp,
232  const cs_cdo_system_helper_t *sh,
233  cs_param_sles_t *slesp,
234  cs_cdofb_monolithic_sles_t *msles);
235 
236 /*----------------------------------------------------------------------------*/
251 /*----------------------------------------------------------------------------*/
252 
253 int
254 cs_cdofb_monolithic_uzawa_al_incr_solve(const cs_navsto_param_t *nsp,
255  const cs_equation_param_t *eqp,
256  const cs_cdo_system_helper_t *sh,
257  cs_param_sles_t *slesp,
258  cs_cdofb_monolithic_sles_t *msles);
259 
260 /*----------------------------------------------------------------------------*/
261 
262 END_C_DECLS
263 
264 #endif /* __CS_CDOFB_MONOLITHIC_SLES_H__ */
cs_cdofb_monolithic_priv.h
Structures and function pointers useful to build and solve the Navier-Stokes equations with face-base...
cs_cdofb_monolithic_sles_clean
void cs_cdofb_monolithic_sles_clean(cs_cdofb_monolithic_sles_t *msles)
Free a part of the structure.
Definition: cs_cdofb_monolithic_sles.c:3977
cs_cdofb_monolithic_uzawa_cg_solve
int cs_cdofb_monolithic_uzawa_cg_solve(const cs_navsto_param_t *nsp, const cs_equation_param_t *eqp, const cs_cdo_system_helper_t *sh, cs_param_sles_t *slesp, cs_cdofb_monolithic_sles_t *msles)
Use the preconditioned Uzawa-CG algorithm to solve the saddle-point problem arising from CDO-Fb schem...
Definition: cs_cdofb_monolithic_sles.c:4908
cs_cdofb_monolithic_solve
int cs_cdofb_monolithic_solve(const cs_navsto_param_t *nsp, const cs_equation_param_t *eqp, const cs_cdo_system_helper_t *sh, cs_param_sles_t *slesp, cs_cdofb_monolithic_sles_t *msles)
Solve a linear system arising from the discretization of the Navier-Stokes equation with a CDO face-b...
Definition: cs_cdofb_monolithic_sles.c:4317
cs_cdofb_monolithic_uzawa_al_incr_solve
int cs_cdofb_monolithic_uzawa_al_incr_solve(const cs_navsto_param_t *nsp, const cs_equation_param_t *eqp, const cs_cdo_system_helper_t *sh, cs_param_sles_t *slesp, cs_cdofb_monolithic_sles_t *msles)
Use the Uzawa algorithm with an Augmented Lagrangian (ALU) technique in an incremental way to solve t...
Definition: cs_cdofb_monolithic_sles.c:5250
cs_cdofb_monolithic_sles_finalize
void cs_cdofb_monolithic_sles_finalize(void)
Free if needed structure(s) associated CDO face-based schemes with a monolithic velocity-pressure cou...
Definition: cs_cdofb_monolithic_sles.c:4042
cs_cdofb_monolithic_set_sles
void cs_cdofb_monolithic_set_sles(cs_navsto_param_t *nsp, void *context)
Start setting-up the Navier-Stokes equations when a monolithic algorithm is used to couple the system...
Definition: cs_cdofb_monolithic_sles.c:4062
cs_cdofb_monolithic_sles_init_sharing
void cs_cdofb_monolithic_sles_init_sharing(const cs_mesh_t *mesh, const cs_cdo_connect_t *connect, const cs_cdo_quantities_t *quant)
Set pointers to shared structures.
Definition: cs_cdofb_monolithic_sles.c:4023
cs_cdofb_monolithic_sles_free
void cs_cdofb_monolithic_sles_free(cs_cdofb_monolithic_sles_t **p_msles)
Free memory related to cs_cdofb_monolithic_sles_t structure.
Definition: cs_cdofb_monolithic_sles.c:3995
cs_cdofb_monolithic_sles_create
cs_cdofb_monolithic_sles_t * cs_cdofb_monolithic_sles_create(cs_lnum_t n_faces, cs_lnum_t n_cells)
Create an empty cs_cdofb_monolithic_sles_t structure.
Definition: cs_cdofb_monolithic_sles.c:3945
cs_cdofb_monolithic_gkb_solve
int cs_cdofb_monolithic_gkb_solve(const cs_navsto_param_t *nsp, const cs_equation_param_t *eqp, const cs_cdo_system_helper_t *sh, cs_param_sles_t *slesp, cs_cdofb_monolithic_sles_t *msles)
Use the GKB algorithm to solve the saddle-point problem arising from CDO-Fb schemes for Stokes and Na...
Definition: cs_cdofb_monolithic_sles.c:4741
cs_cdofb_monolithic_block_krylov
int cs_cdofb_monolithic_block_krylov(const cs_navsto_param_t *nsp, const cs_equation_param_t *eqp, const cs_cdo_system_helper_t *sh, cs_param_sles_t *slesp, cs_cdofb_monolithic_sles_t *msles)
Solve a linear system arising from the discretization of the Navier-Stokes equation with a CDO face-b...
Definition: cs_cdofb_monolithic_sles.c:4526
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:515
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
mesh
Definition: mesh.f90:26
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:137
cs_cdo_system_helper_t
Definition: cs_cdo_system.h:377
cs_cdofb_monolithic_sles_t
Definition: cs_cdofb_monolithic_priv.h:77
cs_equation_param_t
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:192
cs_mesh_t
Definition: cs_mesh.h:85
cs_navsto_param_t
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:611
cs_param_sles_t
Structure storing all metadata related to the resolution of a linear system with an iterative solver.
Definition: cs_param_sles.h:213