p4est  2.8.643-dbc7-dirty
p4est is a software library for parallel adaptive mesh refinement.
p8est_wrap.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 
25 #ifndef P8EST_WRAP_H
26 #define P8EST_WRAP_H
27 
35 #include <p8est_mesh.h>
36 #include <p8est_extended.h>
37 #include <sc_refcount.h>
38 
39 SC_EXTERN_C_BEGIN;
40 
41 /*** COMPLETE INTERNAL STATE OF P8EST ***/
42 
43 typedef enum p8est_wrap_flags
44 {
45  P8EST_WRAP_NONE = 0,
46  P8EST_WRAP_REFINE = 0x01,
47  P8EST_WRAP_COARSEN = 0x02
48 }
49 p8est_wrap_flags_t;
50 
51 typedef struct p8est_wrap
52 {
53  /* this member is never used or changed by p8est_wrap */
54  void *user_pointer;
58  int hollow;
59 
63 
67 
75  struct p8est_wrap *conn_owner;
76 
77  /* these members are considered public and read-only */
78  int p4est_dim;
79  int p4est_half;
80  int p4est_faces;
81  int p4est_children;
83  p8est_replace_t replace_fn;
86  /* anything below here is considered private und should not be touched */
87  int weight_exponent;
88  uint8_t *flags, *temp_flags;
89  p4est_locidx_t num_refine_flags, inside_counter, num_replaced;
90 
91  /* for ghost and mesh use p8est_wrap_get_ghost, _mesh declared below */
92  p8est_ghost_t *ghost;
93  p8est_mesh_t *mesh;
94  p8est_ghost_t *ghost_aux;
95  p8est_mesh_t *mesh_aux;
96  int match_aux;
97 }
99 
109  p8est_connectivity_t * conn,
110  int initial_level);
111 
126  p8est_connect_type_t btype,
127  p8est_replace_t replace_fn,
128  void *user_pointer);
129 
146  p8est_connectivity_t * conn,
147  int initial_level, int hollow,
148  p8est_connect_type_t btype,
149  p8est_replace_t replace_fn,
150  void *user_pointer);
151 
165  size_t data_size,
166  p8est_replace_t replace_fn,
167  void *user_pointer);
168 
173  int initial_level);
174 p8est_wrap_t *p8est_wrap_new_rotwrap (sc_MPI_Comm mpicomm,
175  int initial_level);
176 p8est_wrap_t *p8est_wrap_new_brick (sc_MPI_Comm mpicomm,
177  int bx, int by, int bz,
178  int px, int py, int pz,
179  int initial_level);
180 
182 p8est_wrap_t *p8est_wrap_new_world (int initial_level);
183 void p8est_wrap_destroy (p8est_wrap_t * pp);
184 
191 
208  int coarsen_delay,
209  int coarsen_affect);
210 
217 
224 
232  p4est_topidx_t which_tree,
233  p4est_locidx_t which_quad);
234 
242  p4est_topidx_t which_tree,
243  p4est_locidx_t which_quad);
244 
256 
285  int weight_exponent,
286  p4est_locidx_t * unchanged_first,
287  p4est_locidx_t * unchanged_length,
289  unchanged_old_first);
290 
298 
299 /*** ITERATOR OVER THE FOREST LEAVES ***/
300 
301 typedef struct p8est_wrap_leaf
302 {
305  /* Information about the current quadrant */
312 #if 0 /* DEPRECATED -- anyone using them? */
313  int level;
314  double lowerleft[3];
315  double upperright[3];
316 #endif
317 
318  /* Information about parallel neighbors */
319  int is_mirror;
323 }
325 
327 #define P8EST_LEAF_IS_FIRST_IN_TREE(wleaf) ((wleaf)->which_quad == 0)
328 
329 /* Create an iterator over the local leaves in the forest.
330  * Returns a newly allocated state containing the first leaf,
331  * or NULL if the local partition of the tree is empty.
332  * \param [in] pp Legal p8est_wrap structure, hollow or not.
333  * \param [in] track_mirrors If true, \a pp must not be hollow and mirror
334  * information from the ghost layer is stored.
335  * \return NULL if processor is empty, otherwise a leaf iterator for
336  * subsequent use with \a p8est_wrap_leaf_next.
337  */
338 p8est_wrap_leaf_t *p8est_wrap_leaf_first (p8est_wrap_t * pp,
339  int track_mirrors);
340 
341 /* Move the forest leaf iterator forward.
342  * \param [in,out] leaf A non-NULL leaf iterator created by
343  * \ref p8est_wrap_leaf_first.
344  * \return The state that was input with updated information for the
345  * next leaf, or NULL and deallocates the input if called with
346  * the last leaf on this processor.
347  */
348 p8est_wrap_leaf_t *p8est_wrap_leaf_next (p8est_wrap_leaf_t * leaf);
349 
350 SC_EXTERN_C_END;
351 
352 #endif /* !P8EST_WRAP_H */
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
p8est_connect_type_t
Characterize a type of adjacency.
Definition: p8est_connectivity.h:90
Interface routines with extended capabilities.
void(* p8est_replace_t)(p8est_t *p8est, p4est_topidx_t which_tree, int num_outgoing, p8est_quadrant_t *outgoing[], int num_incoming, p8est_quadrant_t *incoming[])
Callback function prototype to replace one set of quadrants with another.
Definition: p8est_extended.h:115
forest topology in a conventional mesh format
p8est_mesh_t * p8est_wrap_get_mesh(p8est_wrap_t *pp)
Return the appropriate mesh structure.
void p8est_wrap_complete(p8est_wrap_t *pp)
Free memory for the intermediate mesh.
p8est_wrap_t * p8est_wrap_new_world(int initial_level)
Passes sc_MPI_COMM_WORLD to p8est_wrap_new_unitcube.
void p8est_wrap_set_hollow(p8est_wrap_t *pp, int hollow)
Change hollow status of the wrap.
int p8est_wrap_adapt(p8est_wrap_t *pp)
Call p8est_refine, coarsen, and balance to update pp->p8est.
p8est_wrap_t * p8est_wrap_new_conn(sc_MPI_Comm mpicomm, p8est_connectivity_t *conn, int initial_level)
Create a p8est wrapper from a given connectivity structure.
void p8est_wrap_mark_coarsen(p8est_wrap_t *pp, p4est_topidx_t which_tree, p4est_locidx_t which_quad)
Mark a local element for coarsening.
void p8est_wrap_mark_refine(p8est_wrap_t *pp, p4est_topidx_t which_tree, p4est_locidx_t which_quad)
Mark a local element for refinement.
p8est_ghost_t * p8est_wrap_get_ghost(p8est_wrap_t *pp)
Return the appropriate ghost layer.
p8est_wrap_t * p8est_wrap_new_ext(sc_MPI_Comm mpicomm, p8est_connectivity_t *conn, int initial_level, int hollow, p8est_connect_type_t btype, p8est_replace_t replace_fn, void *user_pointer)
Create a p8est wrapper from a given connectivity structure.
int p8est_wrap_partition(p8est_wrap_t *pp, int weight_exponent, p4est_locidx_t *unchanged_first, p4est_locidx_t *unchanged_length, p4est_locidx_t *unchanged_old_first)
Call p8est_partition for equal leaf distribution.
p8est_wrap_t * p8est_wrap_new_unitcube(sc_MPI_Comm mpicomm, int initial_level)
Create p8est and auxiliary data structures.
p8est_wrap_t * p8est_wrap_new_p8est(p8est_t *p8est, int hollow, p8est_connect_type_t btype, p8est_replace_t replace_fn, void *user_pointer)
Create a wrapper for a given p8est structure.
void p8est_wrap_set_coarsen_delay(p8est_wrap_t *pp, int coarsen_delay, int coarsen_affect)
Set a parameter that delays coarsening after adaptation.
p8est_wrap_t * p8est_wrap_new_copy(p8est_wrap_t *source, size_t data_size, p8est_replace_t replace_fn, void *user_pointer)
Create a p8est wrapper from an existing one.
sc3_MPI_Comm_t sc_MPI_Comm
This structure holds the 3D inter-tree connectivity information.
Definition: p8est_connectivity.h:174
quadrants that neighbor the local domain
Definition: p8est_ghost.h:41
This structure contains complete mesh information on a 2:1 balanced forest.
Definition: p8est_mesh.h:135
The 3D quadrant (i.e., octant) datatype.
Definition: p8est.h:68
The p8est tree datatype.
Definition: p8est.h:111
Definition: p8est_wrap.h:302
p8est_quadrant_t * quad
Current quadrant.
Definition: p8est_wrap.h:311
p8est_wrap_t * pp
Must contain a valid ghost.
Definition: p8est_wrap.h:303
p4est_locidx_t nm
Internal: mirror counter.
Definition: p8est_wrap.h:321
p4est_locidx_t local_quad
Quadrant number relative to proc.
Definition: p8est_wrap.h:308
p4est_locidx_t next_mirror_quadrant
Internal: next.
Definition: p8est_wrap.h:322
p4est_topidx_t which_tree
Current tree number.
Definition: p8est_wrap.h:306
sc_array_t * tquadrants
Current tree's quadrants.
Definition: p8est_wrap.h:310
p4est_locidx_t which_quad
Quadrant number relative to tree.
Definition: p8est_wrap.h:307
p8est_tree_t * tree
Current tree.
Definition: p8est_wrap.h:309
sc_array_t * mirrors
If not NULL, from pp's ghost.
Definition: p8est_wrap.h:320
int is_mirror
Quadrant at parallel boundary?
Definition: p8est_wrap.h:319
Definition: p8est_wrap.h:52
p8est_t * p4est
p4est->user_pointer is used internally
Definition: p8est_wrap.h:84
sc_refcount_t conn_rc
This reference counter is a workaround for internal use only.
Definition: p8est_wrap.h:73
void * user_pointer
Convenience member for users.
Definition: p8est_wrap.h:54
int coarsen_affect
Boolean: If true, we delay coarsening not only after refinement, but also between subsequent coarseni...
Definition: p8est_wrap.h:66
int coarsen_delay
Non-negative integer tells us how many adaptations to wait before any given quadrant may be coarsened...
Definition: p8est_wrap.h:62
int hollow
If true, this wrap has NULL for ghost, mesh, and flag members.
Definition: p8est_wrap.h:58
The p8est forest datatype.
Definition: p8est.h:132