9.1
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-2025 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
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/*----------------------------------------------------------------------------*/
56/*----------------------------------------------------------------------------*/
57
58void
59cs_lagr_coupling_initialize(void);
60
61/*----------------------------------------------------------------------------*/
82/*----------------------------------------------------------------------------*/
83
84void
85cs_lagr_coupling_increment_part_contrib(cs_lagr_particle_set_t *p_set,
86 const cs_lnum_t p_id,
87 const cs_real_t dt_part,
88 const bool rebound,
89 const cs_real_t taup,
90 const cs_real_3_t force_p,
91 const cs_real_2_t tempct);
92
93/*----------------------------------------------------------------------------*/
99/*----------------------------------------------------------------------------*/
100
101void
102cs_lagr_coupling_finalize(void);
103
104/*----------------------------------------------------------------------------*/
105
106END_C_DECLS
107
108#endif /* __CS_LAGR_COUPLING_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:554
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:357
cs_real_3_t
cs_real_t cs_real_3_t[3]
vector of 3 floating-point values
Definition: cs_defs.h:374
cs_real_2_t
cs_real_t cs_real_2_t[2]
vector of 2 floating-point values
Definition: cs_defs.h:373
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:555
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:350
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:258
cs_lagr_coupling_initialize
void cs_lagr_coupling_initialize(void)
Prepare source terms for Lagrangian 2-way coupling.
Definition: cs_lagr_coupling.cpp:106
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:444
cs_lagr_particle_set_t
Definition: cs_lagr_particle.h:226