8.0
general documentation
cs_preprocess.h
Go to the documentation of this file.
1 #ifndef __CS_PREPROCESS_H__
2 #define __CS_PREPROCESS_H__
3 
4 /*============================================================================
5  * Handle successive preprocessing operations.
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 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_defs.h"
35 
36 #include "cs_halo.h"
37 #include "cs_mesh.h"
38 #include "cs_mesh_adjacencies.h"
39 #include "cs_mesh_quantities.h"
40 
41 /*----------------------------------------------------------------------------*/
42 
44 
45 /*=============================================================================
46  * Macro definitions
47  *============================================================================*/
48 
49 /*============================================================================
50  * Type definitions
51  *============================================================================*/
52 
53 /*=============================================================================
54  * Public function prototypes
55  *============================================================================*/
56 
57 /*----------------------------------------------------------------------------*/
67 /*----------------------------------------------------------------------------*/
68 
69 bool
71 
72 /*----------------------------------------------------------------------------
73  * Define all mesh preprocessing operations.
74  *----------------------------------------------------------------------------*/
75 
76 void
78 
79 /*----------------------------------------------------------------------------
80  * Apply all mesh preprocessing operations.
81  *
82  * parameters:
83  * halo_type <-> type of halo (standard or extended)
84  *----------------------------------------------------------------------------*/
85 
86 void
88 
89 /*----------------------------------------------------------------------------*/
98 /*----------------------------------------------------------------------------*/
99 
100 void
103  cs_lnum_t n_faces,
104  const cs_lnum_t face_ids[]);
105 
106 /*----------------------------------------------------------------------------
107  * Update fortran arrays relative to the global mesh.
108  *----------------------------------------------------------------------------*/
109 
110 void
112 
113 /*----------------------------------------------------------------------------*/
122 /*----------------------------------------------------------------------------*/
123 
124 void
126 
127 /*----------------------------------------------------------------------------*/
128 
130 
131 #endif /* __CS_PREPROCESS_H__ */
cs_alloc_mode_t
Definition: cs_base_accel.h:142
#define BEGIN_C_DECLS
Definition: cs_defs.h:509
#define END_C_DECLS
Definition: cs_defs.h:510
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:313
cs_halo_type_t
Definition: cs_halo.h:56
void cs_preprocess_mesh(cs_halo_type_t halo_type)
Apply all mesh preprocessing operations.
Definition: cs_preprocess.c:239
void cs_preprocess_mesh_define(void)
Define all mesh preprocessing operations.
Definition: cs_preprocess.c:210
void cs_preprocess_mesh_update_fortran(void)
Update fortran arrays relative to the global mesh.
Definition: cs_preprocess.c:533
void cs_preprocess_mesh_selected_b_faces_ignore(cs_mesh_t *m, cs_mesh_quantities_t *mq, cs_lnum_t n_faces, const cs_lnum_t face_ids[])
Apply numbering changes to ignore selected boundary faces.
Definition: cs_preprocess.c:468
void cs_preprocess_mesh_update_device(cs_alloc_mode_t alloc_mode)
Map some mesh arrays for use on device.
Definition: cs_preprocess.c:601
bool cs_preprocess_mesh_is_needed(void)
Determine if preprocessing is needed.
Definition: cs_preprocess.c:186
Definition: cs_mesh_quantities.h:92
Definition: cs_mesh.h:85