STAPL API Reference          
Overview   Containers   Algorithms   Views   Skeletons   Run-Time System
Modules     Classes    
List of all members | Public Member Functions | Public Types
stapl::face_property< Dim, Precision > Class Template Reference

Default face property for a cell face. More...

Public Member Functions

 face_property (vid_sequence_type const &vertex_ids, array_type &vertex_array)
 
geom_vector_type get_normal () const
 Get face normal coordinates. More...
 
array_view_type get_vertices () const
 Get pView over the vertices' coordinates of this face. More...
 
vid_sequence_type get_vertex_ids () const
 Get vertex identifiers of this face. More...
 
void set_normal (geom_vector_type const &norm)
 Set normal coordinates of this face. More...
 

Public Types

typedef geom_vector< Dim, Precision > geom_vector_type
 
typedef size_t vertex_id
 
typedef std::vector< vertex_id > vid_sequence_type
 
typedef explicit_domain< vertex_id > vid_domain_type
 
typedef array< geom_vector_typearray_type
 
typedef array_view< array_type, vid_domain_typearray_view_type
 

Detailed Description

template<int Dim, typename Precision = double>
class stapl::face_property< Dim, Precision >

Default face property for a cell face.

Template Parameters
Dimdimension of the mesh.
Precisiontype of vertex coordinate.

A mesh cell face property requires a constructor taking a sequence of face vertex ids and a reference to the pArray storing the mesh vertex coordinates.

Constructor & Destructor Documentation

◆ face_property()

template<int Dim, typename Precision = double>
stapl::face_property< Dim, Precision >::face_property ( vid_sequence_type const &  vertex_ids,
array_type vertex_array 
)
Parameters
vertex_idssequence of face vertex identifiers.
vertex_arraypArray of mesh vertex coordinates.

Member Function Documentation

◆ get_normal()

template<int Dim, typename Precision = double>
geom_vector_type stapl::face_property< Dim, Precision >::get_normal ( ) const

Get face normal coordinates.

Returns
face normal coordinates.

◆ get_vertices()

template<int Dim, typename Precision = double>
array_view_type stapl::face_property< Dim, Precision >::get_vertices ( ) const

Get pView over the vertices' coordinates of this face.

Returns
pView over the vertices' coordinates of this face.

◆ get_vertex_ids()

template<int Dim, typename Precision = double>
vid_sequence_type stapl::face_property< Dim, Precision >::get_vertex_ids ( ) const

Get vertex identifiers of this face.

Returns
vertex identifiers of this face.

◆ set_normal()

template<int Dim, typename Precision = double>
void stapl::face_property< Dim, Precision >::set_normal ( geom_vector_type const &  norm)

Set normal coordinates of this face.

Returns
normal coordinates of this face.

The documentation for this class was generated from the following file: