programmer's documentation
cs_cdofb_navsto.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_NAVSTO_H__
2 #define __CS_CDOFB_NAVSTO_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO face-based system for unsteady convection/diffusion
6  * reaction of vector-valued equations with source terms
7  *============================================================================*/
8 
9 /*
10  This file is part of Code_Saturne, a general-purpose CFD tool.
11 
12  Copyright (C) 1998-2017 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_param.h"
50 #include "cs_source_term.h"
51 #include "cs_time_step.h"
52 
53 /*----------------------------------------------------------------------------*/
54 
56 
57 /*============================================================================
58  * Macro definitions
59  *============================================================================*/
60 
61 /*============================================================================
62  * Type definitions
63  *============================================================================*/
64 
65 /*============================================================================
66  * Public function prototypes
67  *============================================================================*/
68 
69 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86  const cs_cdo_connect_t *connect,
87  const cs_time_step_t *time_step,
88  const cs_matrix_structure_t *sms,
89  const cs_matrix_structure_t *vms);
90 
91 /*----------------------------------------------------------------------------*/
99 /*----------------------------------------------------------------------------*/
100 
101 void
103  const void *nsc_input);
104 
105 /*----------------------------------------------------------------------------*/
113 /*----------------------------------------------------------------------------*/
114 
115 void
117  const void *nsc_input);
118 
119 /*----------------------------------------------------------------------------*/
127 /*----------------------------------------------------------------------------*/
128 
129 void
131  const void *nsc_input);
132 
133 /*----------------------------------------------------------------------------*/
141 /*----------------------------------------------------------------------------*/
142 
143 void
145  const void *nsc_input);
146 
147 /*----------------------------------------------------------------------------*/
153 /*----------------------------------------------------------------------------*/
154 
155 void
157 
158 /*----------------------------------------------------------------------------*/
169 /*----------------------------------------------------------------------------*/
170 
171 void
173  double dt_cur,
174  const cs_navsto_param_t *nsp,
175  void *nsc_input);
176 
177 /*----------------------------------------------------------------------------*/
188 /*----------------------------------------------------------------------------*/
189 
190 void
192  double dt_cur,
193  const cs_navsto_param_t *nsp,
194  void *nsc_input);
195 
196 /*----------------------------------------------------------------------------*/
207 /*----------------------------------------------------------------------------*/
208 
209 void
211  double dt_cur,
212  const cs_navsto_param_t *nsp,
213  void *nsc_input);
214 
215 /*----------------------------------------------------------------------------*/
226 /*----------------------------------------------------------------------------*/
227 
228 void
230  double dt_cur,
231  const cs_navsto_param_t *nsp,
232  void *nsc_input);
233 
234 /*----------------------------------------------------------------------------*/
246 /*----------------------------------------------------------------------------*/
247 
248 void
250  const cs_real_t *rhs,
251  const cs_equation_param_t *eqp,
253  void *data,
254  cs_real_t *field_val);
255 
256 /*----------------------------------------------------------------------------*/
266 /*----------------------------------------------------------------------------*/
267 
268 void
269 cs_cdofb_navsto_extra_op(const char *eqname,
270  const cs_field_t *field,
271  const cs_equation_param_t *eqp,
273  void *data);
274 
275 /*----------------------------------------------------------------------------*/
276 
278 
279 #endif /* __CS_CDOFB_NAVSTO_H__ */
Store common elements used when building an algebraic system related to an equation.
Definition: cs_equation_common.h:62
void cs_cdofb_navsto_uzawa_compute(const cs_mesh_t *mesh, double dt_cur, const cs_navsto_param_t *nsp, void *nsc_input)
Solve the Navier-Stokes system with a CDO face-based scheme using a Uzawa-Lagrangian Augmented approa...
Definition: cs_cdofb_navsto.c:444
void cs_cdofb_navsto_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 if required (...
Definition: cs_cdofb_navsto.c:578
time step descriptor
Definition: cs_time_step.h:51
void cs_cdofb_navsto_extra_op(const char *eqname, const cs_field_t *field, const cs_equation_param_t *eqp, cs_equation_builder_t *eqb, void *data)
Predefined extra-operations related to this equation.
Definition: cs_cdofb_navsto.c:608
void cs_cdofb_navsto_init_ac_vpp_context(const cs_navsto_param_t *nsp, const void *nsc_input)
Initialize a cs_cdofb_navsto_t structure storing in the case of an Artificial Compressibility - VPP a...
Definition: cs_cdofb_navsto.c:344
void cs_cdofb_navsto_init_ac_context(const cs_navsto_param_t *nsp, const void *nsc_input)
Initialize a cs_cdofb_navsto_t structure storing in the case of an Artificial Compressibility approac...
Definition: cs_cdofb_navsto.c:309
Field descriptor.
Definition: cs_field.h:124
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources...
Definition: cs_equation_param.h:150
void cs_cdofb_navsto_init_proj_context(const cs_navsto_param_t *nsp, const void *nsc_input)
Initialize a cs_cdofb_navsto_t structure storing in the case of an incremental Projection approach...
Definition: cs_cdofb_navsto.c:380
void cs_cdofb_navsto_init_common(const cs_cdo_quantities_t *quant, const cs_cdo_connect_t *connect, const cs_time_step_t *time_step, const cs_matrix_structure_t *sms, const cs_matrix_structure_t *vms)
Set shared pointers from the main domain members for CDO face-based schemes.
Definition: cs_cdofb_navsto.c:250
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
void cs_cdofb_navsto_proj_compute(const cs_mesh_t *mesh, double dt_cur, const cs_navsto_param_t *nsp, void *nsc_input)
Solve the Navier-Stokes system with a CDO face-based scheme using an incremental correction-projectio...
Definition: cs_cdofb_navsto.c:544
Definition: cs_cdo_connect.h:69
void cs_cdofb_navsto_init_uzawa_context(const cs_navsto_param_t *nsp, const void *nsc_input)
Initialize a cs_cdofb_navsto_t structure storing in the case of a Uzawa-Augmented Lagrangian approach...
Definition: cs_cdofb_navsto.c:283
Definition: field.f90:27
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:129
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_cdofb_navsto_ac_vpp_compute(const cs_mesh_t *mesh, double dt_cur, const cs_navsto_param_t *nsp, void *nsc_input)
Solve the Navier-Stokes system with a CDO face-based scheme using an Artificial Compressibility - VPP...
Definition: cs_cdofb_navsto.c:510
Definition: cs_cdo_quantities.h:94
void cs_cdofb_navsto_ac_compute(const cs_mesh_t *mesh, double dt_cur, const cs_navsto_param_t *nsp, void *nsc_input)
Solve the Navier-Stokes system with a CDO face-based scheme using an Artificial Compressibility appro...
Definition: cs_cdofb_navsto.c:476
Definition: cs_mesh.h:63
void cs_cdofb_navsto_free_context(const cs_navsto_param_t *nsp)
Destroy a cs_cdofb_navsto_t structure.
Definition: cs_cdofb_navsto.c:414
#define END_C_DECLS
Definition: cs_defs.h:462
Structure and routines handling the specific settings related to a cs_equation_t structure.
struct _cs_matrix_structure_t cs_matrix_structure_t
Definition: cs_matrix.h:86
Definition: mesh.f90:26