Loading...
Searching...
No Matches
foamVtkMeshMaps Class Reference

Bookkeeping for mesh subsetting and/or polyhedral cell decomposition. Although the main use case is for handling vtk meshes, it is not specific to VTK alone. More...

#include <foamVtkMeshMaps.H>

Inheritance diagram for foamVtkMeshMaps:
Inheritance graph
[legend]

Public Member Functions

 foamVtkMeshMaps ()=default
 Default construct: zero-sized, no reserved sizes.
const labelList & cellMap () const noexcept
 Original cell ids for all cells (regular and decomposed).
DynamicList< label > & cellMap () noexcept
 Write access to original cell ids.
const labelList & pointMap () const noexcept
 Point labels for subsetted meshes.
DynamicList< label > & pointMap () noexcept
 Write access to point labels for subsetted meshes.
const labelList & additionalIds () const noexcept
 Any additional (user) labels.
DynamicList< label > & additionalIds () noexcept
 Write access to additional (user) labels.
void clear ()
 Clear sizing.
void renumberCells (const labelUList &mapping)
 Renumber cell ids (cellMap and additionalIds) to account for subset meshes.
void renumberPoints (const labelUList &mapping)
 Renumber point ids (pointMap) to account for subset meshes.

Detailed Description

Bookkeeping for mesh subsetting and/or polyhedral cell decomposition. Although the main use case is for handling vtk meshes, it is not specific to VTK alone.

The cellMap is a local-to-global lookup for normal and decomposed cells. The pointMap is an optional local-to-global lookup for point ids. The additional ids is typically used to store the cell-centre labels for additional points of decomposed cells

Source files

Definition at line 54 of file foamVtkMeshMaps.H.

Constructor & Destructor Documentation

◆ foamVtkMeshMaps()

foamVtkMeshMaps ( )
default

Default construct: zero-sized, no reserved sizes.

Referenced by vtuAdaptor::internal().

Here is the caller graph for this function:

Member Function Documentation

◆ cellMap() [1/2]

const labelList & cellMap ( ) const
inlinenoexcept

Original cell ids for all cells (regular and decomposed).

For regular mesh comprising only primitive cell types, this will be an identity list. However, for subsetted meshes and decomposed cells this becomes a useful means of mapping from the original mesh.

Definition at line 97 of file foamVtkMeshMaps.H.

References Foam::noexcept.

◆ cellMap() [2/2]

DynamicList< label > & cellMap ( )
inlinenoexcept

Write access to original cell ids.

Definition at line 102 of file foamVtkMeshMaps.H.

References Foam::noexcept.

◆ pointMap() [1/2]

const labelList & pointMap ( ) const
inlinenoexcept

Point labels for subsetted meshes.

Definition at line 107 of file foamVtkMeshMaps.H.

References Foam::noexcept.

Referenced by vtuAdaptor::points().

Here is the caller graph for this function:

◆ pointMap() [2/2]

DynamicList< label > & pointMap ( )
inlinenoexcept

Write access to point labels for subsetted meshes.

Definition at line 112 of file foamVtkMeshMaps.H.

References Foam::noexcept.

◆ additionalIds() [1/2]

const labelList & additionalIds ( ) const
inlinenoexcept

Any additional (user) labels.

Eg, cell-centre labels for additional points of decomposed cells

Definition at line 119 of file foamVtkMeshMaps.H.

References Foam::noexcept.

Referenced by vtuAdaptor::points(), and vtuAdaptor::points().

Here is the caller graph for this function:

◆ additionalIds() [2/2]

DynamicList< label > & additionalIds ( )
inlinenoexcept

Write access to additional (user) labels.

Definition at line 124 of file foamVtkMeshMaps.H.

References Foam::noexcept.

◆ clear()

void clear ( )
inline

Clear sizing.

Definition at line 25 of file foamVtkMeshMapsI.H.

◆ renumberCells()

void renumberCells ( const labelUList & mapping)

Renumber cell ids (cellMap and additionalIds) to account for subset meshes.

◆ renumberPoints()

void renumberPoints ( const labelUList & mapping)

Renumber point ids (pointMap) to account for subset meshes.

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