8.0
general documentation
cs_cdofb_monolithic.h
Go to the documentation of this file.
1 #ifndef __CS_CDOFB_MONOLITHIC_H__
2 #define __CS_CDOFB_MONOLITHIC_H__
3 
4 /*============================================================================
5  * Build an algebraic CDO face-based system for the Navier-Stokes equations
6  * and solved it as one block (monolithic approach of the velocity-pressure
7  * coupling)
8  *============================================================================*/
9 
10 /*
11  This file is part of code_saturne, a general-purpose CFD tool.
12 
13  Copyright (C) 1998-2023 EDF S.A.
14 
15  This program is free software; you can redistribute it and/or modify it under
16  the terms of the GNU General Public License as published by the Free Software
17  Foundation; either version 2 of the License, or (at your option) any later
18  version.
19 
20  This program is distributed in the hope that it will be useful, but WITHOUT
21  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
22  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
23  details.
24 
25  You should have received a copy of the GNU General Public License along with
26  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
27  Street, Fifth Floor, Boston, MA 02110-1301, USA.
28 */
29 
30 /*----------------------------------------------------------------------------*/
31 
32 #include "cs_defs.h"
33 
34 /*----------------------------------------------------------------------------
35  * Standard C library headers
36  *----------------------------------------------------------------------------*/
37 
38 /*----------------------------------------------------------------------------
39  * Local headers
40  *----------------------------------------------------------------------------*/
41 
42 #include "cs_base.h"
43 #include "cs_cdo_connect.h"
44 #include "cs_cdo_quantities.h"
45 #include "cs_equation.h"
46 #include "cs_mesh.h"
47 #include "cs_navsto_param.h"
48 #include "cs_time_step.h"
49 
50 /*----------------------------------------------------------------------------*/
51 
52 BEGIN_C_DECLS
53 
54 /*============================================================================
55  * Macro definitions
56  *============================================================================*/
57 
58 /*============================================================================
59  * Type definitions
60  *============================================================================*/
61 
62 /*============================================================================
63  * Static inline public function prototypes
64  *============================================================================*/
65 
66 /*----------------------------------------------------------------------------*/
74 /*----------------------------------------------------------------------------*/
75 
76 inline static cs_real_t *
77 cs_cdofb_monolithic_get_face_velocity(bool previous)
78 {
79  return cs_equation_get_face_values(cs_equation_by_name("momentum"),
80  previous);
81 }
82 
83 /*============================================================================
84  * Public function prototypes
85  *============================================================================*/
86 
87 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
100 cs_cdofb_monolithic_init_sharing(const cs_navsto_param_t *nsp,
101  const cs_mesh_t *mesh,
102  const cs_cdo_quantities_t *quant,
103  const cs_cdo_connect_t *connect,
104  const cs_time_step_t *time_step);
105 
106 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void
115 cs_cdofb_monolithic_finalize_common(const cs_navsto_param_t *nsp);
116 
117 /*----------------------------------------------------------------------------*/
130 /*----------------------------------------------------------------------------*/
131 
132 void *
133 cs_cdofb_monolithic_init_scheme_context(const cs_navsto_param_t *nsp,
134  cs_adv_field_t *adv_field,
135  cs_real_t *mflux,
136  cs_real_t *mflux_pre,
137  cs_boundary_type_t *bf_type,
138  void *cc_context);
139 
140 /*----------------------------------------------------------------------------*/
148 /*----------------------------------------------------------------------------*/
149 
150 void *
151 cs_cdofb_monolithic_free_scheme_context(void *scheme_context);
152 
153 /*----------------------------------------------------------------------------*/
162 /*----------------------------------------------------------------------------*/
163 
164 void
165 cs_cdofb_monolithic_steady(const cs_mesh_t *mesh,
166  const cs_navsto_param_t *nsp,
167  void *scheme_context);
168 
169 /*----------------------------------------------------------------------------*/
179 /*----------------------------------------------------------------------------*/
180 
181 void
182 cs_cdofb_monolithic_steady_nl(const cs_mesh_t *mesh,
183  const cs_navsto_param_t *nsp,
184  void *scheme_context);
185 
186 /*----------------------------------------------------------------------------*/
197 /*----------------------------------------------------------------------------*/
198 
199 void
200 cs_cdofb_monolithic(const cs_mesh_t *mesh,
201  const cs_navsto_param_t *nsp,
202  void *scheme_context);
203 
204 /*----------------------------------------------------------------------------*/
217 /*----------------------------------------------------------------------------*/
218 
219 void
220 cs_cdofb_monolithic_nl(const cs_mesh_t *mesh,
221  const cs_navsto_param_t *nsp,
222  void *scheme_context);
223 
224 /*----------------------------------------------------------------------------*/
225 
226 END_C_DECLS
227 
228 #endif /* __CS_CDOFB_MONOLITHIC_H__ */
cs_base.h
cs_boundary_type_t
int cs_boundary_type_t
Definition: cs_boundary.h:69
cs_cdo_connect.h
cs_cdo_quantities.h
cs_cdofb_monolithic_finalize_common
void cs_cdofb_monolithic_finalize_common(const cs_navsto_param_t *nsp)
Free shared pointers with lifecycle dedicated to this file.
Definition: cs_cdofb_monolithic.c:1897
cs_cdofb_monolithic_nl
void cs_cdofb_monolithic_nl(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 monolithic approach....
Definition: cs_cdofb_monolithic.c:2901
cs_cdofb_monolithic_init_sharing
void cs_cdofb_monolithic_init_sharing(const cs_navsto_param_t *nsp, const cs_mesh_t *mesh, 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_monolithic.c:1842
cs_cdofb_monolithic
void cs_cdofb_monolithic(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 monolithic approach....
Definition: cs_cdofb_monolithic.c:2779
cs_cdofb_monolithic_get_face_velocity
static cs_real_t * cs_cdofb_monolithic_get_face_velocity(bool previous)
Retrieve the values of the velocity on the faces.
Definition: cs_cdofb_monolithic.h:77
cs_cdofb_monolithic_steady
void cs_cdofb_monolithic_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 monolithic approach.
Definition: cs_cdofb_monolithic.c:2459
cs_cdofb_monolithic_free_scheme_context
void * cs_cdofb_monolithic_free_scheme_context(void *scheme_context)
Destroy a cs_cdofb_monolithic_t structure.
Definition: cs_cdofb_monolithic.c:2414
cs_cdofb_monolithic_init_scheme_context
void * cs_cdofb_monolithic_init_scheme_context(const cs_navsto_param_t *nsp, cs_adv_field_t *adv_field, cs_real_t *mflux, cs_real_t *mflux_pre, cs_boundary_type_t *bf_type, void *cc_context)
Initialize a cs_cdofb_monolithic_t structure.
Definition: cs_cdofb_monolithic.c:1941
cs_cdofb_monolithic_steady_nl
void cs_cdofb_monolithic_steady_nl(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 monolithic approach and Pi...
Definition: cs_cdofb_monolithic.c:2578
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
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:472
cs_equation_get_face_values
cs_real_t * cs_equation_get_face_values(const cs_equation_t *eq, bool previous)
For a given equation, retrieve an array of values related to each face of the mesh for the unknowns.
Definition: cs_equation.c:3094
cs_equation.h
cs_mesh.h
cs_navsto_param.h
cs_time_step.h
mesh
Definition: mesh.f90:26
cs_adv_field_t
Definition: cs_advection_field.h:150
cs_cdo_connect_t
Definition: cs_cdo_connect.h:61
cs_cdo_quantities_t
Definition: cs_cdo_quantities.h:137
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_time_step_t
time step descriptor
Definition: cs_time_step.h:64