programmer's documentation
cs_cdofb_ac.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_AC_H__
2 #define __CS_CDOFB_AC_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-2018 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_common.h"
45 #include "cs_equation_param.h"
46 #include "cs_field.h"
47 #include "cs_matrix.h"
48 #include "cs_mesh.h"
49 #include "cs_navsto_coupling.h"
50 #include "cs_navsto_param.h"
51 #include "cs_source_term.h"
52 #include "cs_time_step.h"
53 
54 /*----------------------------------------------------------------------------*/
55 
56 BEGIN_C_DECLS
57 
58 /*============================================================================
59  * Macro definitions
60  *============================================================================*/
61 
62 /*============================================================================
63  * Type definitions
64  *============================================================================*/
65 
66 /*============================================================================
67  * Public function prototypes
68  *============================================================================*/
69 
70 /*----------------------------------------------------------------------------*/
78 /*----------------------------------------------------------------------------*/
79 
80 void
81 cs_cdofb_ac_init_common(const cs_cdo_quantities_t *quant,
82  const cs_cdo_connect_t *connect,
83  const cs_time_step_t *time_step);
84 
85 /*----------------------------------------------------------------------------*/
94 /*----------------------------------------------------------------------------*/
95 
96 void *
97 cs_cdofb_ac_init_scheme_context(const cs_navsto_param_t *nsp,
98  void *nsc_input);
99 
100 /*----------------------------------------------------------------------------*/
108 /*----------------------------------------------------------------------------*/
109 
110 void *
111 cs_cdofb_ac_free_scheme_context(void *scheme_context);
112 
113 /*----------------------------------------------------------------------------*/
120 /*----------------------------------------------------------------------------*/
121 
122 void
123 cs_cdofb_ac_init_velocity(const cs_navsto_param_t *nsp,
124  void *scheme_context);
125 
126 /*----------------------------------------------------------------------------*/
133 /*----------------------------------------------------------------------------*/
134 
135 void
136 cs_cdofb_ac_init_pressure(const cs_navsto_param_t *nsp,
137  void *scheme_context);
138 
139 /*----------------------------------------------------------------------------*/
149 /*----------------------------------------------------------------------------*/
150 
151 void
152 cs_cdofb_ac_compute(const cs_mesh_t *mesh,
153  const cs_navsto_param_t *nsp,
154  double dt_cur,
155  void *scheme_context);
156 
157 /*----------------------------------------------------------------------------*/
165 /*----------------------------------------------------------------------------*/
166 
167 cs_real_t *
168 cs_cdofb_ac_get_face_velocity(void *scheme_context);
169 
170 /*----------------------------------------------------------------------------*/
171 
172 END_C_DECLS
173 
174 #endif /* __CS_CDOFB_AC_H__ */
cs_cdofb_ac_init_pressure
void cs_cdofb_ac_init_pressure(const cs_navsto_param_t *nsp, void *scheme_context)
Initialize the pressure values.
Definition: cs_cdofb_ac.c:330
cs_cdofb_ac_init_common
void cs_cdofb_ac_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_ac.c:205
cs_time_step_t
time step descriptor
Definition: cs_time_step.h:51
cs_cdofb_ac_get_face_velocity
cs_real_t * cs_cdofb_ac_get_face_velocity(void *scheme_context)
Retrieve the values of the velocity on the faces.
Definition: cs_cdofb_ac.c:456
cs_cdofb_ac_init_velocity
void cs_cdofb_ac_init_velocity(const cs_navsto_param_t *nsp, void *scheme_context)
Initialize the velocity values.
Definition: cs_cdofb_ac.c:309
cs_base.h
cs_cdo_connect.h
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:462
cs_cdofb_ac_init_scheme_context
void * cs_cdofb_ac_init_scheme_context(const cs_navsto_param_t *nsp, void *nsc_input)
Initialize a cs_cdofb_ac_t structure.
Definition: cs_cdofb_ac.c:237
cs_cdo_connect_t
Definition: cs_cdo_connect.h:74
cs_matrix.h
cs_cdofb_ac_compute
void cs_cdofb_ac_compute(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, double dt_cur, void *scheme_context)
Solve the Navier-Stokes system with a CDO face-based scheme using a Ac-Lagrangian Augmented approach...
Definition: cs_cdofb_ac.c:426
cs_source_term.h
cs_navsto_param_t
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:141
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:94
cs_mesh_t
Definition: cs_mesh.h:63
cs_navsto_param.h
cs_equation_common.h
cs_cdo_quantities.h
cs_field.h
cs_mesh.h
cs_time_step.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:463
cs_equation_param.h
Structure and routines handling the specific settings related to a cs_equation_t structure.
cs_cdofb_ac_free_scheme_context
void * cs_cdofb_ac_free_scheme_context(void *scheme_context)
Destroy a cs_cdofb_ac_t structure.
Definition: cs_cdofb_ac.c:283
cs_navsto_coupling.h
Routines to handle structures used as a context when solving the Navier-Stokes equations. Structures are cast on-the-fly according to the type of coupling. Routines to handle the settings of coupling algorithms.
mesh
Definition: mesh.f90:26
Generated on Sat Feb 2 2019 15:43:25 by   doxygen 1.8.13