FEAT::Shape::ReferenceCell< Shape_ > Struct Template Reference

Reference cell traits structure. More...

#include <shape.hpp>

Static Public Member Functions
template<typename T_ >
static T_	centre (int coord_idx)
	Returns the coordinate of the reference cell centre. More...
static int	facet_orientation (int facet_index)
	Returns the orientation of a facet. More...
template<typename T_ >
static T_	vertex (int vertex_idx, int coord_idx)
	Returns the coordinate of a reference cell vertex. More...
template<typename T_ >
static T_	volume ()
	Returns the volume of the reference cell. More...

Detailed Description

template<typename Shape_>
struct FEAT::Shape::ReferenceCell< Shape_ >

Reference cell traits structure.

This class template contains information about the reference cell of the corresponding shape, especially the coordinates of the reference cell's vertices.

Template Parameters

Shape_

The shape whose reference cell is to be determined.

Author

Peter Zajac

Definition at line 229 of file shape.hpp.

Member Function Documentation

centre()

template<typename Shape_ >

template<typename T_ >

static T_ FEAT::Shape::ReferenceCell< Shape_ >::centre ( int  coord_idx )

static

Returns the coordinate of the reference cell centre.

Template Parameters

T_	The desired type of the coordinate.

Parameters

[in]

coord_idx

The index of the coordinate of the centre that is to be returned.

Returns

The desired coordinate of the reference cell centre.

facet_orientation()

template<typename Shape_ >

static int FEAT::Shape::ReferenceCell< Shape_ >::facet_orientation ( int  facet_index )

static

Returns the orientation of a facet.

Note

For simplices, all facets are positively oriented (i.e. the edges that make up the reference triangle), but for hypercubes this is not the case.

Parameters

[in]

facet_index

The number of the facet to return the orientation for.

Returns

1 for a positively or -1 for a negatively oriented facet.

vertex()

template<typename Shape_ >

template<typename T_ >

static T_ FEAT::Shape::ReferenceCell< Shape_ >::vertex ( int  vertex_idx, int  coord_idx  )

static

Returns the coordinate of a reference cell vertex.

Template Parameters

T_	The desired type of the coordinate.

Parameters

[in]	vertex_idx	The index of the vertex whose coordinate is to be returned.
[in]	coord_idx	The index of the coordinate of the vertex that is to be returned.

Returns

The desired coordinate of the reference cell vertex.

volume()

template<typename Shape_ >

template<typename T_ >

static T_ FEAT::Shape::ReferenceCell< Shape_ >::volume ( )

static

Returns the volume of the reference cell.

Template Parameters

T_	The desired type of the volume.

Returns

The volume of the reference cell.

---

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

• kernel/shape.hpp