p4est  2.8.643-dbc7-dirty
p4est is a software library for parallel adaptive mesh refinement.
p8est_algorithms.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 
33 #ifndef P8EST_ALGORITHMS_H
34 #define P8EST_ALGORITHMS_H
35 
36 #include <p8est.h>
37 #include <p8est_extended.h>
38 
39 SC_EXTERN_C_BEGIN;
40 
47  p4est_topidx_t which_tree,
48  p8est_quadrant_t * quad,
49  p8est_init_t init_fn);
50 
55  p8est_quadrant_t * quad);
56 
65 unsigned p8est_quadrant_checksum (sc_array_t * quadrants,
66  sc_array_t * checkarray,
67  size_t first_quadrant);
68 
85  const p8est_quadrant_t * ld,
86  const p8est_quadrant_t *
87  quadrant);
88 
94 
100 
106 
112  int check_linearity);
113 
127 void p8est_tree_print (int log_priority, p8est_tree_t * tree);
128 
135 int p8est_is_equal (p8est_t * p8est1, p8est_t * p8est2,
136  int compare_data);
137 
150 
170  sc_array_t * in,
171  sc_array_t * out,
173  balance,
174  sc_array_t * borders,
175  sc_array_t * inseeds);
176 
182 
189  p4est_topidx_t which_tree);
190 
211  const p8est_quadrant_t * q1,
212  int include_q1,
213  const p8est_quadrant_t * q2,
214  int include_q2,
215  p8est_tree_t * tree,
216  p4est_topidx_t which_tree,
217  p8est_init_t init_fn);
218 
230  p4est_topidx_t which_tree,
231  p8est_init_t init_fn);
232 
242  p8est_connect_type_t btype,
243  p4est_topidx_t which_tree,
244  p8est_init_t init_fn);
245 
246 void p8est_balance_border (p8est_t * p8est,
247  p8est_connect_type_t btype,
248  p4est_topidx_t which_tree,
249  p8est_init_t init_fn,
250  p8est_replace_t replace_fn,
251  sc_array_t * borders);
252 
263  p8est_tree_t * tree);
264 
285  partition,
286  int num_procs,
287  int rank,
289  min_quadrant_id,
291  max_quadrant_id);
292 
306  num_quadrants_in_proc);
307 
319  int num_procs,
321  num_quadrants_in_proc);
322 
334  const p4est_locidx_t *
335  num_quadrants_in_proc);
336 
337 SC_EXTERN_C_END;
338 
339 #endif /* !P8EST_ALGORITHMS_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
int64_t p4est_gloidx_t
Typedef for globally unique indexing of quadrants.
Definition: p4est_base.h:118
The top-level 3D p8est interface.
void(* p8est_init_t)(p8est_t *p8est, p4est_topidx_t which_tree, p8est_quadrant_t *quadrant)
Callback function prototype to initialize the quadrant's user data.
Definition: p8est.h:199
int p8est_tree_is_almost_sorted(p8est_tree_t *tree, int check_linearity)
Check if a tree is sorted/linear except across edges or corners.
int p8est_quadrant_in_range(const p8est_quadrant_t *fd, const p8est_quadrant_t *ld, const p8est_quadrant_t *quadrant)
Report whether a quadrant fits into the limits of a quadrant range.
int p8est_is_equal(p8est_t *p8est1, p8est_t *p8est2, int compare_data)
Locally check forest/connectivity structures for equality.
void p8est_quadrant_init_data(p8est_t *p8est, p4est_topidx_t which_tree, p8est_quadrant_t *quad, p8est_init_t init_fn)
Alloc and initialize the user data of a valid quadrant.
void p8est_tree_compute_overlap(p8est_t *p8est, sc_array_t *in, sc_array_t *out, p8est_connect_type_t balance, sc_array_t *borders, sc_array_t *inseeds)
Compute the overlap of a number of insulation layers with a tree.
void p8est_tree_print(int log_priority, p8est_tree_t *tree)
Print the quadrants in a tree.
void p8est_tree_uniqify_overlap(sc_array_t *out)
Gets the reduced representation of the overlap that results from using p8est_tree_compute_overlap_new...
p4est_gloidx_t p8est_partition_for_coarsening(p8est_t *p8est, p4est_locidx_t *num_quadrants_in_proc)
Correct partition counters to allow one level of coarsening.
void p8est_quadrant_free_data(p8est_t *p8est, p8est_quadrant_t *quad)
Free the user data of a valid quadrant.
int p8est_tree_is_linear(p8est_tree_t *tree)
Test if a tree is sorted in Morton ordering and linear.
p4est_locidx_t p8est_partition_correction(p4est_gloidx_t *partition, int num_procs, int rank, p4est_gloidx_t min_quadrant_id, p4est_gloidx_t max_quadrant_id)
Compute correction of partition for a process.
int p8est_tree_is_complete(p8est_tree_t *tree)
Test if a tree is sorted in Morton ordering and complete.
void p8est_complete_subtree(p8est_t *p8est, p4est_topidx_t which_tree, p8est_init_t init_fn)
Completes a sorted tree within a p8est.
unsigned p8est_quadrant_checksum(sc_array_t *quadrants, sc_array_t *checkarray, size_t first_quadrant)
Computes a machine-independent checksum of a list of quadrants.
size_t p8est_tree_remove_nonowned(p8est_t *p8est, p4est_topidx_t which_tree)
Removes quadrants that are outside the owned tree boundaries from a tree.
int p8est_next_nonempty_process(int rank, int num_procs, p4est_locidx_t *num_quadrants_in_proc)
Find next non-empty process.
p4est_gloidx_t p8est_partition_given(p8est_t *p8est, const p4est_locidx_t *num_quadrants_in_proc)
Partition p8est given the number of quadrants per proc.
int p8est_is_valid(p8est_t *p8est)
Check a forest for validity and allreduce the result.
size_t p8est_linearize_tree(p8est_t *p8est, p8est_tree_t *tree)
Remove overlaps from a sorted list of quadrants.
void p8est_balance_subtree(p8est_t *p8est, p8est_connect_type_t btype, p4est_topidx_t which_tree, p8est_init_t init_fn)
Balances a sorted tree within a p8est.
void p8est_complete_region(p8est_t *p8est, const p8est_quadrant_t *q1, int include_q1, const p8est_quadrant_t *q2, int include_q2, p8est_tree_t *tree, p4est_topidx_t which_tree, p8est_init_t init_fn)
Constructs a minimal linear octree between two octants.
int p8est_tree_is_sorted(p8est_tree_t *tree)
Test if a tree is sorted in Morton ordering.
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
The 3D quadrant (i.e., octant) datatype.
Definition: p8est.h:68
The p8est tree datatype.
Definition: p8est.h:111
The p8est forest datatype.
Definition: p8est.h:132