8.2
general documentation
cs_drift_convective_flux.h
Go to the documentation of this file.
1 #ifndef __CS_DRIFT_CONVECTIVE_FLUX_H__
2 #define __CS_DRIFT_CONVECTIVE_FLUX_H__
3 
4 /*============================================================================
5  * Compute the modified convective flux for scalars with a drift.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2024 EDF S.A.
12 
13  This program is free software; you can redistribute it and/or modify it under
14  the terms of the GNU General Public License as published by the Free Software
15  Foundation; either version 2 of the License, or (at your option) any later
16  version.
17 
18  This program is distributed in the hope that it will be useful, but WITHOUT
19  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
21  details.
22 
23  You should have received a copy of the GNU General Public License along with
24  this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
25  Street, Fifth Floor, Boston, MA 02110-1301, USA.
26 */
27 
28 /*----------------------------------------------------------------------------*/
29 
30 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 /*----------------------------------------------------------------------------*/
37 
38 BEGIN_C_DECLS
39 
40 /*=============================================================================
41  * Public function prototypes
42  *============================================================================*/
43 
44 /*----------------------------------------------------------------------------*/
45 /*
46  * \brief Compute the modified convective flux for scalars with a drift.
47  *
48  * \param[in] f_sc drift scalar field
49  * \param[in,out] i_mass_flux scalar mass flux at interior face centers
50  * \param[in,out] b_mass_flux scalar mass flux at boundary face centers
51  * \param[in,out] fimp implicit term
52  * \param[in,out] rhs right hand side term
53  */
54 /*----------------------------------------------------------------------------*/
55 
56 void
57 cs_drift_convective_flux(cs_field_t *f_sc,
58  cs_real_t i_mass_flux[],
59  cs_real_t b_mass_flux[],
60  cs_real_t fimp[],
61  cs_real_t rhs[]);
62 
63 /*----------------------------------------------------------------------------*/
64 
65 END_C_DECLS
66 
67 #endif /* __CS_DRIFT_CONVECTIVE_FLUX_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:528
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:529
cs_drift_convective_flux
void cs_drift_convective_flux(cs_field_t *f_sc, cs_real_t i_mass_flux[], cs_real_t b_mass_flux[], cs_real_t fimp[], cs_real_t rhs[])
Compute the modified convective flux for scalars with a drift.
Definition: cs_drift_convective_flux.cpp:110
cs_field_t
Field descriptor.
Definition: cs_field.h:131