8.3
general documentation
cs_macfb_monolithic.h
Go to the documentation of this file.
1#ifndef __CS_MACFB_MONOLITHIC_H__
2#define __CS_MACFB_MONOLITHIC_H__
3
4/*============================================================================
5 * Build an algebraic MAC 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-2024 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
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
76inline static cs_real_t *
78{
79 return cs_equation_get_face_values(cs_equation_by_name("momentum"), previous);
80}
81
82/*============================================================================
83 * Public function prototypes
84 *============================================================================*/
85
86/*----------------------------------------------------------------------------*/
96/*----------------------------------------------------------------------------*/
97
99 const cs_mesh_t *mesh,
100 const cs_cdo_quantities_t *quant,
101 const cs_cdo_connect_t *connect,
102 const cs_time_step_t *time_step);
103
104/*----------------------------------------------------------------------------*/
108/*----------------------------------------------------------------------------*/
109
111
112/*----------------------------------------------------------------------------*/
125/*----------------------------------------------------------------------------*/
126
128 cs_adv_field_t *adv_field,
129 cs_real_t *mflux,
130 cs_real_t *mflux_pre,
131 cs_boundary_type_t *bf_type,
132 void *cc_context);
133
134/*----------------------------------------------------------------------------*/
142/*----------------------------------------------------------------------------*/
143
144void *cs_macfb_monolithic_free_scheme_context(void *scheme_context);
145
146/*----------------------------------------------------------------------------*/
155/*----------------------------------------------------------------------------*/
156
158 const cs_navsto_param_t *nsp,
159 void *scheme_context);
160
161/*----------------------------------------------------------------------------*/
171/*----------------------------------------------------------------------------*/
172
174 const cs_navsto_param_t *nsp,
175 void *scheme_context);
176
177/*----------------------------------------------------------------------------*/
188/*----------------------------------------------------------------------------*/
189
191 const cs_navsto_param_t *nsp,
192 void *scheme_context);
193
194/*----------------------------------------------------------------------------*/
207/*----------------------------------------------------------------------------*/
208
210 const cs_navsto_param_t *nsp,
211 void *scheme_context);
212
213/*----------------------------------------------------------------------------*/
214
216
217#endif /* __CS_MACFB_MONOLITHIC_H__ */
int cs_boundary_type_t
Definition: cs_boundary.h:69
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
#define END_C_DECLS
Definition: cs_defs.h:543
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.cpp:3221
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.cpp:503
void * cs_macfb_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_macfb_monolithic_t structure.
Definition: cs_macfb_monolithic.cpp:1043
void cs_macfb_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 MAC face-based scheme using a monolithic approach and Pi...
Definition: cs_macfb_monolithic.cpp:1396
void cs_macfb_monolithic(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the unsteady Navier-Stokes system with a MAC face-based scheme using a monolithic approach....
Definition: cs_macfb_monolithic.cpp:1565
void cs_macfb_monolithic_steady(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the steady Navier-Stokes system with a MAC face-based scheme using a monolithic approach.
Definition: cs_macfb_monolithic.cpp:1315
void cs_macfb_monolithic_init_sharing(const cs_equation_param_t *mom_eqp, 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_macfb_monolithic.cpp:982
void cs_macfb_monolithic_nl(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, void *scheme_context)
Solve the unsteady Navier-Stokes system with a MAC face-based scheme using a monolithic approach....
Definition: cs_macfb_monolithic.cpp:1644
void cs_macfb_monolithic_finalize_common(void)
Free shared pointers with lifecycle dedicated to this file.
Definition: cs_macfb_monolithic.cpp:1025
void * cs_macfb_monolithic_free_scheme_context(void *scheme_context)
Destroy a cs_macfb_monolithic_t structure.
Definition: cs_macfb_monolithic.cpp:1269
static cs_real_t * cs_macfb_monolithic_get_face_velocity(bool previous)
Retrieve the values of the velocity on the faces.
Definition: cs_macfb_monolithic.h:77
Definition: mesh.f90:26
Definition: cs_advection_field.h:151
Definition: cs_cdo_connect.h:61
Definition: cs_cdo_quantities.h:139
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:192
Definition: cs_mesh.h:85
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:263
time step descriptor
Definition: cs_time_step.h:64