`reference_element`

reference element

# Description

The reference_element class defines all supported types of geometrical elements in zero, one, two and three dimensions. Each supported element is represented by a letter:

- `p`: `point` (dimension 0)
- `e`: `edge` (dimension 1)
- `t`: `triangle` (dimension 2)
- `q`: `quadrangle` (dimension 2)
- `T`: `tetrahedron` (dimension 3)
- `P`: `prism` (dimension 3)
- `H`: `hexahedron` (dimension 3)

# Implementation

This documentation has been generated from file fem/geo_element/reference_element.h

class reference_element {
public:
// typedefs:
typedef std::vector<int>::size_type size_type;
typedef size_type variant_type;
static const variant_type
p = 0,
e = 1,
t = 2,
q = 3,
T = 4,
P = 5,
H = 6,
max_variant = 7;
static const size_type max_side_by_variant = 6;
// allocators/deallocators:
reference_element (variant_type x = max_variant)
: _x(x) { assert_macro (x >= 0 && x <= max_variant, "invalid type " << x); }
// initializers:
void set_variant (variant_type x) { _x = x; }
void set_variant (size_type n_vertex, size_type dim) { _x = variant (n_vertex, dim); }
void set_name (char name);
// accessors:
variant_type variant() const { return _x; }
char name() const { return _name[_x % max_variant]; }
size_type dimension() const { return _dimension[_x]; }
size_type size() const { return _n_vertex[_x]; }
size_type n_vertex() const { return _n_vertex[_x]; }
size_type n_side() const { return dimension() > 0 ? n_subgeo (variant(), dimension()-1) : 0; }
size_type n_edge() const { return n_subgeo(1); }
size_type n_face() const { return n_subgeo(2); }
size_type n_subgeo_by_variant (size_type subgeo_variant) const {
return n_subgeo_by_variant(variant(), subgeo_variant); }
size_type n_subgeo(size_type subgeo_dim) const { return n_subgeo (variant(), subgeo_dim); }
reference_element subgeo (size_type subgeo_dim, size_type loc_isid) const {
if (dimension() == 0) return reference_element(reference_element::p);
if (dimension() == subgeo_dim) return *this;
reference_element hat_S;
size_type subgeo_n_vertex = subgeo_size (subgeo_dim, loc_isid);
hat_S.set_variant (subgeo_n_vertex, subgeo_dim);
return hat_S;
}
reference_element side (size_type loc_isid) const { return subgeo (dimension()-1, loc_isid); }
size_type subgeo_size (size_type subgeo_dim, size_type loc_isid) const {
return subgeo_n_node (_x, 1, subgeo_dim, loc_isid); }
size_type subgeo_local_vertex(size_type subgeo_dim, size_type loc_isid, size_type loc_jsidvert) const {
return subgeo_local_node (_x, 1, subgeo_dim, loc_isid, loc_jsidvert); }
size_type local_subgeo_index2index_by_variant (size_type subgeo_variant, size_type i) const {
return (variant() == P && subgeo_variant == q) ? i-2 : i; }
// TODO: use template<class T> instead of Float
const point_basic<Float>& vertex (size_type iloc) const;
friend Float measure (reference_element hat_K);
Float side_measure (size_type loc_isid) const;
void side_normal (size_type loc_isid, point_basic<Float>& hat_n) const;
// helpers:
static variant_type variant (char name);
static variant_type variant (size_type n_vertex, size_type dim);
static char name (variant_type variant) { return _name [variant]; }
static size_type dimension (variant_type variant) { return _dimension[variant]; }
static size_type n_vertex (variant_type variant) { return _n_vertex [variant]; }
static size_type n_node (variant_type variant, size_type order);
static size_type n_sub_edge (variant_type variant);
static size_type n_sub_face (variant_type variant);
static size_type n_subgeo (variant_type variant, size_type subgeo_dim);
static size_type subgeo_n_node (variant_type variant, size_type order, size_type subgeo_dim, size_type loc_isid);
static size_type subgeo_local_node (variant_type variant, size_type order, size_type subgeo_dim, size_type loc_isid, size_type loc_jsidnod);
static variant_type first_variant_by_dimension (size_type dim) {
return _first_variant_by_dimension[dim]; }
static variant_type last_variant_by_dimension (size_type dim) {
return _first_variant_by_dimension[dim+1]; }
static size_type first_inod_by_variant (variant_type variant, size_type order, variant_type subgeo_variant);
static size_type last_inod_by_variant (variant_type variant, size_type order, variant_type subgeo_variant)
{ return first_inod_by_variant (variant, order, subgeo_variant+1); }
static size_type first_inod (variant_type variant, size_type order, size_type subgeo_dim)
{ return first_inod_by_variant (variant, order, first_variant_by_dimension(subgeo_dim)); }
static size_type last_inod (variant_type variant, size_type order, size_type subgeo_dim)
{ return first_inod_by_variant (variant, order, last_variant_by_dimension(subgeo_dim)); }
static void init_local_nnode_by_variant (size_type order, std::array<size_type,reference_element::max_variant>& loc_nnod_by_variant);
static size_type n_subgeo_by_variant (size_type variant, size_type subgeo_variant)
{ return _n_subgeo_by_variant [variant] [subgeo_variant]; }
};
rheolef::reference_element::last_variant_by_dimension
static variant_type last_variant_by_dimension(size_type dim)
Definition: reference_element.h:150
rheolef::reference_element::side_measure
Float side_measure(size_type loc_isid) const
Definition: reference_element.cc:213
rheolef::reference_element::n_side
size_type n_side() const
Definition: reference_element.h:104
rheolef::reference_element::e
static const variant_type e
Definition: reference_element.h:76
rheolef::reference_element::n_edge
size_type n_edge() const
Definition: reference_element.h:105
rheolef::reference_element::H
static const variant_type H
Definition: reference_element.h:81
rheolef::reference_element::n_face
size_type n_face() const
Definition: reference_element.h:106
rheolef::reference_element::n_sub_face
static size_type n_sub_face(variant_type variant)
Definition: reference_element.cc:99
rheolef::reference_element::n_node
static size_type n_node(variant_type variant, size_type order)
Definition: reference_element.cc:201
rheolef::reference_element::reference_element
reference_element(variant_type x=max_variant)
Definition: reference_element.h:88
rheolef::reference_element::size
size_type size() const
Definition: reference_element.h:102
rheolef::reference_element::_x
variant_type _x
Definition: reference_element.h:177
rheolef::reference_element::init_local_nnode_by_variant
static void init_local_nnode_by_variant(size_type order, std::array< size_type, reference_element::max_variant > &loc_nnod_by_variant)
Definition: reference_element.cc:206
rheolef::reference_element::max_side_by_variant
static const size_type max_side_by_variant
Definition: reference_element.h:84
rheolef::reference_element::subgeo_local_vertex
size_type subgeo_local_vertex(size_type subgeo_dim, size_type loc_isid, size_type loc_jsidvert) const
Definition: reference_element.h:122
rheolef::reference_element::subgeo_size
size_type subgeo_size(size_type subgeo_dim, size_type loc_isid) const
Definition: reference_element.h:120
rheolef::reference_element::n_subgeo
size_type n_subgeo(size_type subgeo_dim) const
Definition: reference_element.h:110
mkgeo_ball.order
order
Definition: mkgeo_ball.sh:343
rheolef::reference_element::_dimension
static const size_type _dimension[max_variant]
Definition: reference_element.h:170
rheolef::reference_element::first_inod
static size_type first_inod(variant_type variant, size_type order, size_type subgeo_dim)
Definition: reference_element.h:156
rheolef::reference_element::first_variant_by_dimension
static variant_type first_variant_by_dimension(size_type dim)
Definition: reference_element.h:148
rheolef::reference_element::local_subgeo_index2index_by_variant
size_type local_subgeo_index2index_by_variant(size_type subgeo_variant, size_type i) const
Definition: reference_element.h:124
p
Definition: sphere.icc:25
rheolef::reference_element::subgeo
reference_element subgeo(size_type subgeo_dim, size_type loc_isid) const
Definition: reference_element.h:111
rheolef::reference_element::variant_type
size_type variant_type
Definition: reference_element.h:72
assert_macro
#define assert_macro(ok_condition, message)
Definition: dis_macros.h:113
rheolef::reference_element::name
char name() const
Definition: reference_element.h:100
rheolef::reference_element::_name
static const char _name[max_variant]
Definition: reference_element.h:169
rheolef::reference_element::variant
variant_type variant() const
Definition: reference_element.h:99
rheolef::reference_element::_n_subgeo_by_variant
static const size_type _n_subgeo_by_variant[max_variant][max_variant]
Definition: reference_element.h:171
rheolef::reference_element::measure
friend Float measure(reference_element hat_K)
Definition: reference_element.cc:65
rheolef::reference_element::_n_vertex
static const size_type _n_vertex[max_variant]
Definition: reference_element.h:172
rheolef::reference_element::subgeo_local_node
static size_type subgeo_local_node(variant_type variant, size_type order, size_type subgeo_dim, size_type loc_isid, size_type loc_jsidnod)
Definition: reference_element.cc:155
rheolef::reference_element::_first_variant_by_dimension
static const variant_type _first_variant_by_dimension[5]
Definition: reference_element.h:173
Float
see the Float page for the full documentation
rheolef::reference_element::max_variant
static const variant_type max_variant
Definition: reference_element.h:82
rheolef::reference_element::dimension
size_type dimension() const
Definition: reference_element.h:101
rheolef::reference_element::last_inod
static size_type last_inod(variant_type variant, size_type order, size_type subgeo_dim)
Definition: reference_element.h:158
rheolef::reference_element::set_name
void set_name(char name)
Definition: reference_element.cc:59
rheolef::reference_element::p
static const variant_type p
Definition: reference_element.h:75
rheolef::reference_element::q
static const variant_type q
Definition: reference_element.h:78
rheolef::reference_element::P
static const variant_type P
Definition: reference_element.h:80
rheolef::reference_element::set_variant
void set_variant(variant_type x)
Definition: reference_element.h:93
rheolef::reference_element::t
static const variant_type t
Definition: reference_element.h:77
size_type
field::size_type size_type
Definition: branch.cc:425
rheolef::reference_element::side_normal
void side_normal(size_type loc_isid, point_basic< Float > &hat_n) const
Definition: reference_element.cc:232
rheolef::reference_element::n_subgeo_by_variant
size_type n_subgeo_by_variant(size_type subgeo_variant) const
Definition: reference_element.h:107
rheolef::reference_element::side
reference_element side(size_type loc_isid) const
Definition: reference_element.h:119
rheolef::reference_element::vertex
const point_basic< Float > & vertex(size_type iloc) const
Definition: reference_element.cc:251
mkgeo_ball.dim
dim
Definition: mkgeo_ball.sh:307
rheolef::reference_element::size_type
std::vector< int >::size_type size_type
Definition: reference_element.h:71
rheolef::reference_element::n_sub_edge
static size_type n_sub_edge(variant_type variant)
Definition: reference_element.cc:85
rheolef::reference_element::subgeo_n_node
static size_type subgeo_n_node(variant_type variant, size_type order, size_type subgeo_dim, size_type loc_isid)
Definition: reference_element.cc:132
rheolef::reference_element::n_vertex
size_type n_vertex() const
Definition: reference_element.h:103
T
Expr1::float_type T
Definition: field_expr.h:218
rheolef::reference_element::last_inod_by_variant
static size_type last_inod_by_variant(variant_type variant, size_type order, variant_type subgeo_variant)
Definition: reference_element.h:154
rheolef::reference_element::first_inod_by_variant
static size_type first_inod_by_variant(variant_type variant, size_type order, variant_type subgeo_variant)
Definition: reference_element.cc:179