9.2
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-2026 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 "base/cs_defs.h"
31
32/*----------------------------------------------------------------------------*/
33
34/*=============================================================================
35 * Macro definitions
36 *============================================================================*/
37
38/*============================================================================
39 * Type definitions
40 *============================================================================*/
41
42/*=============================================================================
43 * Global variables
44 *============================================================================*/
45
46/*=============================================================================
47 * Public function prototypes
48 *============================================================================*/
49
50/*----------------------------------------------------------------------------*/
54/*----------------------------------------------------------------------------*/
55
56void
57cs_lagr_coupling_initialize(void);
58
59/*----------------------------------------------------------------------------*/
80/*----------------------------------------------------------------------------*/
81
82#if defined(__cplusplus)
83void
84cs_lagr_coupling_increment_part_contrib(cs_lagr_particle_set_t &p_set,
85 const cs_lnum_t p_id,
86 const cs_real_t dt_part,
87 const bool rebound,
88 const cs_real_t taup,
89 const cs_real_3_t force_p,
90 const cs_real_2_t tempct);
91#endif // defined(__cplusplus)
92
93/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_lagr_coupling_finalize(void);
103
104/*----------------------------------------------------------------------------*/
105
106#endif /* CS_LAGR_COUPLING_H */
cs_defs.h
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:349
cs_real_2_t
cs_real_t cs_real_2_t[2]
vector of 2 floating-point values
Definition: cs_defs.h:348
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_lagr_coupling_initialize
void cs_lagr_coupling_initialize(void)
Prepare source terms for Lagrangian 2-way coupling.
Definition: cs_lagr_coupling.cpp:104
cs_lagr_coupling_finalize
void cs_lagr_coupling_finalize(void)
Finalize source terms for Lagrangian 2-way coupling by treating cell-attached properties.
Definition: cs_lagr_coupling.cpp:434
cs_lagr_coupling_increment_part_contrib
void cs_lagr_coupling_increment_part_contrib(cs_lagr_particle_set_t &p_set, const cs_lnum_t p_id, const cs_real_t dt_part, const bool rebound, const cs_real_t taup, const cs_real_3_t force_p, const cs_real_2_t tempct)
Increment the source terms for Lagrangian 2-way coupling with quantites attached to a given particle.
Definition: cs_lagr_coupling.cpp:256
cs_lagr_particle_set_t
Definition: cs_lagr_particle.h:324