t8  UNKNOWN
t8code is a C library to manage a forest of adaptive space-trees of general element classes in parallel.
Public Member Functions
t8_geometry_linear_axis_aligned Struct Reference
Inheritance diagram for t8_geometry_linear_axis_aligned:
t8_geometry_with_vertices t8_geometry

Public Member Functions

 t8_geometry_linear_axis_aligned (int dim)
 Constructor of the linear, axis-aligned geometry with a given dimension. More...
 
virtual ~t8_geometry_linear_axis_aligned ()
 The destructor.
 
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_point_batch_inside_element (t8_forest_t forest, t8_locidx_t ltreeid, const t8_element_t *element, const double *points, const int num_points, int *is_inside, const double tolerance) const
 
virtual bool t8_geom_tree_negative_volume () const
 Check if the currently active tree has a negative volume. More...
 
- Public Member Functions inherited from t8_geometry_with_vertices
 t8_geometry_with_vertices (int dimension, std::string name)
 
virtual ~t8_geometry_with_vertices ()
 The destructor. 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...
 
t8_geometry_type_t t8_geom_get_type () const
 Get the type of this geometry. More...
 
- Public Member Functions inherited from t8_geometry
 t8_geometry (int dim, std::string name)
 
virtual ~t8_geometry ()
 The destructor. More...
 
int t8_geom_get_dimension () const
 Get the dimension of this geometry. More...
 
const std::string t8_geom_get_name () const
 Get the name of this geometry. More...
 
const size_t t8_geom_get_hash () const
 

Additional Inherited Members

- Protected Attributes inherited from t8_geometry_with_vertices
t8_gloidx_t active_tree
 
t8_eclass_t active_tree_class
 
const double * active_tree_vertices
 
- Protected Attributes inherited from t8_geometry
int dimension
 The dimension of reference space for which this is a geometry.
 
std::string name
 The name of this geometry.
 
size_t hash
 The hash of the name of this geometry.
 

Constructor & Destructor Documentation

◆ t8_geometry_linear_axis_aligned()

t8_geometry_linear_axis_aligned::t8_geometry_linear_axis_aligned ( int  dim)

Constructor of the linear, axis-aligned geometry with a given dimension.

The geometry is only viable for the line/quad/hex tree types and uses two vertices (min and max coords) per tree. The vertices are saved via the t8_cmesh_set_tree_vertices function. Sets the dimension and the name to "t8_geom_linear_axis_aligned_{dim}"

Parameters
[in]dim0 <= dimension <= 3. The dimension.

Member Function Documentation

◆ t8_geom_evaluate()

void t8_geometry_linear_axis_aligned::t8_geom_evaluate ( t8_cmesh_t  cmesh,
t8_gloidx_t  gtreeid,
const double *  ref_coords,
const size_t  num_coords,
double *  out_coords 
) const
virtual

Maps points in the reference space \( [0,1]^\mathrm{dim} \to \mathbb{R}^3 \).

Parameters
[in]cmeshThe cmesh in which the point lies.
[in]gtreeidThe global tree (of the cmesh) in which the reference point is.
[in]ref_coordsArray of dimension x num_coords many entries, specifying points in \( [0,1]^\mathrm{dim} \).
[in]num_coordsAmount of points of /f$ \mathrm{dim} /f$ to map.
[out]out_coordsThe mapped coordinates in physical space of ref_coords. The length is num_coords * 3.

Implements t8_geometry.

◆ t8_geom_evaluate_jacobian()

void t8_geometry_linear_axis_aligned::t8_geom_evaluate_jacobian ( t8_cmesh_t  cmesh,
t8_gloidx_t  gtreeid,
const double *  ref_coords,
const size_t  num_coords,
double *  jacobian 
) const
virtual

Compute the jacobian of the t8_geom_evaluate map at a point in the reference space \( [0,1]^\mathrm{dim} \).

Parameters
[in]cmeshThe cmesh in which the point lies.
[in]gtreeidThe global tree (of the cmesh) in which the reference point is.
[in]ref_coordsArray of dimension x num_coords many entries, specifying points in \( [0,1]^\mathrm{dim} \).
[in]num_coordsAmount of points of /f$ \mathrm{dim} /f$ to map.
[out]jacobianThe jacobian at ref_coords. Array of size num_coords x dimension x 3. 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} \)).

Implements t8_geometry.

◆ t8_geom_get_type()

t8_geometry_type_t t8_geometry_linear_axis_aligned::t8_geom_get_type ( ) const
inlinevirtual

Get the type of this geometry.

Returns
The type.

Implements t8_geometry.

◆ t8_geom_point_batch_inside_element()

void t8_geometry_linear_axis_aligned::t8_geom_point_batch_inside_element ( t8_forest_t  forest,
t8_locidx_t  ltreeid,
const t8_element_t element,
const double *  points,
const int  num_points,
int *  is_inside,
const double  tolerance 
) const
virtual
Parameters
[in]forestThe forest of the element.
[in]ltreeidThe local tree id of the element's tree
[in]elementThe element
[in]pointspoints to check
[in]num_pointsNumber of points to check
[in,out]is_insideArray to fill with flags whether the point is inside or not
[in]toleranceTolerance of the inside-check

Reimplemented from t8_geometry.

◆ t8_geom_tree_negative_volume()

bool t8_geometry_linear_axis_aligned::t8_geom_tree_negative_volume ( ) const
virtual

Check if the currently active tree has a negative volume.

Returns
True (non-zero) if the currently loaded tree has a negative volume. 0 otherwise.

Reimplemented from t8_geometry_with_vertices.


The documentation for this struct was generated from the following files: