programmer's documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
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-2017 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 
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 /*----------------------------------------------------------------------------*/
62 /*----------------------------------------------------------------------------*/
63 
64 void
66 
67 /*----------------------------------------------------------------------------*/
73 /*----------------------------------------------------------------------------*/
74 
75 void
77 
78 /*----------------------------------------------------------------------------*/
82 /*----------------------------------------------------------------------------*/
83 
84 void
86 
87 /*----------------------------------------------------------------------------*/
100 /*----------------------------------------------------------------------------*/
101 
102 void
103 cs_lagr_test_wall_cell(const void *particle,
104  const cs_lagr_attribute_map_t *p_am,
105  const cs_real_t visc_length[],
106  cs_real_t *yplus,
107  cs_lnum_t *face_id);
108 
109 /*----------------------------------------------------------------------------*/
118 /*----------------------------------------------------------------------------*/
119 
120 void
122  cs_lnum_t **cell_face_lst);
123 
124 /*----------------------------------------------------------------------------*/
125 
126 
128 
129 #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:3267
#define BEGIN_C_DECLS
Definition: cs_defs.h:453
void cs_lagr_tracking_initialize(void)
Initialize particle tracking subsystem.
Definition: cs_lagr_tracking.c:3225
double cs_real_t
Floating-point value.
Definition: cs_defs.h:297
void cs_lagr_get_cell_face_connectivity(cs_lnum_t **cell_face_idx, cs_lnum_t **cell_face_lst)
Get pointers to cell face connectivity used in particle tracking.
Definition: cs_lagr_tracking.c:3631
void cs_lagr_tracking_finalize(void)
Finalize Lagrangian module.
Definition: cs_lagr_tracking.c:3506
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
#define END_C_DECLS
Definition: cs_defs.h:454
void cs_lagr_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)
Determine the number of the closest wall face from the particle as well as the corresponding wall nor...
Definition: cs_lagr_tracking.c:3560
Definition: cs_lagr_particle.h:145