Inheritance diagram for t8_geometry_analytic:
Public Member Functions | |
| t8_geometry_analytic (int dim, const char *name, t8_geom_analytic_fn analytical, t8_geom_analytic_jacobian_fn jacobian, t8_geom_load_tree_data_fn load_tree_data, const void *user_data) | |
| Constructor of the analytic geometry with a given dimension. More... | |
| virtual | ~t8_geometry_analytic () |
| The destructor. More... | |
| t8_geometry_type_t | t8_geom_get_type () const |
| Get the type of this geometry. More... | |
| virtual void | t8_geom_evaluate (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, const size_t num_coords, double *out_coords) const |
| Maps points in the reference space \( [0,1]^\mathrm{dim} \to \mathbb{R}^3 \). More... | |
| virtual void | t8_geom_evaluate_jacobian (t8_cmesh_t cmesh, t8_gloidx_t gtreeid, const double *ref_coords, const size_t num_coords, double *jacobian) const |
| Compute the jacobian of the t8_geom_evaluate map at a point in the reference space \( [0,1]^\mathrm{dim} \). More... | |
| virtual void | t8_geom_load_tree_data (t8_cmesh_t cmesh, t8_gloidx_t gtreeid) |
| Update a possible internal data buffer for per tree data. More... | |
| const void * | t8_geom_analytic_get_user_data () |
 Public Member Functions inherited from t8_geometry | |
| t8_geometry (int dimension, const char *name, const char *attribute_name=NULL) | |
| virtual | ~t8_geometry () |
| The destructor. More... | |
| int | t8_geom_get_dimension () const |
| Get the dimension of this geometry. More... | |
| const char * | t8_geom_get_name () const |
| Get the name of this geometry. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from t8_geometry | |
| int | dimension |
| The dimension of reference space for which this is a geometry. | |
| const char * | name |
| The name of this geometry. | |
Constructor & Destructor Documentation
◆ t8_geometry_analytic()
| t8_geometry_analytic::t8_geometry_analytic | ( | int | dim, |
| const char * | name, | ||
| t8_geom_analytic_fn | analytical, | ||
| t8_geom_analytic_jacobian_fn | jacobian, | ||
| t8_geom_load_tree_data_fn | load_tree_data, | ||
| const void * | user_data | ||
| ) |
Constructor of the analytic geometry with a given dimension.
The geometry is viable with all tree types and uses a user-provided analytic and jacobian function. The actual mappings are done by these functions.
- Parameters
-
[in] dim The dimension of this geometry. [in] name The name to give this geometry. [in] analytical The analytical function to use for this geometry. [in] jacobian The jacobian of analytical. [in] load_tree_data The function that is used to load a tree's data.
◆ ~t8_geometry_analytic()
|
inlinevirtual |
The destructor.
Clears the allocated memory.
Member Function Documentation
◆ t8_geom_evaluate()
|
virtual |
Maps points in the reference space \( [0,1]^\mathrm{dim} \to \mathbb{R}^3 \).
- Parameters
-
[in] cmesh The cmesh in which the point lies. [in] gtreeid The global tree (of the cmesh) in which the reference point is. [in] ref_coords Array of dimension x num_coords many entries, specifying points in \( [0,1]^\mathrm{dim} \). [in] num_coords Amount of points of /f$ \mathrm{dim} /f$ to map. [out] out_coords The mapped coordinates in physical space of ref_coords. The length is num_coords * 3.
Implements t8_geometry.
◆ t8_geom_evaluate_jacobian()
|
virtual |
Compute the jacobian of the t8_geom_evaluate map at a point in the reference space \( [0,1]^\mathrm{dim} \).
- Parameters
-
[in] cmesh The cmesh in which the point lies. [in] gtreeid The global tree (of the cmesh) in which the reference point is. [in] ref_coords Array of dimension x num_coords many entries, specifying points in \( [0,1]^\mathrm{dim} \). [in] num_coords Amount of points of /f$ \mathrm{dim} /f$ to map. [out] jacobian The jacobian at ref_coords. Array of size \( \mathrm{dim} \cdot 3 \) x num_coords. Indices \( 3 \cdot i\) , \( 3 \cdot i+1 \) , \( 3 \cdot i+2 \) correspond to the \( i \)-th column of the jacobian (Entry \( 3 \cdot i + j \) is \( \frac{\partial f_j}{\partial x_i} \)).
- Note
- The jacobian will be (1) (1 0) (1 0 0) dim 1: J = (0) dim 2: J = (0 1) dim 3: J = (0 1 0) (0) (0 0) (0 0 1)
Implements t8_geometry.
◆ t8_geom_get_type()
|
inlinevirtual |
◆ t8_geom_load_tree_data()
|
virtual |
Update a possible internal data buffer for per tree data.
This function is called before the first coordinates in a new tree are evaluated. You can use it for example to load the vertex coordinates of the tree into an internal buffer (as is done in the linear geometry).
- Parameters
-
[in] cmesh The cmesh. [in] gtreeid The global tree.
Implements t8_geometry.
The documentation for this struct was generated from the following files:
- src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.hxx
- src/t8_geometry/t8_geometry_implementations/t8_geometry_analytic.cxx