7.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-2021 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_quantities.h"
39 
40 /*----------------------------------------------------------------------------*/
41 
42 BEGIN_C_DECLS
43 
44 /*=============================================================================
45  * Macro definitions
46  *============================================================================*/
47 
48 /*============================================================================
49  * Type definitions
50  *============================================================================*/
51 
52 /*=============================================================================
53  * Public function prototypes
54  *============================================================================*/
55 
56 /*----------------------------------------------------------------------------*/
66 /*----------------------------------------------------------------------------*/
67 
68 bool
69 cs_preprocess_mesh_is_needed(void);
70 
71 /*----------------------------------------------------------------------------
72  * Define all mesh preprocessing operations.
73  *----------------------------------------------------------------------------*/
74 
75 void
76 cs_preprocess_mesh_define(void);
77 
78 /*----------------------------------------------------------------------------
79  * Apply all mesh preprocessing operations.
80  *
81  * parameters:
82  * halo_type <-> type of halo (standard or extended)
83  *----------------------------------------------------------------------------*/
84 
85 void
86 cs_preprocess_mesh(cs_halo_type_t halo_type);
87 
88 /*----------------------------------------------------------------------------*/
97 /*----------------------------------------------------------------------------*/
98 
99 void
100 cs_preprocess_mesh_selected_b_faces_ignore(cs_mesh_t *m,
101  cs_mesh_quantities_t *mq,
102  cs_lnum_t n_faces,
103  const cs_lnum_t face_ids[]);
104 
105 /*----------------------------------------------------------------------------
106  * Update fortran arrays relative to the global mesh.
107  *----------------------------------------------------------------------------*/
108 
109 void
110 cs_preprocess_mesh_update_fortran(void);
111 
112 /*----------------------------------------------------------------------------*/
113 
114 END_C_DECLS
115 
116 #endif /* __CS_PREPROCESS_H__ */
cs_defs.h
BEGIN_C_DECLS
#define BEGIN_C_DECLS
Definition: cs_defs.h:495
cs_preprocess_mesh
void cs_preprocess_mesh(cs_halo_type_t halo_type)
Apply all mesh preprocessing operations.
Definition: cs_preprocess.c:239
cs_preprocess_mesh_is_needed
bool cs_preprocess_mesh_is_needed(void)
Determine if preprocessing is needed.
Definition: cs_preprocess.c:186
cs_preprocess_mesh_define
void cs_preprocess_mesh_define(void)
Define all mesh preprocessing operations.
Definition: cs_preprocess.c:210
cs_preprocess_mesh_selected_b_faces_ignore
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:459
cs_mesh_t
Definition: cs_mesh.h:84
cs_mesh_quantities.h
cs_mesh_quantities_t
Definition: cs_mesh_quantities.h:89
cs_halo_type_t
cs_halo_type_t
Definition: cs_halo.h:50
cs_halo.h
cs_lnum_t
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:301
cs_mesh.h
END_C_DECLS
#define END_C_DECLS
Definition: cs_defs.h:496
cs_preprocess_mesh_update_fortran
void cs_preprocess_mesh_update_fortran(void)
Update fortran arrays relative to the global mesh.
Definition: cs_preprocess.c:529