My Project
programmer's documentation
cs_cdofb_predco.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_PREDCO_H__
2 #define __CS_CDOFB_PREDCO_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_coupling.h"
47 #include "cs_navsto_param.h"
48 #include "cs_source_term.h"
49 #include "cs_time_step.h"
50 
51 /*----------------------------------------------------------------------------*/
52 
54 
55 /*============================================================================
56  * Macro definitions
57  *============================================================================*/
58 
59 /*============================================================================
60  * Type definitions
61  *============================================================================*/
62 
63 /*============================================================================
64  * Public function prototypes
65  *============================================================================*/
66 
67 /*----------------------------------------------------------------------------*/
75 /*----------------------------------------------------------------------------*/
76 
77 cs_real_t *
79 
80 /*----------------------------------------------------------------------------*/
88 /*----------------------------------------------------------------------------*/
89 
90 void
92  const cs_cdo_connect_t *connect,
93  const cs_time_step_t *time_step);
94 
95 /*----------------------------------------------------------------------------*/
105 /*----------------------------------------------------------------------------*/
106 
107 void *
109  cs_boundary_type_t *fb_type,
110  void *nsc_input);
111 
112 /*----------------------------------------------------------------------------*/
120 /*----------------------------------------------------------------------------*/
121 
122 void *
123 cs_cdofb_predco_free_scheme_context(void *scheme_context);
124 
125 /*----------------------------------------------------------------------------*/
134 /*----------------------------------------------------------------------------*/
135 
136 void
138  void *context);
139 
140 /*----------------------------------------------------------------------------*/
149 /*----------------------------------------------------------------------------*/
150 
151 void
153  const cs_navsto_param_t *nsp,
154  void *scheme_context);
155 
156 /*----------------------------------------------------------------------------*/
165 /*----------------------------------------------------------------------------*/
166 
167 void
169  const cs_navsto_param_t *nsp,
170  void *scheme_context);
171 
172 /*----------------------------------------------------------------------------*/
173 
175 
176 #endif /* __CS_CDOFB_PREDCO_H__ */
cs_boundary_type_t
cs_boundary_type_t
Definition: cs_boundary.h:51
cs_cdofb_predco_set_sles
void cs_cdofb_predco_set_sles(const cs_navsto_param_t *nsp, void *context)
Start setting-up the Navier-Stokes equations when an AC algorithm is used to couple the system....
Definition: cs_cdofb_predco.c:1001
cs_defs.h
cs_navsto_param_t
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:255
cs_source_term.h
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_navsto_param.h
cs_cdo_quantities.h
mesh
Definition: mesh.f90:26
cs_mesh.h
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_cdofb_predco_compute_theta
void cs_cdofb_predco_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 Artificial Compressibili...
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
cs_cdofb_predco_compute_implicit
void cs_cdofb_predco_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 Artificial Compressibili...
Definition: cs_cdofb_predco.c:1062
cs_cdofb_predco_init_common
void cs_cdofb_predco_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_predco.c:837
cs_cdo_connect.h
cs_cdofb_predco_free_scheme_context
void * cs_cdofb_predco_free_scheme_context(void *scheme_context)
Destroy a cs_cdofb_predco_t structure.
Definition: cs_cdofb_predco.c:970
cs_time_step.h
cs_equation.h
cs_navsto_coupling.h
Routines to handle structures used as a context when solving the Navier-Stokes equations....
cs_cdofb_predco_init_scheme_context
void * cs_cdofb_predco_init_scheme_context(const cs_navsto_param_t *nsp, cs_boundary_type_t *fb_type, void *nsc_input)
Initialize a cs_cdofb_predco_t structure.
Definition: cs_cdofb_predco.c:868
cs_cdofb_predco_get_face_pressure
cs_real_t * cs_cdofb_predco_get_face_pressure(void *context)
Retrieve the values of the pressure at faces.
Definition: cs_cdofb_predco.c:816
cs_mesh_t
Definition: cs_mesh.h:63
cs_base.h