My Project
programmer's documentation
cs_cdofb_uzawa.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_UZAWA_H__
2 #define __CS_CDOFB_UZAWA_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO face-based system for the Navier-Stokes equations
6  * and solved it with an Augmented Lagrangian-Uzawa algorithm
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 
31 #include "cs_defs.h"
32 
33 /*----------------------------------------------------------------------------
34  * Standard C library headers
35  *----------------------------------------------------------------------------*/
36 
37 /*----------------------------------------------------------------------------
38  * Local headers
39  *----------------------------------------------------------------------------*/
40 
41 #include "cs_base.h"
42 #include "cs_cdo_connect.h"
43 #include "cs_cdo_quantities.h"
44 #include "cs_equation.h"
45 #include "cs_mesh.h"
46 #include "cs_navsto_param.h"
47 #include "cs_time_step.h"
48 
49 /*----------------------------------------------------------------------------*/
50 
52 
53 /*============================================================================
54  * Macro definitions
55  *============================================================================*/
56 
57 /*============================================================================
58  * Type definitions
59  *============================================================================*/
60 
61 /*============================================================================
62  * Static inline public function prototypes
63  *============================================================================*/
64 
65 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 inline static cs_real_t *
76 cs_cdofb_uzawa_get_face_velocity(void *scheme_context)
77 {
78  CS_UNUSED(scheme_context);
79 
81 }
82 
83 /*============================================================================
84  * Public function prototypes
85  *============================================================================*/
86 
87 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
99  const cs_cdo_connect_t *connect,
100  const cs_time_step_t *time_step);
101 
102 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void *
116  cs_boundary_type_t *fb_type,
117  void *nsc_input);
118 
119 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 void *
130 cs_cdofb_uzawa_free_scheme_context(void *scheme_context);
131 
132 /*----------------------------------------------------------------------------*/
141 /*----------------------------------------------------------------------------*/
142 
143 void
145  void *context);
146 
147 /*----------------------------------------------------------------------------*/
156 /*----------------------------------------------------------------------------*/
157 
158 void
160  const cs_navsto_param_t *nsp,
161  void *scheme_context);
162 
163 /*----------------------------------------------------------------------------*/
172 /*----------------------------------------------------------------------------*/
173 
174 void
176  const cs_navsto_param_t *nsp,
177  void *scheme_context);
178 
179 /*----------------------------------------------------------------------------*/
188 /*----------------------------------------------------------------------------*/
189 
190 void
192  const cs_navsto_param_t *nsp,
193  void *scheme_context);
194 
195 /*----------------------------------------------------------------------------*/
205 /*----------------------------------------------------------------------------*/
206 
207 void
209  const cs_navsto_param_t *nsp,
210  void *scheme_context);
211 
212 /*----------------------------------------------------------------------------*/
213 
215 
216 #endif /* __CS_CDOFB_UZAWA_H__ */
cs_boundary_type_t
cs_boundary_type_t
Definition: cs_boundary.h:51
cs_defs.h
cs_cdofb_uzawa_compute_implicit
void cs_cdofb_uzawa_compute_implicit(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the unsteady Navier-Stokes system with a CDO face-based scheme using a Uzawa-Lagrangian Augment...
Definition: cs_cdofb_uzawa.c:1640
cs_cdofb_uzawa_get_face_velocity
static cs_real_t * cs_cdofb_uzawa_get_face_velocity(void *scheme_context)
Retrieve the values of the velocity on the faces.
Definition: cs_cdofb_uzawa.h:76
cs_navsto_param_t
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:255
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_cdofb_uzawa_compute_steady
void cs_cdofb_uzawa_compute_steady(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the steady Navier-Stokes system with a CDO face-based scheme using a Uzawa-Lagrangian Augmented...
Definition: cs_cdofb_uzawa.c:1196
cs_navsto_param.h
cs_cdo_quantities.h
mesh
Definition: mesh.f90:26
cs_cdofb_uzawa_init_common
void cs_cdofb_uzawa_init_common(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step)
Set shared pointers from the main domain members.
Definition: cs_cdofb_uzawa.c:988
cs_mesh.h
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
cs_cdo_connect.h
cs_time_step.h
CS_UNUSED
#define CS_UNUSED(x)
Definition: cs_defs.h:453
cs_equation_get_face_values
cs_real_t * cs_equation_get_face_values(const cs_equation_t *eq)
For a given equation, retrieve an array of values related to each face of the mesh for the unknowns.
Definition: cs_equation.c:2361
cs_cdofb_uzawa_init_scheme_context
void * cs_cdofb_uzawa_init_scheme_context(const cs_navsto_param_t *nsp, cs_boundary_type_t *fb_type, void *nsc_input)
Initialize a cs_cdofb_uzawa_t structure.
Definition: cs_cdofb_uzawa.c:1016
cs_cdofb_uzawa_compute_theta
void cs_cdofb_uzawa_compute_theta(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the unsteady Navier-Stokes system with a CDO face-based scheme using a Uzawa-Lagrangian Augment...
Definition: cs_cdofb_uzawa.c:2105
cs_cdofb_uzawa_compute_steady_rebuild
void cs_cdofb_uzawa_compute_steady_rebuild(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the steady Navier-Stokes system with a CDO face-based scheme using a Uzawa-Lagrangian Augmented...
Definition: cs_cdofb_uzawa.c:2617
cs_equation_by_name
cs_equation_t * cs_equation_by_name(const char *eqname)
Find the cs_equation_t structure with name eqname Return NULL if not find.
Definition: cs_equation.c:350
cs_equation.h
cs_mesh_t
Definition: cs_mesh.h:63
cs_cdofb_uzawa_set_sles
void cs_cdofb_uzawa_set_sles(const cs_navsto_param_t *nsp, void *context)
Start setting-up the Navier-Stokes equations when an ALU algorithm is used to couple the system....
Definition: cs_cdofb_uzawa.c:1141
cs_base.h
cs_cdofb_uzawa_free_scheme_context
void * cs_cdofb_uzawa_free_scheme_context(void *scheme_context)
Destroy a cs_cdofb_uzawa_t structure.
Definition: cs_cdofb_uzawa.c:1113