p4est  2.8.7
p4est is a software library for parallel adaptive mesh refinement.
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
p6est_ghost.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 P6EST_GHOST_H
26 #define P6EST_GHOST_H
27 
35 #include <p6est.h>
36 #include <p4est_ghost.h>
37 
38 SC_EXTERN_C_BEGIN;
39 
41 typedef struct p6est_ghost
42 {
43  int mpisize;
44  p4est_topidx_t num_trees;
48  sc_array_t *column_layer_offsets;
60  sc_array_t ghosts;
68  sc_array_t mirrors;
86 }
88 
94 
107  p4est_connect_type_t btype);
108 
116  p6est_ghost_t * ghost);
117 
120 
130  int which_proc,
131  p4est_topidx_t which_tree,
132  const p4est_quadrant_t * column,
133  const p2est_quadrant_t * layer);
134 
144  int which_proc,
145  p4est_topidx_t which_tree,
146  const p4est_quadrant_t * column,
147  const p2est_quadrant_t * layer);
148 
172  p6est_ghost_t * ghost,
173  p4est_topidx_t treeid,
174  const p4est_quadrant_t * column,
175  const p2est_quadrant_t * layer,
176  sc_array_t * exists_arr,
177  sc_array_t * rproc_arr,
178  sc_array_t * rquad_arr);
179 
189  p8est_connect_type_t btype);
190 
197  p6est_ghost_t * ghost);
198 
199 SC_EXTERN_C_END;
200 
201 #endif /* P6EST_GHOST_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
p4est_connect_type_t
Characterize a type of adjacency.
Definition: p4est_connectivity.h:113
Passing quadrants and data to neighboring processes.
A hybrid 2D+1D AMR extension.
int p6est_layer_exists(p6est_t *p6est, p6est_ghost_t *ghost, p4est_topidx_t treeid, const p4est_quadrant_t *column, const p2est_quadrant_t *layer, sc_array_t *exists_arr, sc_array_t *rproc_arr, sc_array_t *rquad_arr)
Checks if layer exists in the local forest or the ghost layer.
ssize_t p6est_ghost_bsearch(p6est_ghost_t *ghost, int which_proc, p4est_topidx_t which_tree, const p4est_quadrant_t *column, const p2est_quadrant_t *layer)
Conduct binary search for exact match on a range of the ghost layer.
int p6est_is_balanced(p6est_t *p6est, p8est_connect_type_t btype)
Check a forest to see if it is balanced.
void p6est_ghost_expand(p6est_t *p6est, p6est_ghost_t *ghost)
Expand the size of the ghost layer and mirrors by one additional layer of adjacency.
unsigned p6est_ghost_checksum(p6est_t *p6est, p6est_ghost_t *ghost)
Compute the parallel checksum of a ghost layer.
void p6est_ghost_destroy(p6est_ghost_t *ghost)
Frees all memory used for the ghost layer.
p6est_ghost_t * p6est_ghost_new(p6est_t *p4est, p4est_connect_type_t btype)
Builds the ghost layer.
size_t p6est_ghost_memory_used(p6est_ghost_t *ghost)
Calculate the memory usage of the ghost layer.
ssize_t p6est_ghost_contains(p6est_ghost_t *ghost, int which_proc, p4est_topidx_t which_tree, const p4est_quadrant_t *column, const p2est_quadrant_t *layer)
Conduct binary search for ancestor on range of the ghost layer.
struct p6est_ghost p6est_ghost_t
columns of layers that neighbor the local domain
p8est_connect_type_t
Characterize a type of adjacency.
Definition: p8est_connectivity.h:120
A 1D quadrant datatype: this is used to encode a "layer" of a column in the 2D+1D AMR scheme.
Definition: p6est.h:129
Quadrants that neighbor the local domain.
Definition: p4est_ghost.h:46
The 2D quadrant datatype.
Definition: p4est.h:76
The p4est forest datatype.
Definition: p4est.h:150
columns of layers that neighbor the local domain
Definition: p6est_ghost.h:42
sc_array_t ghosts
An array of column-layers which make up the ghost layer around p6est.
Definition: p6est_ghost.h:60
p4est_ghost_t * column_ghost
describes the ghost columns
Definition: p6est_ghost.h:47
p4est_locidx_t * proc_offsets
mpisize + 1 ghost indices
Definition: p6est_ghost.h:62
p4est_locidx_t * mirror_proc_fronts
like mirror_proc_mirrors, but limited to the outermost octants.
Definition: p6est_ghost.h:76
p4est_locidx_t * mirror_proc_front_offsets
NULL until p4est_ghost_expand is called.
Definition: p6est_ghost.h:82
p4est_locidx_t * tree_offsets
num_trees + 1 ghost indices
Definition: p6est_ghost.h:61
p4est_locidx_t * mirror_proc_offsets
mpisize + 1 indices into mirror_proc_mirrors
Definition: p6est_ghost.h:73
p4est_connect_type_t btype
which neighboring columns are in the ghost layer
Definition: p6est_ghost.h:45
p4est_locidx_t * mirror_proc_mirrors
indices into mirrors grouped by outside processor rank and ascending within each rank
Definition: p6est_ghost.h:70
sc_array_t mirrors
An array of local quadrants that touch the parallel boundary from the inside, i.e....
Definition: p6est_ghost.h:68
p4est_locidx_t * mirror_tree_offsets
num_trees + 1 mirror indices
Definition: p6est_ghost.h:69
sc_array_t * column_layer_offsets
array of p4est_locidx_t type: the offset of each ghost columns within the ghosts array of column-laye...
Definition: p6est_ghost.h:48
The p6est forest datatype.
Definition: p6est.h:167