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
p8est_build.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  Written by Carsten Burstedde, Lucas C. Wilcox, and Tobin Isaac
8 
9  p4est is free software; you can redistribute it and/or modify
10  it under the terms of the GNU General Public License as published by
11  the Free Software Foundation; either version 2 of the License, or
12  (at your option) any later version.
13 
14  p4est is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  GNU General Public License for more details.
18 
19  You should have received a copy of the GNU General Public License
20  along with p4est; if not, write to the Free Software Foundation, Inc.,
21  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 */
23 
24 #ifndef P8EST_BUILD_H
25 #define P8EST_BUILD_H
26 
27 #include <p8est.h>
28 
29 SC_EXTERN_C_BEGIN;
30 
43 typedef struct p8est_build p8est_build_t;
44 
58  size_t data_size,
59  p8est_init_t init_fn,
60  void *user_pointer);
61 
69  p8est_init_t add_init_fn);
70 
90  p4est_topidx_t which_tree,
91  p8est_quadrant_t * quadrant);
92 
99 
100 SC_EXTERN_C_END;
101 
102 #endif /* ! P8EST_BUILD_H */
int32_t p4est_topidx_t
Typedef for counting topological entities (trees, tree vertices).
Definition: p4est_base.h:93
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:213
int p8est_build_add(p8est_build_t *build, p4est_topidx_t which_tree, p8est_quadrant_t *quadrant)
This function is usable from a p8est_search_local_t callback.
p8est_t * p8est_build_complete(p8est_build_t *build)
Finalize the construction of the new forest after adding quadrants.
struct p8est_build p8est_build_t
Context object for building a new p4est from individual quadrants.
Definition: p8est_build.h:43
void p8est_build_init_add(p8est_build_t *build, p8est_init_t add_init_fn)
Set a dedicated initialization callback for manually added quadrants.
p8est_build_t * p8est_build_new(p8est_t *from, size_t data_size, p8est_init_t init_fn, void *user_pointer)
Allocate a context for building a new forest.
The 3D quadrant (i.e., octant) datatype.
Definition: p8est.h:72
The p8est forest datatype.
Definition: p8est.h:146