Caribou
Public Member Functions | List of all members
caribou::topology::BaseDomain Struct Referenceabstract

Detailed Description

A domain is subspace of a mesh containing a set of points and the topological relation between them.

In a domain, all the elements are of the same type. For example, a domain can not contain both hexahedrons and tetrahedrons.

#include <BaseDomain.h>

Inheritance diagram for caribou::topology::BaseDomain:
caribou::topology::Domain< Mesh, Element, NodeIndex >

Public Member Functions

virtual ~BaseDomain ()=default
 Destructor.
 
virtual auto canonical_dimension () const -> UNSIGNED_INTEGER_TYPE=0
 Get the canonical dimension of the element contained in this domain, ie, the number of coordinates of a point relative to the element basis. More...
 
virtual auto number_of_nodes_per_elements () const -> UNSIGNED_INTEGER_TYPE=0
 Get the number of nodes an element of this domain has.
 
virtual auto number_of_elements () const -> UNSIGNED_INTEGER_TYPE=0
 Get the number of elements contained in the domain.
 

Member Function Documentation

◆ canonical_dimension()

virtual auto caribou::topology::BaseDomain::canonical_dimension ( ) const -> UNSIGNED_INTEGER_TYPE
pure virtual

Get the canonical dimension of the element contained in this domain, ie, the number of coordinates of a point relative to the element basis.

For example, a triangle has a canonical dimension of 2, even if it is inside a 3 dimensions mesh : a point inside the triangle has coordinates (x,y,z) relative to the mesh's basis, and coordinates (u, v) relative to the triangle's first node.

Implemented in caribou::topology::Domain< Mesh, Element, NodeIndex >.


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