8.3
general documentation
cs_lagr_coupling.h
Go to the documentation of this file.
1#ifndef __CS_LAGR_COUPLING_H__
2#define __CS_LAGR_COUPLING_H__
3
4/*============================================================================
5 * Functions and types for the Lagrangian module
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#include "cs_defs.h"
31
32/*----------------------------------------------------------------------------*/
33
34BEGIN_C_DECLS
35
36/*=============================================================================
37 * Macro definitions
38 *============================================================================*/
39
40/*============================================================================
41 * Type definitions
42 *============================================================================*/
43
44/*=============================================================================
45 * Global variables
46 *============================================================================*/
47
48/*=============================================================================
49 * Public function prototypes
50 *============================================================================*/
51
52/*----------------------------------------------------------------------------*/
53/*
54 * \brief Compute source terms for Lagrangian 2-way coupling.
55 *
56 * \remark Source terms are computed for the starting cell of a particle
57 * during a given iteration. Even if particle exits the domain,
58 * it s necessary to compute a source term matching the exchange
59 * between the carrier fluid and the particle at the beginning
60 * of the time step. If cs_glob_lagr_time_step->nor == 2 and the
61 * particle interacts with a boundary, then the source terms
62 * are computed as if nor == 1.
63 *
64 * \param[in] taup dynamic characteristic time
65 * \param[in] tempct thermal charactersitic time
66 * \param[out] tsfext external forces
67 * \param[in] force_p forces per mass unit on particles (m/s^2)
68 */
69/*----------------------------------------------------------------------------*/
70
71void
72cs_lagr_coupling(const cs_real_t taup[],
73 const cs_real_t tempct[],
74 cs_real_t tsfext[],
75 const cs_real_3_t *force_p);
76
77/*----------------------------------------------------------------------------*/
78
79END_C_DECLS
80
81#endif /* __CS_LAGR_COUPLING_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:542
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:342
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:359
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:543
cs_lagr_coupling
void cs_lagr_coupling(const cs_real_t taup[], const cs_real_t tempct[], cs_real_t tsfext[], const cs_real_3_t *force_p)
Compute source terms for Lagrangian 2-way coupling.
Definition: cs_lagr_coupling.cpp:122