programmer's documentation
cs_lagr_tracking.h
Go to the documentation of this file.
1 #ifndef __CS_LAGR_TRACKING_H__
2 #define __CS_LAGR_TRACKING_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-2018 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 #include "cs_interface.h"
33 
34 #include "assert.h"
35 
36 #include "cs_lagr_particle.h"
37 
38 /*----------------------------------------------------------------------------*/
39 
41 
42 /*=============================================================================
43  * Macro definitions
44  *============================================================================*/
45 
46 /*============================================================================
47  * Type definitions
48  *============================================================================*/
49 
50 /*=============================================================================
51  * Global variables
52  *============================================================================*/
53 
54 /*============================================================================
55  * Public function prototypes for Fortran API
56  *============================================================================*/
57 
58 /*============================================================================
59  * Public function prototypes
60  *============================================================================*/
61 
62 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 void
70 
71 /*----------------------------------------------------------------------------*/
75 /*----------------------------------------------------------------------------*/
76 
77 void
79 
80 /*----------------------------------------------------------------------------*/
84 /*----------------------------------------------------------------------------*/
85 
86 void
88 
89 /*----------------------------------------------------------------------------*/
90 
91 /*----------------------------------------------------------------------------*/
95 /*----------------------------------------------------------------------------*/
96 
97 void
98 _test_wall_cell(const void *particle,
99  const cs_lagr_attribute_map_t *p_am,
100  const cs_real_t visc_length[],
101  cs_real_t *yplus,
102  cs_lnum_t *face_id);
103 /*----------------------------------------------------------------------------*/
104 
105 
107 
108 #endif /* __CS_LAGR_TRACKING_H__ */
void cs_lagr_tracking_particle_movement(const cs_real_t visc_length[])
Apply one particle movement step.
Definition: cs_lagr_tracking.c:3336
#define BEGIN_C_DECLS
Definition: cs_defs.h:451
void cs_lagr_tracking_initialize(void)
Initialize particle tracking subsystem.
Definition: cs_lagr_tracking.c:3296
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_lagr_tracking_finalize(void)
Finalize Lagrangian module.
Definition: cs_lagr_tracking.c:3590
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
#define END_C_DECLS
Definition: cs_defs.h:452
void _test_wall_cell(const void *particle, const cs_lagr_attribute_map_t *p_am, const cs_real_t visc_length[], cs_real_t *yplus, cs_lnum_t *face_id)
Calculates the distance to the wall y+.
Definition: cs_lagr_particle.h:145