DOLFIN-X
DOLFIN-X C++ interface
Public Member Functions | List of all members
dolfinx::mesh::MeshEntity Class Reference

A MeshEntity represents a mesh entity associated with a specific topological dimension of some Mesh. A MeshEntity object is left in an undefined state if the Mesh that it is constructed with is destroyed. More...

#include <MeshEntity.h>

Public Member Functions

 MeshEntity (const Mesh &mesh, int dim, std::int32_t index)
 Constructor. More...
 
 MeshEntity (const MeshEntity &e)=default
 Copy constructor.
 
 MeshEntity (MeshEntity &&e)=default
 Move constructor.
 
 ~MeshEntity ()=default
 Destructor.
 
MeshEntityoperator= (const MeshEntity &e)=default
 Assignment operator.
 
MeshEntityoperator= (MeshEntity &&e)=default
 Move assignment operator.
 
const Meshmesh () const
 Return mesh associated with mesh entity. More...
 
int dim () const
 Return topological dimension. More...
 
std::int32_t index () const
 Return index of mesh entity. More...
 
auto entities (int dim) const
 Return array of indices for incident mesh entities of given topological dimension. More...
 

Detailed Description

A MeshEntity represents a mesh entity associated with a specific topological dimension of some Mesh. A MeshEntity object is left in an undefined state if the Mesh that it is constructed with is destroyed.

Constructor & Destructor Documentation

◆ MeshEntity()

dolfinx::mesh::MeshEntity::MeshEntity ( const Mesh mesh,
int  dim,
std::int32_t  index 
)
inline

Constructor.

Parameters
[in]meshThe mesh
[in]dimThe topological dimension
[in]indexThe entity index

Member Function Documentation

◆ dim()

int dolfinx::mesh::MeshEntity::dim ( ) const
inline

Return topological dimension.

Returns
The topological dimension

◆ entities()

auto dolfinx::mesh::MeshEntity::entities ( int  dim) const
inline

Return array of indices for incident mesh entities of given topological dimension.

Parameters
[in]dimThe topological dimension
Returns
The index for incident mesh entities of given dimension

◆ index()

std::int32_t dolfinx::mesh::MeshEntity::index ( ) const
inline

Return index of mesh entity.

Returns
The index

◆ mesh()

const Mesh& dolfinx::mesh::MeshEntity::mesh ( ) const
inline

Return mesh associated with mesh entity.

Returns
The mesh

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