Skip to main content

Class sysc::SurfaceMesh

Definition: SurfaceMesh.hpp (line 27)

Provide a surface mesh access class.

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

Members​

Public attributes​

Variable connectivityStamp​

Definition: SurfaceMesh.hpp (line 30)

std::int64_t sysc::SurfaceMesh::connectivityStamp {0}

Mesh connectivity stamp. Update whenever re-meshing happens.

Type: std::int64_t

Variable coordinatesStamp​

Definition: SurfaceMesh.hpp (line 33)

std::int64_t sysc::SurfaceMesh::coordinatesStamp {0}

Nodal coordinates stamp. Update whenever nodal coordinates get updated.

Type: std::int64_t

Variable partitioningStamp​

Definition: SurfaceMesh.hpp (line 36)

std::int64_t sysc::SurfaceMesh::partitioningStamp {0}

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

Type: std::int64_t

Private attributes​

Variable m_nodes​

Definition: SurfaceMesh.hpp (line 170)

NodeData sysc::SurfaceMesh::m_nodes

Type: NodeData

Variable m_faces​

Definition: SurfaceMesh.hpp (line 171)

FaceData sysc::SurfaceMesh::m_faces

Type: FaceData

Variable m_side0​

Definition: SurfaceMesh.hpp (line 173)

RegionName sysc::SurfaceMesh::m_side0

Type: RegionName

Variable m_side1​

Definition: SurfaceMesh.hpp (line 174)

RegionName sysc::SurfaceMesh::m_side1

Type: RegionName

Public functions​

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(NodeData nodes, FaceData faces)

Constructor.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh()=default

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(const SurfaceMesh &)=default

Provide a copy-constructor.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(SurfaceMesh &&)=default

Provide a move-constructor.

Parameters:

Return type:

Function operator=​

SurfaceMesh& sysc::SurfaceMesh::operator=(const SurfaceMesh &)=default

Provide a copy-assign operator.

Parameters:

Return type: SurfaceMesh &

Function operator=​

SurfaceMesh& sysc::SurfaceMesh::operator=(SurfaceMesh &&)=default

Provide a move-assign operator.

Parameters:

Return type: SurfaceMesh &

Function getNodeData​

const NodeData& sysc::SurfaceMesh::getNodeData() const noexcept

Get node data.

Return type: const NodeData &

Function getFaceData​

const FaceData& sysc::SurfaceMesh::getFaceData() const noexcept

Get face data.

Return type: const FaceData &

Function getNumNodes​

std::size_t sysc::SurfaceMesh::getNumNodes() const

Provide a method to get the number of nodes for this mesh.

Return type: std::size_t

Function getNumElems​

std::size_t sysc::SurfaceMesh::getNumElems() const

Provide a method to get the number of elements for this mesh.

Return type: std::size_t

Function getNodeIds​

OutputIntegerData sysc::SurfaceMesh::getNodeIds() const

Provide a method to access node ids array.

Return type: OutputIntegerData

Function getNodeCoords​

OutputVectorData sysc::SurfaceMesh::getNodeCoords() const

Provide a method to access node coordinates array.

Return type: OutputVectorData

Function getElemTypes​

OutputIntegerData sysc::SurfaceMesh::getElemTypes() const

Provide a method to access element types array.

Return type: OutputIntegerData

Function getElemNodeCounts​

OutputIntegerData sysc::SurfaceMesh::getElemNodeCounts() const

Provide a method to access element node counts array.

Return type: OutputIntegerData

Function getElemNodeIds​

OutputIntegerData sysc::SurfaceMesh::getElemNodeIds() const

Provide a method to access element node ids array.

Return type: OutputIntegerData

Function getFaceCellConnectivity​

FaceCellConnectivityData sysc::SurfaceMesh::getFaceCellConnectivity() const noexcept

Return face-to-cell connectivity data.

Return type: FaceCellConnectivityData

Function setSide0​

void sysc::SurfaceMesh::setSide0(const RegionName &regionName)

Set side 0 region.

If this region is not a surface mesh region, then a run-time error will be thrown.

If the provided side 0 region is not a volume mesh region, then a run-time error will be thrown.

Parameters:

Return type: void

Function setSide1​

void sysc::SurfaceMesh::setSide1(const RegionName &regionName)

Set side 1 region.

If this region is not a surface mesh region, then a run-time error will be thrown.

If the provided side 0 region is not a volume mesh region, then a run-time error will be thrown.

Parameters:

Return type: void

Function hasSide0​

bool sysc::SurfaceMesh::hasSide0() const noexcept

Returns whether side 0 region is set.

Return type: bool

Function hasSide1​

bool sysc::SurfaceMesh::hasSide1() const noexcept

Returns whether side 1 region is set.

Return type: bool

Function getSide0​

const RegionName& sysc::SurfaceMesh::getSide0() const

Get side 0 region.

Return type: const RegionName &

Function getSide1​

const RegionName& sysc::SurfaceMesh::getSide1() const

Get side 1 region.

Return type: const RegionName &

Function checkValidity​

ValidityStatus sysc::SurfaceMesh::checkValidity() const

Provide a method to perform simple mesh validity checks.

See SystemCoupling::checkMeshValidity for more details.

Return type: ValidityStatus

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(NodeData nodes, ElementTypeData elemTypes, ElementNodeCountData elemNodeCounts, ElementNodeConnectivityData elemNodeIds, FaceCellConnectivityData faceCellConnectivity)

Construct the surface mesh object.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(NodeData nodes, ElementTypeData elementTypes, ElementNodeConnectivityData elementNodeIds)

Construct the surface mesh object.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(NodeData meshNodes, ElementNodeCountData faceNodeCounts, ElementNodeConnectivityData faceNodeIds)

Construct the surface mesh object.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(NodeData meshNodes, ElementNodeCountData faceNodeCounts, ElementNodeConnectivityData faceNodeIds, FaceCellConnectivityData faceCellConnectivity)

Construct the surface mesh object.

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(OutputIntegerData nodeIds, OutputVectorData nodeCoords, OutputIntegerData elemNodeCounts, OutputIntegerData elemNodeIds)

Parameters:

Return type:

Function SurfaceMesh​

sysc::SurfaceMesh::SurfaceMesh(OutputVectorData nodeCoords, OutputIntegerData elemNodeCounts, OutputIntegerData elemNodeIds)

Parameters:

Return type:

Function checkMeshValidity​

MeshValidityStatus sysc::SurfaceMesh::checkMeshValidity() const

This method is deprecated - do not use.

Return type: MeshValidityStatus