1 #ifndef __CS_LAGR_LAGESP_H__
2 #define __CS_LAGR_LAGESP_H__
3 
4 /*============================================================================
5  * Functions and types for LAGESP
6  *============================================================================*/
7 
8 /*
9   This file is part of Code_Saturne, a general-purpose CFD tool.
10 
11   Copyright (C) 1998-2021 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 #include "cs_defs.h"
31 
32 /*----------------------------------------------------------------------------*/
33 
34 BEGIN_C_DECLS
35 
36 /*============================================================================
37  * Public function prototypes
38  *============================================================================*/
39 
40 /*----------------------------------------------------------------------------*/
41 /*!
42  * \brief Integration of particle equations of motion:
43  *
44  * - Standard Model : First or second order
45  * - Deposition submodel (Guingo & Minier, 2008) if needed
46  *
47  * \param[in]  dt_p      lagrangian time step
48  * \param[in]  taup      dynamic characteristic time
49  * \param[in]  tlag      fluid characteristic time
50  * \param[in]  piil      terme in P-U SDE integration
51  * \param[in]  bx        turbulence characteristics
52  * \param[out] tsfext    info for return coupling source terms
53  * \param[in]  gradpr    pressure gradient
54  * \param[in]  gradvf    fluid velocity gradient
55  * \param[out] terbru    FIXME
56  * \param[in]  vislen    FIXME
57  */
58 /*----------------------------------------------------------------------------*/
59 
60 void
61 cs_lagr_sde(cs_real_t           dt_p,
62             const cs_real_t     taup[],
63             const cs_real_3_t   tlag[],
64             const cs_real_3_t   piil[],
65             const cs_real_33_t  bx[],
66             cs_real_t           tsfext[],
67             const cs_real_3_t   gradpr[],
68             const cs_real_33_t  gradvf[],
69             cs_real_t           terbru[],
70             const cs_real_t     vislen[],
71             cs_lnum_t          *nresnew);
72 
73 /*----------------------------------------------------------------------------*/
74 /*!
75  * \brief Integration of a stochastic differential equation (SDE) for
76  *        a user particle variable (attribute).
77  *
78  * \f[
79  *  \frac{dV}{dt} = \frac{V - PIP}{TCARAC}
80  * \f]
81  *
82  * When there is interaction with a boundary face, the integration
83  * degenerates to order 1 (even if the 2nd order scheme is active).
84  *
85  * \param[in]  attr    attribute/variable
86  * \param[in]  tcarac  variable characteristic time
87  * \param[in]  pip     right-hand side associated with SDE
88  *----------------------------------------------------------------------------*/
89 
90 void
91 cs_lagr_sde_attr(cs_lagr_attribute_t   attr,
92                  cs_real_t            *tcarac,
93                  cs_real_t            *pip);
94 
95 /*----------------------------------------------------------------------------*/
96 
97 END_C_DECLS
98 
99 #endif /* __CS_LAGR_LAGESP_H__ */
100