9.2
general documentation
cs_lagr_new.h
Go to the documentation of this file.
1#ifndef CS_LAGR_NEW_H
2#define CS_LAGR_NEW_H
3
4/*============================================================================
5 * Handling of new particles.
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 * Local headers
34 *----------------------------------------------------------------------------*/
35
37
38/*----------------------------------------------------------------------------*/
39
40/*=============================================================================
41 * Macro definitions
42 *============================================================================*/
43
44/*============================================================================
45 * Type definitions
46 *============================================================================*/
47
48/*=============================================================================
49 * Global variables
50 *============================================================================*/
51
52/*=============================================================================
53 * Public function prototypes
54 *============================================================================*/
55
56/*----------------------------------------------------------------------------*/
69/*----------------------------------------------------------------------------*/
70
71void
72cs_lagr_new_particle_init(const cs_lnum_t particle_range[2],
73 int time_id,
74 const cs_real_t visc_length[],
75 const cs_lagr_injection_set_t *zis);
76
77/*----------------------------------------------------------------------------*/
78
79#if defined(__cplusplus)
80
81/*=============================================================================
82 * Public C++ functions
83 *============================================================================*/
84
85/*----------------------------------------------------------------------------*/
97/*----------------------------------------------------------------------------*/
98
99void
101 cs_lnum_t n_faces,
102 const cs_lnum_t face_ids[],
103 const cs_lnum_t face_particle_idx[]);
104
105/*----------------------------------------------------------------------------*/
119/*----------------------------------------------------------------------------*/
120
121void
123 cs_lnum_t n_cells,
124 const cs_lnum_t cell_ids[],
125 const cs_lnum_t cell_particle_idx[]);
126
127#endif //__cplusplus
128
129#endif /* CS_LAGR_NEW_H */
double cs_real_t
Floating-point value.
Definition: cs_defs.h:332
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:325
void cs_lagr_new(cs_lagr_particle_set_t &p_set, cs_lnum_t n_faces, const cs_lnum_t face_ids[], const cs_lnum_t face_particle_idx[])
Inject a series of particles at random positions on given faces.
Definition: cs_lagr_new.cpp:298
void cs_lagr_new_particle_init(const cs_lnum_t particle_range[2], int time_id, const cs_real_t visc_length[], const cs_lagr_injection_set_t *zis)
Initialization for new particles.
Definition: cs_lagr_new.cpp:656
void cs_lagr_new_v(cs_lagr_particle_set_t &p_set, cs_lnum_t n_cells, const cs_lnum_t cell_ids[], const cs_lnum_t cell_particle_idx[])
Inject a series of particles at random positions on given cells.
Definition: cs_lagr_new.cpp:391
Definition: cs_lagr.h:615
Definition: cs_lagr_particle.h:324