9.2
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-2026 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 "base/cs_defs.h"
33
34/*----------------------------------------------------------------------------
35 * Standard C library headers
36 *----------------------------------------------------------------------------*/
37
38/*----------------------------------------------------------------------------
39 * Local headers
40 *----------------------------------------------------------------------------*/
41
42#include "base/cs_base.h"
43#include "base/cs_time_step.h"
44#include "cdo/cs_cdo_connect.h"
46#include "cdo/cs_equation.h"
48#include "cdo/cs_navsto_param.h"
49#include "mesh/cs_mesh.h"
50
51/*============================================================================
52 * Macro definitions
53 *============================================================================*/
54
55/*============================================================================
56 * Type definitions
57 *============================================================================*/
58
59/*============================================================================
60 * Static inline public function prototypes
61 *============================================================================*/
62
63/*----------------------------------------------------------------------------*/
71/*----------------------------------------------------------------------------*/
72
73inline static cs_real_t *
75{
76 return cs_equation_get_face_values(cs_equation_by_name("momentum"), previous);
77}
78
79/*============================================================================
80 * Public function prototypes
81 *============================================================================*/
82
83/*----------------------------------------------------------------------------*/
93/*----------------------------------------------------------------------------*/
94
96 const cs_mesh_t *mesh,
97 const cs_cdo_quantities_t *quant,
98 const cs_cdo_connect_t *connect,
99 const cs_time_step_t *time_step);
100
101/*----------------------------------------------------------------------------*/
105/*----------------------------------------------------------------------------*/
106
108
109/*----------------------------------------------------------------------------*/
122/*----------------------------------------------------------------------------*/
123
126 cs_adv_field_t *adv_field,
127 cs_real_t *mflux,
128 cs_real_t *mflux_pre,
129 cs_boundary_type_t *bf_type,
130 void *cc_context);
131
132/*----------------------------------------------------------------------------*/
140/*----------------------------------------------------------------------------*/
141
142void *
144
145/*----------------------------------------------------------------------------*/
154/*----------------------------------------------------------------------------*/
155
156void
158 const cs_navsto_param_t *nsp,
160
161/*----------------------------------------------------------------------------*/
171/*----------------------------------------------------------------------------*/
172
173void
175 const cs_navsto_param_t *nsp,
177
178/*----------------------------------------------------------------------------*/
189/*----------------------------------------------------------------------------*/
190
191void
193 const cs_navsto_param_t *nsp,
195
196/*----------------------------------------------------------------------------*/
209/*----------------------------------------------------------------------------*/
210
211void
213 const cs_navsto_param_t *nsp,
215
216#endif /* CS_MACFB_MONOLITHIC_H */
time step descriptor
Definition: cs_time_step.h:60
int cs_boundary_type_t
Definition: cs_boundary.h:65
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
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:3253
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:495
void cs_macfb_monolithic_steady(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, cs_macfb_monolithic_t *sc)
Solve the steady Navier-Stokes system with a MAC face-based scheme using a monolithic approach.
Definition: cs_macfb_monolithic.cpp:1303
cs::cdo_navsto_ctx_t * 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:1033
void cs_macfb_monolithic(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, cs_macfb_monolithic_t *sc)
Solve the unsteady Navier-Stokes system with a MAC face-based scheme using a monolithic approach....
Definition: cs_macfb_monolithic.cpp:1549
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:972
void cs_macfb_monolithic_steady_nl(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, cs_macfb_monolithic_t *sc)
Solve the steady Navier-Stokes system with a MAC face-based scheme using a monolithic approach and Pi...
Definition: cs_macfb_monolithic.cpp:1383
void cs_macfb_monolithic_nl(const cs_mesh_t *mesh, const cs_navsto_param_t *nsp, cs_macfb_monolithic_t *sc)
Solve the unsteady Navier-Stokes system with a MAC face-based scheme using a monolithic approach....
Definition: cs_macfb_monolithic.cpp:1627
void cs_macfb_monolithic_finalize_common(void)
Free shared pointers with lifecycle dedicated to this file.
Definition: cs_macfb_monolithic.cpp:1015
void * cs_macfb_monolithic_free_scheme_context(cs_macfb_monolithic_t *sc)
Destroy a cs_macfb_monolithic_t structure.
Definition: cs_macfb_monolithic.cpp:1259
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:74
Structures and function pointers useful to build and solve the Navier-Stokes equations with MAC face-...
struct _macfb_monolithic_t cs_macfb_monolithic_t
Definition: cs_macfb_monolithic_priv.h:72
Definition: mesh.f90:26
Context related to CDO face-based discretization when dealing with Navier-Stokes equations and vector...
Definition: cs_navsto_context.h:48
Definition: cs_advection_field.h:151
Definition: cs_cdo_connect.h:57
Definition: cs_cdo_quantities.h:142
Set of parameters to handle an unsteady convection-diffusion-reaction equation with term sources.
Definition: cs_equation_param.h:190
Definition: cs_mesh.h:85
Structure storing the parameters related to the resolution of the Navier-Stokes system.
Definition: cs_navsto_param.h:296