8.1
general documentation
cs_mass_source_terms.h
Go to the documentation of this file.
1 #ifndef __CS_MASS_SOURCE_TERMS_H__
2 #define __CS_MASS_SOURCE_TERMS_H__
3 
4 /*============================================================================
5  * Mass source terms computation.
6  *============================================================================*/
7 
8 /*
9  This file is part of code_saturne, a general-purpose CFD tool.
10 
11  Copyright (C) 1998-2023 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  * Local headers
30  *----------------------------------------------------------------------------*/
31 
32 #include "cs_base.h"
33 
34 /*----------------------------------------------------------------------------*/
35 
37 
38 /*=============================================================================
39  * Public function prototypes
40  *============================================================================*/
41 
42 /*----------------------------------------------------------------------------*/
43 /*
44  * \brief Implicit and explicit mass source terms computation.
45  *
46  * \param[in] iterns iteration number on Navier-Stoke
47  * \param[in] dim associated field dimension
48  * \param[in] ncesmp number of cells with mass source term
49  * \param[in] icetsm source mass cells pointer (1-based numbering)
50  * \param[in] itpsmp mass source type for the working variable
51  * \param[in] volume cells volume
52  * \param[in] pvara variable value at time step beginning
53  * \param[in] smcelp value of the variable associated with mass source
54  * \param[in] gamma flow mass value
55  * \param[in,out] st_exp explicit source term part linear in the variable
56  * \param[in,out] st_imp associated value with \c tsexp
57  * to be stored in the matrix
58  * \param[out] gapinj explicit source term part independent
59  * of the variable
60  */
61 /*----------------------------------------------------------------------------*/
62 
63 void
64 cs_mass_source_terms(int iterns,
65  int dim,
66  cs_lnum_t ncesmp,
67  const cs_lnum_t icetsm[],
68  int itpsmp[],
69  const cs_real_t volume[],
70  const cs_real_t pvara[],
71  const cs_real_t smcelp[],
72  const cs_real_t gamma[],
73  cs_real_t st_exp[],
74  cs_real_t st_imp[],
75  cs_real_t gapinj[]);
76 
77 /*----------------------------------------------------------------------------*/
78 
80 
81 #endif /* __CS_MASS_SOURCE_TERMS_H__ */
#define BEGIN_C_DECLS
Definition: cs_defs.h:514
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
#define END_C_DECLS
Definition: cs_defs.h:515
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
@ gamma
Definition: cs_field_pointer.h:221
void cs_mass_source_terms(int iterns, int dim, cs_lnum_t ncesmp, const cs_lnum_t icetsm[], int itpsmp[], const cs_real_t volume[], const cs_real_t pvara[], const cs_real_t smcelp[], const cs_real_t gamma[], cs_real_t st_exp[], cs_real_t st_imp[], cs_real_t gapinj[])
Implicit and explicit mass source terms computation.
Definition: cs_mass_source_terms.c:231
integer, dimension(:), allocatable, target icetsm
number of the ncetsm cells in which a mass injection is imposed. See iicesm and the cs_equation_add_v...
Definition: pointe.f90:176
double precision, dimension(:), pointer volume
volume of each cell
Definition: mesh.f90:108