src/p8est_geometry.h File Reference

tranforms from vertex frame to physical space More...

#include <p4est_base.h>

Include dependency graph for p8est_geometry.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	p8est_geometry_t
	This structure can be created by the user, p4est will never change its contents. More...
Typedefs
typedef void(*	p8est_geometry_X_t )(p8est_geometry_t *geom, p4est_topidx_t which_tree, const double abc[3], double xyz[3])
	Forward transformation from vertex frame to physical space.
Functions
p8est_geometry_t *	p8est_geometry_new_identity (void)
	Create a geometry structure for the identity transformation.
p8est_geometry_t *	p8est_geometry_new_shell (double R2, double R1)
	Create a geometry structure for the spherical shell of 24 trees.
p8est_geometry_t *	p8est_geometry_new_sphere (double R2, double R1, double R0)
	Create a geometry structure for the solid sphere of 13 trees.

---

Detailed Description

tranforms from vertex frame to physical space

---

Typedef Documentation

typedef void(* p8est_geometry_X_t)(p8est_geometry_t *geom, p4est_topidx_t which_tree, const double abc[3], double xyz[3])

Forward transformation from vertex frame to physical space.

The vertex space "abc" is defined per octree and spanned by the vertices at its corners; see p8est_connectivity.h. The physical space "xyz" is user-defined, currently used for VTK output.

---

Function Documentation

p8est_geometry_t* p8est_geometry_new_identity

(

void

)

Create a geometry structure for the identity transformation.

This function is just for demonstration since a NULL geometry works too.

Returns:

Geometry structure which must be freed with P4EST_FREE.

p8est_geometry_t* p8est_geometry_new_shell	(	double	R2,
		double	R1
	)

Create a geometry structure for the spherical shell of 24 trees.

This is suitable for forests obtained with p8est_connectivity_new_shell.

Parameters:

[in]	R2	The outer radius of the shell.
[in]	R1	The inner radius of the shell.

Returns:

Geometry structure which must be freed with P4EST_FREE.

p8est_geometry_t* p8est_geometry_new_sphere	(	double	R2,
		double	R1,
		double	R0
	)

Create a geometry structure for the solid sphere of 13 trees.

This is suitable for forests obtained with p8est_connectivity_new_sphere.

Parameters:

[in]	R2	The outer radius of the sphere.
[in]	R1	The outer radius of the inner shell.
[in]	R0	The inner radius of the inner shell.

Returns:

Geometry structure which must be freed with P4EST_FREE.