8.0
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-2023 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  * Local headers
34  *----------------------------------------------------------------------------*/
35 
36 #include "cs_lagr_particle.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
40 BEGIN_C_DECLS
41 
42 /*=============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*=============================================================================
51  * Global variables
52  *============================================================================*/
53 
54 /*=============================================================================
55  * Public function prototypes
56  *============================================================================*/
57 
58 /*----------------------------------------------------------------------------*/
70 /*----------------------------------------------------------------------------*/
71 
72 void
73 cs_lagr_new(cs_lagr_particle_set_t *particles,
74  cs_lnum_t n_faces,
75  const cs_lnum_t face_ids[],
76  const cs_lnum_t face_particle_idx[]);
77 
78 /*----------------------------------------------------------------------------*/
92 /*----------------------------------------------------------------------------*/
93 
94 void
95 cs_lagr_new_v(cs_lagr_particle_set_t *particles,
96  cs_lnum_t n_cells,
97  const cs_lnum_t cell_ids[],
98  const cs_lnum_t cell_particle_idx[]);
99 
100 /*----------------------------------------------------------------------------*/
112 /*----------------------------------------------------------------------------*/
113 
114 void
115 cs_lagr_new_particle_init(const cs_lnum_t particle_range[2],
116  int time_id,
117  const cs_real_t visc_length[]);
118 
119 /*----------------------------------------------------------------------------*/
120 
121 END_C_DECLS
122 
123 #endif /* __CS_LAGR_NEW_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
cs_real_t
double cs_real_t
Floating-point value.
Definition: cs_defs.h:319
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:510
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
cs_lagr_new_particle_init
void cs_lagr_new_particle_init(const cs_lnum_t particle_range[2], int time_id, const cs_real_t visc_length[])
Initialization for new particles.
Definition: cs_lagr_new.c:658
cs_lagr_new_v
void cs_lagr_new_v(cs_lagr_particle_set_t *particles, 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.c:395
cs_lagr_new
void cs_lagr_new(cs_lagr_particle_set_t *particles, 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.c:302
cs_lagr_particle.h
cs_lagr_particle_set_t
Definition: cs_lagr_particle.h:222