programmer's documentation
cs_renumber.h
Go to the documentation of this file.
1 #ifndef __CS_RENUMBER_H__
2 #define __CS_RENUMBER_H__
3 
4 /*============================================================================
5  * Optional mesh renumbering
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 /*----------------------------------------------------------------------------
31  * Local headers
32  *----------------------------------------------------------------------------*/
33 
34 #include "cs_base.h"
35 #include "cs_mesh.h"
36 
37 /*----------------------------------------------------------------------------*/
38 
40 
41 /*============================================================================
42  * Macro definitions
43  *============================================================================*/
44 
45 /*============================================================================
46  * Type definitions
47  *============================================================================*/
48 
49 /* Renumbering algorithms */
50 
51 typedef enum {
52 
53  CS_RENUMBER_CELLS_SCOTCH_PART, /* SCOTCH partitioning */
54  CS_RENUMBER_CELLS_SCOTCH_ORDER, /* SCOTCH ordering */
55  CS_RENUMBER_CELLS_METIS_PART, /* METIS partitioning */
56  CS_RENUMBER_CELLS_METIS_ORDER, /* METIS ordering */
57  CS_RENUMBER_CELLS_MORTON, /* Morton space filling curve */
58  CS_RENUMBER_CELLS_HILBERT, /* Hilbert space filling curve */
59  CS_RENUMBER_CELLS_RCM, /* Reverse Cuthill-McKee */
60  CS_RENUMBER_CELLS_NONE /* No cells renumbering */
61 
63 
64 typedef enum {
65 
66  CS_RENUMBER_I_FACES_BLOCK, /* No shared cell in block */
67  CS_RENUMBER_I_FACES_MULTIPASS, /* Use multipass face numbering */
68  CS_RENUMBER_I_FACES_SIMD, /* Renumber for vector (SIMD) operations */
69  CS_RENUMBER_I_FACES_NONE /* No interior face numbering */
70 
72 
73 typedef enum {
74 
75  CS_RENUMBER_B_FACES_THREAD, /* No cell shared between threads */
76  CS_RENUMBER_B_FACES_SIMD, /* Renumber for vector (SIMD) operations */
77  CS_RENUMBER_B_FACES_NONE /* No interior face numbering */
78 
80 
81 /* Ordering options for adjacency arrays */
82 
83 typedef enum {
84 
85  CS_RENUMBER_ADJACENT_LOW, /* Lowest adjacent id first */
86  CS_RENUMBER_ADJACENT_HIGH /* Highest adjacent id first */
87 
89 
90 /*=============================================================================
91  * Public function prototypes
92  *============================================================================*/
93 
94 /*----------------------------------------------------------------------------
95  * Set the target number of threads for mesh renumbering.
96  *
97  * By default, the target number of threads is set to cs_glob_n_threads,
98  * but the value may be forced using this function. This is mainly useful
99  * for testing purposes.
100  *
101  * parameters:
102  * n_threads <-- target number of threads for mesh numbering
103  *----------------------------------------------------------------------------*/
104 
105 void
106 cs_renumber_set_n_threads(int n_threads);
107 
108 /*----------------------------------------------------------------------------
109  * Return the target number of threads for mesh renumbering.
110  *
111  * returns:
112  * the target number of threads for mesh numbering
113  *----------------------------------------------------------------------------*/
114 
115 int
117 
118 /*----------------------------------------------------------------------------
119  * Set the minimum sunset sizes when renumbering for threads.
120  *
121  * parameters:
122  * min_i_subset_size <-- minimum number of interior faces per
123  * thread per group
124  * min_b_subset_size <-- minimum number of boundary faces per
125  * thread per group
126  *----------------------------------------------------------------------------*/
127 
128 void
130  cs_lnum_t min_b_subset_size);
131 
132 /*----------------------------------------------------------------------------
133  * Get the minimum sunset sizes when renumbering for threads.
134  *
135  * min_i_subset_size --> minimum number of interior faces per
136  * thread per group, or NULL
137  * min_b_subset_size --> minimum number of boundary faces per
138  * thread per group, or NULL
139  *----------------------------------------------------------------------------*/
140 
141 void
142 cs_renumber_get_min_subset_size(cs_lnum_t *min_i_subset_size,
143  cs_lnum_t *min_b_subset_size);
144 
145 /*----------------------------------------------------------------------------
146  * Select the options for interior faces renumbering.
147  *
148  * parameters:
149  * halo_adjacent_cells_last <-- if true, cells adjacent to ghost cells
150  * will be placed last (after pre-numbering)
151  * halo_adjacent_faces_last <-- if true, interior faces adjacent to ghost
152  * cells will be placed last (after pre-numbering)
153  * i_faces_base_ordering <-- pre-ordering of interior faces by
154  * lowest or highest adjacent cell id
155  * cells_pre_numbering <-- algorithm for cells pre-numbering
156  * cells_numbering <-- algorithm for cells numbering
157  * i_faces_numbering <-- algorithm for interior faces numbering
158  * b_faces_numbering <-- algorithm for boundary faces numbering
159  *----------------------------------------------------------------------------*/
160 
161 void
162 cs_renumber_set_algorithm(bool halo_adjacent_cells_last,
163  bool halo_adjacent_faces_last,
164  cs_renumber_ordering_t i_faces_base_ordering,
165  cs_renumber_cells_type_t cells_pre_numbering,
166  cs_renumber_cells_type_t cells_numbering,
167  cs_renumber_i_faces_type_t i_faces_numbering,
168  cs_renumber_b_faces_type_t b_faces_numbering);
169 
170 /*----------------------------------------------------------------------------
171  * Return the options for interior faces renumbering.
172  *
173  * Any argument may be passed NULL if this option is not queried.
174  *
175  * parameters:
176  * halo_adjacent_cells_last --> if true, cells adjacent to ghost cells
177  * will be placed last (after pre-numbering)
178  * halo_adjacent_faces_last --> if true, interior faces adjacent to ghost
179  * cells will be placed last (after pre-numbering)
180  * i_faces_base_ordering --> pre-ordering of interior faces by
181  * lowest or highest adjacent cell id
182  * cells_pre_numbering --> algorithm for cells pre-numbering
183  * cells_numbering --> algorithm for cells numbering
184  * i_faces_numbering --> algorithm for interior faces numbering
185  * b_faces_numbering --> algorithm for boundary faces numbering
186  *----------------------------------------------------------------------------*/
187 
188 void
189 cs_renumber_get_algorithm(bool *halo_adjacent_cells_last,
190  bool *halo_adjacent_faces_last,
191  cs_renumber_ordering_t *i_faces_base_ordering,
192  cs_renumber_cells_type_t *cells_pre_numbering,
193  cs_renumber_cells_type_t *cells_numbering,
194  cs_renumber_i_faces_type_t *i_faces_numbering,
195  cs_renumber_b_faces_type_t *b_faces_numbering);
196 
197 /*----------------------------------------------------------------------------
198  * Renumber mesh elements for vectorization or threading depending on code
199  * options and target machine.
200  *
201  * Renumbering cells may also allow improving locality (and favor faces
202  * renumbering).
203  * It is also possible to place cells connected to ghost cells last,
204  * which may be useful to enable computation/communication overlap.
205  *
206  * parameters:
207  * mesh <-> pointer to global mesh structure
208  *----------------------------------------------------------------------------*/
209 
210 void
212 
213 /*----------------------------------------------------------------------------*/
222 /*----------------------------------------------------------------------------*/
223 
224 void
226 
227 /*----------------------------------------------------------------------------
228  * Renumber interior faces for vectorization or threading depending on code
229  * options and target machine.
230  *
231  * parameters:
232  * mesh <-> pointer to global mesh structure
233  *----------------------------------------------------------------------------*/
234 
235 void
237 
238 /*----------------------------------------------------------------------------
239  * Renumber interior faces by global number.
240  *
241  * This effectively resets the interior faces to their initial numbering.
242  *
243  * parameters:
244  * mesh <-> pointer to global mesh structure
245  *----------------------------------------------------------------------------*/
246 
247 void
249 
250 /*----------------------------------------------------------------------------
251  * Renumber boundary faces for vectorization or threading depending on code
252  * options and target machine.
253  *
254  * parameters:
255  * mesh <-> pointer to global mesh structure
256  *----------------------------------------------------------------------------*/
257 
258 void
260 
261 /*----------------------------------------------------------------------------
262  * Renumber boundary faces by global number.
263  *
264  * This effectively resets the boundary faces to their initial numbering.
265  *
266  * parameters:
267  * mesh <-> pointer to global mesh structure
268  *----------------------------------------------------------------------------*/
269 
270 void
272 
273 /*----------------------------------------------------------------------------*/
274 
276 
277 #endif /* __CS_RENUMBER_H__ */
Definition: cs_renumber.h:86
void cs_renumber_i_faces_by_gnum(cs_mesh_t *mesh)
Definition: cs_renumber.c:5538
Definition: cs_renumber.h:53
int cs_renumber_get_n_threads(void)
Return the target number of threads for mesh renumbering.
Definition: cs_renumber.c:5258
Definition: cs_renumber.h:60
Definition: cs_renumber.h:69
cs_renumber_b_faces_type_t
Boundary faces renumbering algorithm types.
Definition: cs_renumber.h:73
Definition: cs_renumber.h:85
Definition: cs_renumber.h:58
cs_renumber_cells_type_t
Cell renumbering algorithm types.
Definition: cs_renumber.h:51
Definition: cs_renumber.h:77
#define BEGIN_C_DECLS
Definition: cs_defs.h:461
Definition: cs_renumber.h:76
void cs_renumber_set_n_threads(int n_threads)
Set the target number of threads for mesh renumbering.
Definition: cs_renumber.c:5237
cs_renumber_i_faces_type_t
Interior faces renumbering algorithm types.
Definition: cs_renumber.h:64
Definition: cs_renumber.h:67
void cs_renumber_b_faces(cs_mesh_t *mesh)
Renumber boundary faces for vectorization or threading depending on code options and target machine...
Definition: cs_renumber.c:5574
Definition: cs_mesh.h:63
Definition: cs_renumber.h:59
Definition: cs_renumber.h:56
Definition: cs_renumber.h:55
Definition: cs_renumber.h:75
void cs_renumber_get_min_subset_size(cs_lnum_t *min_i_subset_size, cs_lnum_t *min_b_subset_size)
Get the minimum sunset sizes when renumbering for threads.
Definition: cs_renumber.c:5297
void cs_renumber_get_algorithm(bool *halo_adjacent_cells_last, bool *halo_adjacent_faces_last, cs_renumber_ordering_t *i_faces_base_ordering, cs_renumber_cells_type_t *cells_pre_numbering, cs_renumber_cells_type_t *cells_numbering, cs_renumber_i_faces_type_t *i_faces_numbering, cs_renumber_b_faces_type_t *b_faces_numbering)
Return the algorithms for mesh renumbering.
Definition: cs_renumber.c:5366
Definition: cs_renumber.h:57
void cs_renumber_b_faces_by_gnum(cs_mesh_t *mesh)
Definition: cs_renumber.c:5620
void cs_renumber_cells(cs_mesh_t *mesh)
Renumber cells depending on code options and target machine.
Definition: cs_renumber.c:5442
Definition: cs_renumber.h:66
void cs_renumber_i_faces(cs_mesh_t *mesh)
Renumber interior faces for vectorization or threading depending on code options and target machine...
Definition: cs_renumber.c:5492
int cs_lnum_t
local mesh entity id
Definition: cs_defs.h:293
#define END_C_DECLS
Definition: cs_defs.h:462
Definition: cs_renumber.h:68
void cs_renumber_set_min_subset_size(cs_lnum_t min_i_subset_size, cs_lnum_t min_b_subset_size)
Set the minimum sunset sizes when renumbering for threads.
Definition: cs_renumber.c:5278
Definition: cs_renumber.h:54
cs_renumber_ordering_t
Ordering options for adjacency arrays.
Definition: cs_renumber.h:83
void cs_renumber_mesh(cs_mesh_t *mesh)
Renumber mesh elements for vectorization or threading depending on code options and target machine...
Definition: cs_renumber.c:5409
Definition: mesh.f90:26
void cs_renumber_set_algorithm(bool halo_adjacent_cells_last, bool halo_adjacent_faces_last, cs_renumber_ordering_t i_faces_base_ordering, cs_renumber_cells_type_t cells_pre_numbering, cs_renumber_cells_type_t cells_numbering, cs_renumber_i_faces_type_t i_faces_numbering, cs_renumber_b_faces_type_t b_faces_numbering)
Select the algorithm for mesh renumbering.
Definition: cs_renumber.c:5326