9.2
general documentation
cs_lagr_car.h
Go to the documentation of this file.
1#ifndef CS_LAGR_LAGCAR_H
2#define CS_LAGR_LAGCAR_H
3
4/*============================================================================
5 * Compute particle characteristics: Tp, TL et PI
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#include "lagr/cs_lagr_particle.h"
32
33/*----------------------------------------------------------------------------*/
34
35/*=============================================================================
36 * Macro definitions
37 *============================================================================*/
38
39/*============================================================================
40 * Type definitions
41 *============================================================================*/
42
43/*=============================================================================
44 * Global variables
45 *============================================================================*/
46
47#if defined(__cplusplus)
48
49/*=============================================================================
50 * Public function prototypes
51 *============================================================================*/
52
53/*----------------------------------------------------------------------------*/
74/*----------------------------------------------------------------------------*/
75
76void
77cs_lagr_car(int iprev,
78 int phase_id,
79 cs_lagr_particle_set_t &p_set,
80 cs_lnum_t p_id,
81 int nor,
82 const cs_real_t dt_part,
83 cs_real_t *taup,
84 cs_real_3_t tlag,
85 cs_real_3_t piil,
86 cs_real_33_t bx,
87 cs_real_2_t tempct,
88 cs_real_3_t beta);
89
90/*----------------------------------------------------------------------------*/
107/*----------------------------------------------------------------------------*/
108
109void
110cs_lagr_get_force_p(const cs_real_t dt_part,
111 cs_lagr_particle_set_t &p_set,
112 cs_lnum_t p_id,
113 cs_array<cs_real_t>& taup,
114 cs_array_2d<cs_real_t>& tlag,
115 cs_array_2d<cs_real_t>& piil,
116 cs_array_3d<cs_real_t>& bx,
117 cs_real_t tsfext,
118 cs_real_3_t force_p);
119
120/*----------------------------------------------------------------------------*/
121
122#endif /* __cplusplus */
123
124#endif /* CS_LAGR_LAGCAR_H */
cs::array
Define a templated array class (owner of data)
Definition: cs_array.h:1118
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_real_33_t
cs_real_t cs_real_33_t[3][3]
3x3 matrix of floating-point values
Definition: cs_defs.h:358
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
cs_lagr_car
void cs_lagr_car(int iprev, int phase_id, cs_lagr_particle_set_t &p_set, cs_lnum_t p_id, int nor, const cs_real_t dt_part, cs_real_t *taup, cs_real_3_t tlag, cs_real_3_t piil, cs_real_33_t bx, cs_real_2_t tempct, cs_real_3_t beta)
Compute particle characteristics (except force_p): Tp, TL and PI as well as covariance and variance t...
Definition: cs_lagr_car.cpp:128
cs_lagr_get_force_p
void cs_lagr_get_force_p(const cs_real_t dt_part, cs_lagr_particle_set_t &p_set, cs_lnum_t p_id, cs_array< cs_real_t > &taup, cs_array_2d< cs_real_t > &tlag, cs_array_2d< cs_real_t > &piil, cs_array_3d< cs_real_t > &bx, cs_real_t tsfext, cs_real_3_t force_p)
Compute external force impacting the particle.
Definition: cs_lagr_car.cpp:569
cs_lagr_particle.h
cs_lagr_particle_set_t
Definition: cs_lagr_particle.h:324