Public Member Functions | List of all members
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 (const label size=0)
 Construct null. More...
 
 ~foamVtkMeshMaps ()=default
 Destructor. More...
 
const labelList & cellMap () const
 Original cell ids for all cells (regular and decomposed). More...
 
const labelList & pointMap () const
 Point labels for subsetted meshes. More...
 
const labelList & additionalIds () const
 Any additional (user) labels. More...
 
void clear ()
 Clear. More...
 
void renumberCells (const labelUList &mapping)
 Renumber cell ids (cellMap and additionalIds) to account for. More...
 
void renumberPoints (const labelUList &mapping)
 Renumber point ids (pointMap) to account for subset meshes. More...
 
DynamicList< label > & cellMap ()
 Original cell ids for all cells (regular and decomposed). More...
 
DynamicList< label > & pointMap ()
 Point labels for subsetted meshes. More...
 
DynamicList< label > & additionalIds ()
 Any additional (user) labels. 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 57 of file foamVtkMeshMaps.H.

Constructor & Destructor Documentation

◆ foamVtkMeshMaps()

foamVtkMeshMaps ( const label  size = 0)
inlineexplicit

Construct null.

Definition at line 32 of file foamVtkMeshMapsI.H.

◆ ~foamVtkMeshMaps()

~foamVtkMeshMaps ( )
default

Destructor.

Member Function Documentation

◆ cellMap() [1/2]

const Foam::labelList & cellMap ( ) const
inline

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

A regular mesh comprising only primitive cell types, this will just 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 51 of file foamVtkMeshMapsI.H.

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

Here is the caller graph for this function:

◆ pointMap() [1/2]

const Foam::labelList & pointMap ( ) const
inline

Point labels for subsetted meshes.

Definition at line 65 of file foamVtkMeshMapsI.H.

◆ additionalIds() [1/2]

const Foam::labelList & additionalIds ( ) const
inline

Any additional (user) labels.

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

Definition at line 79 of file foamVtkMeshMapsI.H.

Referenced by vtuSizing::populateInternal(), vtuSizing::populateLegacy(), and vtuSizing::populateXml().

Here is the caller graph for this function:

◆ clear()

void clear ( )
inline

Clear.

Definition at line 42 of file foamVtkMeshMapsI.H.

◆ 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:

◆ cellMap() [2/2]

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

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

For a regular mesh comprising only primitive cell types, this will simply 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 58 of file foamVtkMeshMapsI.H.

◆ pointMap() [2/2]

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

Point labels for subsetted meshes.

Definition at line 72 of file foamVtkMeshMapsI.H.

◆ additionalIds() [2/2]

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

Any additional (user) labels.

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

Definition at line 86 of file foamVtkMeshMapsI.H.

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