Class sysc::VolumeMesh
Definition: VolumeMesh.hpp (line 26)
Provide a volume mesh access class.
Provides read-only access to the volume mesh for a given region.
Members
- checkMeshValidity
- checkValidity
- connectivityStamp
- coordinatesStamp
- getCell0Ids
- getCell1Ids
- getCellData
- getCellIds
- getCellNodeConnectivity
- getCellTypes
- getFaceData
- getFaceNodeCounts
- getFaceNodeIds
- getFaceTypes
- getNodeCoords
- getNodeData
- getNodeIds
- getNumCells
- getNumNodes
- m_cells
- m_faces
- m_nodes
- operator=
- operator=
- partitioningStamp
- VolumeMesh
- VolumeMesh
- VolumeMesh
- VolumeMesh
- VolumeMesh
- VolumeMesh
- VolumeMesh
- VolumeMesh
Public attributes
Variable connectivityStamp
Definition: VolumeMesh.hpp (line 29)
std::int64_t sysc::VolumeMesh::connectivityStamp {0}
Mesh connectivity stamp. Update whenever re-meshing happens.
Type: std::int64_t
Variable coordinatesStamp
Definition: VolumeMesh.hpp (line 32)
std::int64_t sysc::VolumeMesh::coordinatesStamp {0}
Nodal coordinates stamp. Update whenever nodal coordinates get updated.
Type: std::int64_t
Variable partitioningStamp
Definition: VolumeMesh.hpp (line 35)
std::int64_t sysc::VolumeMesh::partitioningStamp {0}
Partitioning stamp. Update whenever the mesh is re-partitioned.
Type: std::int64_t
Private attributes
Variable m_nodes
Definition: VolumeMesh.hpp (line 142)
NodeData sysc::VolumeMesh::m_nodes
Type: NodeData
Variable m_faces
Definition: VolumeMesh.hpp (line 143)
FaceData sysc::VolumeMesh::m_faces
Type: FaceData
Variable m_cells
Definition: VolumeMesh.hpp (line 144)
CellData sysc::VolumeMesh::m_cells
Type: CellData
Public functions
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(NodeData nodeData, CellData cellData)
Provide a constructor for element-based volume mesh.
Parameters:
Return type:
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(NodeData nodeData, FaceData faceData, CellData cellData)
Provide a constructor for face-based volume mesh.
Parameters:
Return type:
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh()=default
Provide a default constructor.
Return type:
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(const VolumeMesh &)=default
Provide a copy-constructor.
Parameters:
- const VolumeMesh &
Return type:
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(VolumeMesh &&)=default
Provide a move-constructor.
Parameters:
- VolumeMesh &&
Return type:
Function operator=
VolumeMesh& sysc::VolumeMesh::operator=(const VolumeMesh &)=default
Provide a copy-assign operator.
Parameters:
- const VolumeMesh &
Return type: VolumeMesh &
Function operator=
VolumeMesh& sysc::VolumeMesh::operator=(VolumeMesh &&)=default
Provide a move-assign operator.
Parameters:
- VolumeMesh &&
Return type: VolumeMesh &
Function getNodeData
const NodeData& sysc::VolumeMesh::getNodeData() const noexcept
Get node data.
Return type: const NodeData &
Function getFaceData
const FaceData& sysc::VolumeMesh::getFaceData() const noexcept
Get face data.
Return type: const FaceData &
Function getCellData
const CellData& sysc::VolumeMesh::getCellData() const noexcept
Get cell data.
Return type: const CellData &
Function checkValidity
ValidityStatus sysc::VolumeMesh::checkValidity() const
Provide a method to perform simple mesh validity checks.
Return type: ValidityStatus
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(NodeData nodeData, ElementTypeData faceTypeData, ElementNodeCountData faceNodeCountData, ElementNodeConnectivityData faceNodeConnectivityData, FaceCellConnectivityData faceCellConnectivityData, CellIdData cellIdData, ElementTypeData cellTypeData, ElementNodeConnectivityData cellNodeConnectivityData)
For internal use only.
Parameters:
- NodeData nodeData
- ElementTypeData faceTypeData
- ElementNodeCountData faceNodeCountData
- ElementNodeConnectivityData faceNodeConnectivityData
- FaceCellConnectivityData faceCellConnectivityData
- CellIdData cellIdData
- ElementTypeData cellTypeData
- ElementNodeConnectivityData cellNodeConnectivityData
Return type:
Function getNumNodes
std::size_t sysc::VolumeMesh::getNumNodes() const noexcept
Provide a method to get the number of nodes for this mesh.
Return type: std::size_t
Function getNumCells
std::size_t sysc::VolumeMesh::getNumCells() const noexcept
Get the number of cells.
Return type: std::size_t
Function getNodeIds
OutputIntegerData sysc::VolumeMesh::getNodeIds() const noexcept
Provide a method to access node ids array.
Return type: OutputIntegerData
Function getNodeCoords
OutputVectorData sysc::VolumeMesh::getNodeCoords() const noexcept
Provide a method to access node coordinates array.
Return type: OutputVectorData
Function getFaceTypes
ElementTypeData sysc::VolumeMesh::getFaceTypes() const noexcept
Get face types.
Return type: ElementTypeData
Function getFaceNodeCounts
OutputIntegerData sysc::VolumeMesh::getFaceNodeCounts() const noexcept
Provide a method to access face node counts array.
Return type: OutputIntegerData
Function getFaceNodeIds
OutputIntegerData sysc::VolumeMesh::getFaceNodeIds() const noexcept
Provide a method to access face node ids array.
Return type: OutputIntegerData
Function getCell0Ids
OutputIntegerData sysc::VolumeMesh::getCell0Ids() const noexcept
Provide a method to access cell 0 ids array.
Return type: OutputIntegerData
Function getCell1Ids
OutputIntegerData sysc::VolumeMesh::getCell1Ids() const noexcept
Provide a method to access cell 1 ids array.
Return type: OutputIntegerData
Function getCellIds
CellIdData sysc::VolumeMesh::getCellIds() const noexcept
Provide a method to access cell ids array.
Return type: CellIdData
Function getCellTypes
ElementTypeData sysc::VolumeMesh::getCellTypes() const noexcept
Provide a method to access cell types data.
Return type: ElementTypeData
Function getCellNodeConnectivity
ElementNodeConnectivityData sysc::VolumeMesh::getCellNodeConnectivity() const noexcept
Access cell-to-node connectivity data.
Return type: ElementNodeConnectivityData
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(NodeData nodeData, ElementTypeData cellTypes, ElementNodeConnectivityData cellNodeIds)
Provide a constructor for element-based volume mesh.
Parameters:
- NodeData nodeData
- ElementTypeData cellTypes
- ElementNodeConnectivityData cellNodeIds
Return type:
Function VolumeMesh
sysc::VolumeMesh::VolumeMesh(NodeData nodeData, ElementNodeCountData faceNodeCounts, ElementNodeConnectivityData faceNodeIds, FaceCellConnectivityData faceToCellConnectivity, CellIdData cellIds)
Provide a constructor for face-based volume mesh.
Parameters:
- NodeData nodeData
- ElementNodeCountData faceNodeCounts
- ElementNodeConnectivityData faceNodeIds
- FaceCellConnectivityData faceToCellConnectivity
- CellIdData cellIds
Return type:
Function checkMeshValidity
MeshValidityStatus sysc::VolumeMesh::checkMeshValidity() const
This function is deprecated. Use checkValidity() instead.
Return type: MeshValidityStatus