p4est  2.8.643-dbc7-dirty
p4est is a software library for parallel adaptive mesh refinement.
p4est_iterate.h
Go to the documentation of this file.
1 /*
2  This file is part of p4est.
3  p4est is a C library to manage a collection (a forest) of multiple
4  connected adaptive quadtrees or octrees in parallel.
5 
6  Copyright (C) 2010 The University of Texas System
7  Additional copyright (C) 2011 individual authors
8  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
9 
10  p4est is free software; you can redistribute it and/or modify
11  it under the terms of the GNU General Public License as published by
12  the Free Software Foundation; either version 2 of the License, or
13  (at your option) any later version.
14 
15  p4est is distributed in the hope that it will be useful,
16  but WITHOUT ANY WARRANTY; without even the implied warranty of
17  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  GNU General Public License for more details.
19 
20  You should have received a copy of the GNU General Public License
21  along with p4est; if not, write to the Free Software Foundation, Inc.,
22  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 */
24 
32 #ifndef P4EST_ITERATE_H
33 #define P4EST_ITERATE_H
34 
35 #include <p4est.h>
36 #include <p4est_ghost.h>
37 
38 SC_EXTERN_C_BEGIN;
39 
47 typedef struct p4est_iter_volume_info
48 {
49  p4est_t *p4est;
50  p4est_ghost_t *ghost_layer;
55 }
57 
64  void *user_data);
65 
75 typedef struct p4est_iter_face_side
76 {
78  int8_t face;
80  int8_t is_hanging;
83  {
84  struct
85  {
86  int8_t is_ghost;
89  }
90  full;
92  struct
93  {
94  int8_t is_ghost[2];
97  }
98  hanging;
100  }
101  is;
102 }
104 
116 typedef struct p4est_iter_face_info
117 {
118  p4est_t *p4est;
119  p4est_ghost_t *ghost_layer;
120  int8_t orientation;
123  int8_t tree_boundary;
125  sc_array_t sides; /* array of p4est_iter_face_side_t type */
126 }
128 
140  void *user_data);
141 
153 {
155  int8_t corner;
157  int8_t is_ghost;
158  p4est_quadrant_t *quad;
160  int8_t faces[2];
161 }
163 
174 {
175  p4est_t *p4est;
176  p4est_ghost_t *ghost_layer;
177  int8_t tree_boundary;
180 }
182 
196  void *user_data);
197 
234  p4est_ghost_t * ghost_layer,
235  void *user_data,
236  p4est_iter_volume_t iter_volume,
237  p4est_iter_face_t iter_face,
238  p4est_iter_corner_t iter_corner);
239 
242 /*@unused@*/
243 static inline p4est_iter_corner_side_t *
244 p4est_iter_cside_array_index_int (sc_array_t * array, int it)
245 {
246  P4EST_ASSERT (array->elem_size == sizeof (p4est_iter_corner_side_t));
247  P4EST_ASSERT (it >= 0 && (size_t) it < array->elem_count);
248 
249  return (p4est_iter_corner_side_t *)
250  (array->array + sizeof (p4est_iter_corner_side_t) * (size_t) it);
251 }
252 
255 /*@unused@*/
256 static inline p4est_iter_corner_side_t *
257 p4est_iter_cside_array_index (sc_array_t * array, size_t it)
258 {
259  P4EST_ASSERT (array->elem_size == sizeof (p4est_iter_corner_side_t));
260  P4EST_ASSERT (it < array->elem_count);
261 
262  return (p4est_iter_corner_side_t *)
263  (array->array + sizeof (p4est_iter_corner_side_t) * it);
264 }
265 
268 /*@unused@*/
269 static inline p4est_iter_face_side_t *
270 p4est_iter_fside_array_index_int (sc_array_t * array, int it)
271 {
272  P4EST_ASSERT (array->elem_size == sizeof (p4est_iter_face_side_t));
273  P4EST_ASSERT (it >= 0 && (size_t) it < array->elem_count);
274 
275  return (p4est_iter_face_side_t *)
276  (array->array + sizeof (p4est_iter_face_side_t) * (size_t) it);
277 }
278 
281 /*@unused@*/
282 static inline p4est_iter_face_side_t *
283 p4est_iter_fside_array_index (sc_array_t * array, size_t it)
284 {
285  P4EST_ASSERT (array->elem_size == sizeof (p4est_iter_face_side_t));
286  P4EST_ASSERT (it < array->elem_count);
287 
288  return (p4est_iter_face_side_t *)
289  (array->array + sizeof (p4est_iter_face_side_t) * it);
290 }
291 
292 SC_EXTERN_C_END;
293 
294 #endif /* !P4EST_ITERATE_H */
The top-level 2D p4est interface.
int32_t p4est_topidx_t
Typedef for counting topological entities (trees, tree vertices).
Definition: p4est_base.h:93
int32_t p4est_locidx_t
Typedef for processor-local indexing of quadrants and nodes.
Definition: p4est_base.h:106
passing quadrants and data to neighboring processes
void(* p4est_iter_corner_t)(p4est_iter_corner_info_t *info, void *user_data)
The prototype for a function that p4est_iterate will execute wherever quadrants meet at a conformal c...
Definition: p4est_iterate.h:195
struct p4est_iter_face_info p4est_iter_face_info_t
The information that is available to the user-defined p4est_iter_face_t callback.
struct p4est_iter_volume_info p4est_iter_volume_info_t
The information that is available to the user-defined p4est_iter_volume_t callback function.
struct p4est_iter_corner_info p4est_iter_corner_info_t
The information that is available to the user-defined p4est_iter_corner_t callback.
struct p4est_iter_corner_side p4est_iter_corner_side_t
Information about one side of a corner in the forest.
void p4est_iterate(p4est_t *p4est, p4est_ghost_t *ghost_layer, void *user_data, p4est_iter_volume_t iter_volume, p4est_iter_face_t iter_face, p4est_iter_corner_t iter_corner)
Execute user supplied callbacks at every volume, face, and corner in the local forest.
void(* p4est_iter_volume_t)(p4est_iter_volume_info_t *info, void *user_data)
The prototype for a function that p4est_iterate will execute at every quadrant local to the current p...
Definition: p4est_iterate.h:63
void(* p4est_iter_face_t)(p4est_iter_face_info_t *info, void *user_data)
The prototype for a function that p4est_iterate will execute wherever two quadrants share a face: the...
Definition: p4est_iterate.h:139
struct p4est_iter_face_side p4est_iter_face_side_t
Information about one side of a face in the forest.
quadrants that neighbor the local domain
Definition: p4est_ghost.h:41
The information that is available to the user-defined p4est_iter_corner_t callback.
Definition: p4est_iterate.h:174
sc_array_t sides
array of type p4est_iter_corner_side_t type
Definition: p4est_iterate.h:179
int8_t tree_boundary
boolean: interior face (0), tree boundary face (true)
Definition: p4est_iterate.h:177
Information about one side of a corner in the forest.
Definition: p4est_iterate.h:153
p4est_locidx_t quadid
the index in the tree or ghost array
Definition: p4est_iterate.h:159
int8_t corner
which of the quadrant's corners touches this corner
Definition: p4est_iterate.h:155
p4est_topidx_t treeid
the tree that contains quad
Definition: p4est_iterate.h:154
int8_t faces[2]
internal work data
Definition: p4est_iterate.h:160
int8_t is_ghost
boolean: local (0) or ghost (1)
Definition: p4est_iterate.h:157
The information that is available to the user-defined p4est_iter_face_t callback.
Definition: p4est_iterate.h:117
int8_t orientation
the orientation of the sides to each other, as in the definition of p4est_connectivity_t
Definition: p4est_iterate.h:120
int8_t tree_boundary
boolean: interior face (0), tree boundary face (true)
Definition: p4est_iterate.h:123
Information about one side of a face in the forest.
Definition: p4est_iterate.h:76
int8_t face
which quadrant side the face touches
Definition: p4est_iterate.h:78
p4est_topidx_t treeid
the tree on this side
Definition: p4est_iterate.h:77
int8_t is_hanging
boolean: one full quad (0) or two smaller quads (1)
Definition: p4est_iterate.h:80
The information that is available to the user-defined p4est_iter_volume_t callback function.
Definition: p4est_iterate.h:48
p4est_quadrant_t * quad
the quadrant of the callback
Definition: p4est_iterate.h:51
p4est_locidx_t quadid
id in quad's tree array (see p4est_tree_t)
Definition: p4est_iterate.h:52
p4est_topidx_t treeid
the tree containing quad
Definition: p4est_iterate.h:54
The 2D quadrant datatype.
Definition: p4est.h:72
The p4est forest datatype.
Definition: p4est.h:136
size_t elem_size
char * array
struct p4est_iter_face_side::p4est_iter_face_side_data::@3 full
if is_hanging = 0, use is.full to access per-quadrant data
p4est_quadrant_t * quad
the actual quadrant
Definition: p4est_iterate.h:87
p4est_locidx_t quadid
index in tree or ghost array
Definition: p4est_iterate.h:88
int8_t is_ghost
boolean: local (0) or ghost (1)
Definition: p4est_iterate.h:86
struct p4est_iter_face_side::p4est_iter_face_side_data::@4 hanging
if is_hanging = 1, use is.hanging to access per-quadrant data