DOLFINx  0.5.1
DOLFINx C++ interface
Public Member Functions | Public Attributes | List of all members
MeshTags< T > Class Template Reference

MeshTags associate values with mesh entities. More...

#include <MeshTags.h>

Public Member Functions

template<typename U , typename V >
 MeshTags (const std::shared_ptr< const Mesh > &mesh, int dim, U &&indices, V &&values)
 Create a MeshTag from entities of given dimension on a mesh. More...
 
 MeshTags (const MeshTags &tags)=default
 Copy constructor.
 
 MeshTags (MeshTags &&tags)=default
 Move constructor.
 
 ~MeshTags ()=default
 Destructor.
 
MeshTagsoperator= (const MeshTags &tags)=default
 Move assignment.
 
MeshTagsoperator= (MeshTags &&tags)=default
 Move assignment.
 
std::vector< std::int32_t > find (const T value) const
 Find all entities with a given tag value. More...
 
const std::vector< std::int32_t > & indices () const
 Indices of tagged mesh entities (local-to-process). The indices are sorted.
 
const std::vector< T > & values () const
 Values attached to mesh entities.
 
int dim () const
 Return topological dimension of tagged entities.
 
std::shared_ptr< const Meshmesh () const
 Return mesh.
 

Public Attributes

std::string name = "mesh_tags"
 Name.
 

Detailed Description

template<typename T>
class dolfinx::mesh::MeshTags< T >

MeshTags associate values with mesh entities.

The entity index (local to process) identifies the entity. MeshTags is a sparse data storage class; it allows tags to be associated with an arbitrary subset of mesh entities. An entity can have only one associated tag.

Template Parameters
Type

Constructor & Destructor Documentation

◆ MeshTags()

MeshTags ( const std::shared_ptr< const Mesh > &  mesh,
int  dim,
U &&  indices,
V &&  values 
)
inline

Create a MeshTag from entities of given dimension on a mesh.

Parameters
[in]meshThe mesh on which the tags are associated
[in]dimTopological dimension of mesh entities to tag
[in]indicesstd::vector<std::int32> of sorted and unique entity indices (indices local to the process)
[in]valuesstd::vector<T> of values for each index in indices. The size must be equal to the size of indices.

Member Function Documentation

◆ find()

std::vector<std::int32_t> find ( const T  value) const
inline

Find all entities with a given tag value.

Parameters
[in]valueThe value
Returns
Indices of tagged entities. The indices are sorted.

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