p4est  1.1
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Structures | Typedefs | Functions
p4est_geometry.h File Reference

transforms from vertex frame to physical space More...

#include <p4est_connectivity.h>

Go to the source code of this file.

Data Structures

struct  p4est_geometry_t
 This structure can be filled or allocated by the user. More...
 

Typedefs

typedef void(* p4est_geometry_X_t )(p4est_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. More...
 
typedef void(* p4est_geometry_destroy_t )(p4est_geometry_t *geom)
 Destructor prototype for a user-allocated p4est_geometry_t. More...
 

Functions

void p4est_geometry_destroy (p4est_geometry_t *geom)
 Can be used to conveniently destroy a geometry structure. More...
 
p4est_geometry_t * p4est_geometry_new_connectivity (p4est_connectivity_t *conn)
 Create a geometry structure based on the vertices in a connectivity. More...
 

Detailed Description

transforms from vertex frame to physical space

Typedef Documentation

typedef void(* p4est_geometry_destroy_t)(p4est_geometry_t *geom)

Destructor prototype for a user-allocated p4est_geometry_t.

It is invoked by p4est_geometry_destroy. If the user chooses to reserve the structure statically, simply don't call p4est_geometry_destroy.

typedef void(* p4est_geometry_X_t)(p4est_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.

Note that the two-dimensional connectivities have 3D vertex coordinates that can be used in the transformation if so desired. The physical space "xyz" is user-defined, currently used for VTK output.

Function Documentation

void p4est_geometry_destroy ( p4est_geometry_t *  geom)

Can be used to conveniently destroy a geometry structure.

The user is free not to call this function at all if they handle the memory of the p4est_geometry_t in their own way.

p4est_geometry_t* p4est_geometry_new_connectivity ( p4est_connectivity_t conn)

Create a geometry structure based on the vertices in a connectivity.

The transformation is constructed using bilinear interpolation.

Parameters
[in]connA p4est_connectivity_t with valid vertices. We do NOT take ownership and expect this structure to stay alive.
Returns
Geometry structure; use with p4est_geometry_destroy.