p4est 2.8.6
p4est is a software library for parallel adaptive mesh refinement.
p8est_geometry.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
38#ifndef P8EST_GEOMETRY_H
39#define P8EST_GEOMETRY_H
40
41#include <p8est_connectivity.h>
42
43SC_EXTERN_C_BEGIN;
44
47
51typedef void (*p8est_geometry_X_t) (p8est_geometry_t * geom,
52 p4est_topidx_t which_tree,
53 const double abc[3],
54 double xyz[3]);
55
61
66{
67 const char *name;
68 void *user;
73};
74
80
88 conn);
89
107 p4est_topidx_t which_tree,
108 const double abc[3], double xyz[3]);
109
118 double R2, double R1);
119
129 double R2, double R1,
130 double R0);
131
150 double R0, double R1,
151 double R2);
152
153SC_EXTERN_C_END;
154
155#endif /* !P8EST_GEOMETRY_H */
int32_t p4est_topidx_t
Typedef for counting topological entities (trees, tree vertices).
Definition: p4est_base.h:93
The connectivity defines the coarse topology of the forest.
void p8est_geometry_destroy(p8est_geometry_t *geom)
Can be used to conveniently destroy a geometry structure.
void(* p8est_geometry_destroy_t)(p8est_geometry_t *geom)
Destructor prototype for a user-allocated p8est_geometry_t.
Definition: p8est_geometry.h:60
p8est_geometry_t * p8est_geometry_new_shell(p8est_connectivity_t *conn, double R2, double R1)
Create a geometry structure for the spherical shell of 24 trees.
void(* p8est_geometry_X_t)(p8est_geometry_t *geom, p4est_topidx_t which_tree, const double abc[3], double xyz[3])
Forward transformation from the reference unit square to physical space.
Definition: p8est_geometry.h:51
p8est_geometry_t * p8est_geometry_new_torus(p8est_connectivity_t *conn, double R0, double R1, double R2)
Create a geometry structure for the torus.
void p8est_geometry_connectivity_X(p8est_geometry_t *geom, p4est_topidx_t which_tree, const double abc[3], double xyz[3])
Geometric coordinate transformation for geometry created with p8est_geometry_new_connectivity.
p8est_geometry_t * p8est_geometry_new_connectivity(p8est_connectivity_t *conn)
Create a geometry structure based on the vertices in a connectivity.
p8est_geometry_t * p8est_geometry_new_sphere(p8est_connectivity_t *conn, double R2, double R1, double R0)
Create a geometry structure for the solid sphere of 13 trees.
This structure holds the 3D inter-tree connectivity information.
Definition: p8est_connectivity.h:215
This structure can be created by the user, p4est will never change its contents.
Definition: p8est_geometry.h:66
const char * name
User's choice is arbitrary.
Definition: p8est_geometry.h:67
p8est_geometry_destroy_t destroy
Destructor called by p8est_geometry_destroy.
Definition: p8est_geometry.h:70
p8est_geometry_X_t X
Coordinate transformation.
Definition: p8est_geometry.h:69
void * user
User's choice is arbitrary.
Definition: p8est_geometry.h:68