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...

Inheritance diagram for foamVtkMeshMaps:
[legend]

Public Member Functions

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

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 58 of file foamVtkMeshMaps.H.

Constructor & Destructor Documentation

◆ foamVtkMeshMaps()

foamVtkMeshMaps ( )
default

Default construct: zero-sized, no reserved sizes.

Member Function Documentation

◆ cellMap() [1/2]

const Foam::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 41 of file foamVtkMeshMapsI.H.

Referenced by vtuAdaptor::convertField(), vtuSizing::populateLegacy(), vtuSizing::populateShapesLegacy(), vtuSizing::populateShapesXml(), and vtuSizing::populateXml().

Here is the caller graph for this function:

◆ cellMap() [2/2]

Foam::DynamicList< Foam::label > & cellMap ( )
inlinenoexcept

Write access to original cell ids.

Definition at line 48 of file foamVtkMeshMapsI.H.

◆ pointMap() [1/2]

const Foam::labelList & pointMap ( ) const
inlinenoexcept

Point labels for subsetted meshes.

Definition at line 55 of file foamVtkMeshMapsI.H.

◆ pointMap() [2/2]

Foam::DynamicList< Foam::label > & pointMap ( )
inlinenoexcept

Write access to point labels for subsetted meshes.

Definition at line 62 of file foamVtkMeshMapsI.H.

◆ additionalIds() [1/2]

const Foam::labelList & additionalIds ( ) const
inlinenoexcept

Any additional (user) labels.

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

Definition at line 69 of file foamVtkMeshMapsI.H.

Referenced by vtuSizing::populateLegacy(), vtuSizing::populateShapesLegacy(), vtuSizing::populateShapesXml(), and vtuSizing::populateXml().

Here is the caller graph for this function:

◆ additionalIds() [2/2]

Foam::DynamicList< Foam::label > & additionalIds ( )
inlinenoexcept

Write access to additional (user) labels.

Definition at line 76 of file foamVtkMeshMapsI.H.

◆ clear()

void clear ( )
inline

Clear sizing.

Definition at line 32 of file foamVtkMeshMapsI.H.

References DynamicList< T, SizeMin >::clear().

Here is the call graph for this function:

◆ renumberCells()

void renumberCells ( const labelUList mapping)

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

Definition at line 33 of file foamVtkMeshMaps.C.

References Foam::inplaceRenumber().

Here is the call graph for this function:

◆ renumberPoints()

void renumberPoints ( const labelUList mapping)

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

Definition at line 40 of file foamVtkMeshMaps.C.

References Foam::inplaceRenumber().

Here is the call graph for this function:

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