## On this page

  

 

 # sysc::VolumeMesh Class Reference

 Last update: 17.07.2025 

Provide a volume mesh access class. [More...](classsysc_1_1VolumeMesh.xhtml#details)

`#include <<a class="el" href="VolumeMesh_8hpp_source.xhtml">VolumeMesh.hpp</a>>`

## <a id="pub-methods" name="pub-methods"></a>Public Member Functions

<a id="ab01007a2dcb32f1a91b0ca7a26c94afb" name="ab01007a2dcb32f1a91b0ca7a26c94afb"></a> **VolumeMesh** ([NodeData](structsysc_1_1NodeData.xhtml) nodeData, [CellData](structsysc_1_1CellData.xhtml) cellData) Provide a constructor for element-based volume mesh.   
 <a id="abb0f3e38d18bdfe8128e71da0dcf235f" name="abb0f3e38d18bdfe8128e71da0dcf235f"></a> **VolumeMesh** ([NodeData](structsysc_1_1NodeData.xhtml) nodeData, [FaceData](structsysc_1_1FaceData.xhtml) faceData, [CellData](structsysc_1_1CellData.xhtml) cellData) Provide a constructor for face-based volume mesh.   
 <a id="a714cfafbfb04be14720a195cc7590470" name="a714cfafbfb04be14720a195cc7590470"></a> **VolumeMesh** ()=default Provide a default constructor.   
 <a id="ab3261c84e62bdcf25d92b69cbefb1cba" name="ab3261c84e62bdcf25d92b69cbefb1cba"></a> **VolumeMesh** (const [VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp;)=default Provide a copy-constructor.   
 <a id="af2f6fc62a27f5d69af987a82a8154e45" name="af2f6fc62a27f5d69af987a82a8154e45"></a> **VolumeMesh** ([VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp;&amp;)=default Provide a move-constructor.   
 <a id="a2d10ecc188f06130c0b5a5182654a3af" name="a2d10ecc188f06130c0b5a5182654a3af"></a>[VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp; **operator=** (const [VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp;)=default Provide a copy-assign operator.   
 <a id="a8095db508df29f9ccfcefaf52bc6862d" name="a8095db508df29f9ccfcefaf52bc6862d"></a>[VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp; **operator=** ([VolumeMesh](classsysc_1_1VolumeMesh.xhtml) &amp;&amp;)=default Provide a move-assign operator.   
 <a id="a9dfa2f51dd8aed09b662c67209db9ad0" name="a9dfa2f51dd8aed09b662c67209db9ad0"></a>const [NodeData](structsysc_1_1NodeData.xhtml) &amp; **getNodeData** () const noexcept Get node data.   
 <a id="a89489cae5c428a3dd28256e726767080" name="a89489cae5c428a3dd28256e726767080"></a>const [FaceData](structsysc_1_1FaceData.xhtml) &amp; **getFaceData** () const noexcept Get face data.   
 <a id="a3666e81d303c3e6cb007a763e72ee462" name="a3666e81d303c3e6cb007a763e72ee462"></a>const [CellData](structsysc_1_1CellData.xhtml) &amp; **getCellData** () const noexcept Get cell data.   
 [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml) [checkMeshValidity](classsysc_1_1VolumeMesh.xhtml#aca7d146a22e72f8eca520ef69ea6858a) () const Provide a method to perform simple mesh validity checks.   
 <a id="ad901c126ab7372df0928446c7a5bede7" name="ad901c126ab7372df0928446c7a5bede7"></a> **VolumeMesh** ([NodeData](structsysc_1_1NodeData.xhtml) nodeData, [ElementTypeData](structsysc_1_1ElementTypeData.xhtml) faceTypeData, [ElementNodeCountData](structsysc_1_1ElementNodeCountData.xhtml) faceNodeCountData, [ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) faceNodeConnectivityData, [FaceCellConnectivityData](structsysc_1_1FaceCellConnectivityData.xhtml) faceCellConnectivityData, [CellIdData](structsysc_1_1CellIdData.xhtml) cellIdData, [ElementTypeData](structsysc_1_1ElementTypeData.xhtml) cellTypeData, [ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) cellNodeConnectivityData) For internal use only.   
 <a id="ab30f9a87cf0cc2c5d12f6ddf05e99fca" name="ab30f9a87cf0cc2c5d12f6ddf05e99fca"></a>std::size\_t **getNumNodes** () const noexcept Provide a method to get the number of nodes for this mesh.   
 <a id="a941931c2e13bc9b40a19637d1d7d3dcd" name="a941931c2e13bc9b40a19637d1d7d3dcd"></a>std::size\_t **getNumCells** () const noexcept Get the number of cells.   
 <a id="a15835b560adaabcc1c73da43d7d25f3e" name="a15835b560adaabcc1c73da43d7d25f3e"></a>[OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) **getNodeIds** () const noexcept Provide a method to access node ids array.   
 <a id="a4307321266d855dd7ba48023e0b23f4e" name="a4307321266d855dd7ba48023e0b23f4e"></a>[OutputVectorData](classsysc_1_1OutputVectorData.xhtml) **getNodeCoords** () const noexcept Provide a method to access node coordinates array.   
 <a id="a7cd6df532799ff7878c5a3b30cf0ffe5" name="a7cd6df532799ff7878c5a3b30cf0ffe5"></a>[ElementTypeData](structsysc_1_1ElementTypeData.xhtml) **getFaceTypes** () const noexcept Get face types.   
 <a id="a66ec70482e4fd44bc9edaa910e0abaf2" name="a66ec70482e4fd44bc9edaa910e0abaf2"></a>[OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) **getFaceNodeCounts** () const noexcept Provide a method to access face node counts array.   
 <a id="a3a7635141a02711f1dcdacf848c157ab" name="a3a7635141a02711f1dcdacf848c157ab"></a>[OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) **getFaceNodeIds** () const noexcept Provide a method to access face node ids array.   
 <a id="a417e50bee9c019e45cbedd39fd5bc6cb" name="a417e50bee9c019e45cbedd39fd5bc6cb"></a>[OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) **getCell0Ids** () const noexcept Provide a method to access cell 0 ids array.   
 <a id="a1591d15487420143b463ef86835f1874" name="a1591d15487420143b463ef86835f1874"></a>[OutputIntegerData](classsysc_1_1OutputIntegerData.xhtml) **getCell1Ids** () const noexcept Provide a method to access cell 1 ids array.   
 <a id="a798c79c54b8425b7e8b3060016547ea7" name="a798c79c54b8425b7e8b3060016547ea7"></a>[CellIdData](structsysc_1_1CellIdData.xhtml) **getCellIds** () const noexcept Provide a method to access cell ids array.   
 <a id="a159cf62afda4022acfbd2f5cbccfca7c" name="a159cf62afda4022acfbd2f5cbccfca7c"></a>[ElementTypeData](structsysc_1_1ElementTypeData.xhtml) **getCellTypes** () const noexcept Provide a method to access cell types data.   
 <a id="a3bb98664fc0827d3ea1317ca034f493c" name="a3bb98664fc0827d3ea1317ca034f493c"></a>[ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) **getCellNodeConnectivity** () const noexcept Access cell-to-node connectivity data.   
 <a id="ac048cda48c16766a7e04688d62203a70" name="ac048cda48c16766a7e04688d62203a70"></a> **VolumeMesh** ([NodeData](structsysc_1_1NodeData.xhtml) nodeData, [ElementTypeData](structsysc_1_1ElementTypeData.xhtml) cellTypes, [ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) cellNodeIds) Provide a constructor for element-based volume mesh.   
 <a id="a2dfff826766714e9e95227bbc64336a3" name="a2dfff826766714e9e95227bbc64336a3"></a> **VolumeMesh** ([NodeData](structsysc_1_1NodeData.xhtml) nodeData, [ElementNodeCountData](structsysc_1_1ElementNodeCountData.xhtml) faceNodeCounts, [ElementNodeConnectivityData](structsysc_1_1ElementNodeConnectivityData.xhtml) faceNodeIds, [FaceCellConnectivityData](structsysc_1_1FaceCellConnectivityData.xhtml) faceToCellConnectivity, [CellIdData](structsysc_1_1CellIdData.xhtml) cellIds) Provide a constructor for face-based volume mesh.   
 ## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

std::int64\_t [connectivityStamp](classsysc_1_1VolumeMesh.xhtml#adbab9e5317965d98b0e6b02c6ccce7b5) {0} Mesh connectivity stamp. Update whenever re-meshing happens.   
 std::int64\_t [coordinatesStamp](classsysc_1_1VolumeMesh.xhtml#a6415bcc1a32f7374c51d4894d68e338e) {0} Nodal coordinates stamp. Update whenever nodal coordinates get updated.   
 std::int64\_t [partitioningStamp](classsysc_1_1VolumeMesh.xhtml#a9cf06f19acd1b0c3d0003f56ba7df89a) {0} Partitioning stamp. Update whenever the mesh is re-partitioned.   
 <a id="details" name="details"></a>## Detailed Description

Provide a volume mesh access class.

Provides read-only access to the volume mesh for a given region.

Definition at line [26](VolumeMesh_8hpp_source.xhtml#l00026) of file [VolumeMesh.hpp](VolumeMesh_8hpp_source.xhtml).



## Member Function Documentation

<a id="aca7d146a22e72f8eca520ef69ea6858a" name="aca7d146a22e72f8eca520ef69ea6858a"></a>## [◆ ](#aca7d146a22e72f8eca520ef69ea6858a)checkMeshValidity()

 [MeshValidityStatus](structsysc_1_1MeshValidityStatus.xhtml) sysc::VolumeMesh::checkMeshValidity  ( )  const

Provide a method to perform simple mesh validity checks.

See [SystemCoupling::checkMeshValidity](classsysc_1_1SystemCoupling.xhtml#a8c7d2613f81b8d9a5bd81db9dcbae8fd "Deprecated. Use sysc::SurfaceMesh::checkMeshValidity instead.") for more details.





## Member Data Documentation

<a id="adbab9e5317965d98b0e6b02c6ccce7b5" name="adbab9e5317965d98b0e6b02c6ccce7b5"></a>## [◆ ](#adbab9e5317965d98b0e6b02c6ccce7b5)connectivityStamp

 std::int64\_t sysc::VolumeMesh::connectivityStamp {0}

Mesh connectivity stamp. Update whenever re-meshing happens.

Definition at line [29](VolumeMesh_8hpp_source.xhtml#l00029) of file [VolumeMesh.hpp](VolumeMesh_8hpp_source.xhtml).

 29{0};







<a id="a6415bcc1a32f7374c51d4894d68e338e" name="a6415bcc1a32f7374c51d4894d68e338e"></a>## [◆ ](#a6415bcc1a32f7374c51d4894d68e338e)coordinatesStamp

 std::int64\_t sysc::VolumeMesh::coordinatesStamp {0}

Nodal coordinates stamp. Update whenever nodal coordinates get updated.

Definition at line [32](VolumeMesh_8hpp_source.xhtml#l00032) of file [VolumeMesh.hpp](VolumeMesh_8hpp_source.xhtml).

 32{0};







<a id="a9cf06f19acd1b0c3d0003f56ba7df89a" name="a9cf06f19acd1b0c3d0003f56ba7df89a"></a>## [◆ ](#a9cf06f19acd1b0c3d0003f56ba7df89a)partitioningStamp

 std::int64\_t sysc::VolumeMesh::partitioningStamp {0}

Partitioning stamp. Update whenever the mesh is re-partitioned.

Definition at line [35](VolumeMesh_8hpp_source.xhtml#l00035) of file [VolumeMesh.hpp](VolumeMesh_8hpp_source.xhtml).

 35{0};