Represents an unstructured mesh in NeoN. More...

#include <unstructuredMesh.hpp>

Public Member Functions
	UnstructuredMesh (Executor exec, vectorVector points, scalarVector cellVolumes, vectorVector cellCenters, vectorVector faceNormals, vectorVector faceCenters, scalarVector faceAreas, labelVector faceOwners, labelVector faceNeighbors, BoundaryMesh boundaryMesh)
	Constructor for the UnstructuredMesh class.

	UnstructuredMesh (vectorVector points, scalarVector cellVolumes, vectorVector cellCenters, vectorVector faceNormals, vectorVector faceCenters, scalarVector faceAreas, labelVector faceOwners, labelVector faceNeighbors, BoundaryMesh boundaryMesh)
	Constructor for the UnstructuredMesh class.

const vectorVector &	points () const
	Get the field of mesh points.

vectorVector &	points ()

const scalarVector &	cellVolumes () const
	Get the field of cell volumes in the mesh.

scalarVector &	cellVolumes ()

const vectorVector &	cellCenters () const
	Get the field of cell centers in the mesh.

vectorVector &	cellCenters ()

const vectorVector &	faceCenters () const
	Get the field of face centers.

vectorVector &	faceCenters ()

const vectorVector &	faceNormals () const
	Get the field of face normal vectors.

vectorVector &	faceNormals ()

const scalarVector &	faceAreas () const
	Get the field of face areas.

scalarVector &	faceAreas ()

const labelVector &	faceOwners () const
	Get the list of labels of face owner cells.

labelVector &	faceOwners ()

const labelVector &	faceNeighbors () const
	Get the list of labels of face neighbor cells.

labelVector &	faceNeighbors ()

localIdx	nCells () const
	Get the number of cells in the mesh.

localIdx	nInternalFaces () const
	Get the number of internal faces in the mesh.

localIdx	nBoundaryFaces () const
	Get the number of boundary faces in the mesh.

localIdx	nTotalFaces () const
	Get the total number of faces including boundary and processor faces in the mesh.

localIdx	nBoundaries () const
	Get the number of boundaries patches in the mesh.

localIdx	nProcBoundaryFaces () const
	Get the number of processor-boundary faces (inter-rank faces).

localIdx	globalOffset () const
	the offset local cellIds for the global mesh.

const BoundaryMesh &	boundaryMesh () const
	Get the boundary mesh.

BoundaryMesh &	boundaryMesh ()

Dictionary &	stencilDB () const
	Get the stencil data base.

const Executor &	exec () const
	Get the executor.

Detailed Description

Represents an unstructured mesh in NeoN.

The UnstructuredMesh class stores the data and provides access to the properties of an unstructured mesh. It contains information such as mesh points, cell volumes, cell centers, face areas, face centers, face owner cells, face neighbour cells, and boundary information. It also provides methods to retrieve the number of cells, internal faces, boundary faces, boundaries, and faces in the mesh. Additionally, it includes a boundary mesh and a stencil data base. The executor is used to run parallel operations on the mesh.

Definition at line 30 of file unstructuredMesh.hpp.

Constructor & Destructor Documentation

◆ UnstructuredMesh() [1/2]

NeoN::UnstructuredMesh::UnstructuredMesh	(	Executor	exec,
		vectorVector	points,
		scalarVector	cellVolumes,
		vectorVector	cellCenters,
		vectorVector	faceNormals,
		vectorVector	faceCenters,
		scalarVector	faceAreas,
		labelVector	faceOwners,
		labelVector	faceNeighbors,
		BoundaryMesh	boundaryMesh
	)

Constructor for the UnstructuredMesh class.

Parameters

exec
points	The field of mesh points.
cellVolumes	The field of cell volumes in the mesh.
cellCenters	The field of cell centers in the mesh.
faceNormals	The field of face normal vectors.
faceCenters	The field of face centers.
faceAreas	The field of face areas.
faceOwners	The list of labels of face owner cells.
faceNeighbors	The list of labels of face neighbor cells.
boundaryMesh	The boundary mesh.

◆ UnstructuredMesh() [2/2]

NeoN::UnstructuredMesh::UnstructuredMesh	(	vectorVector	points,
		scalarVector	cellVolumes,
		vectorVector	cellCenters,
		vectorVector	faceNormals,
		vectorVector	faceCenters,
		scalarVector	faceAreas,
		labelVector	faceOwners,
		labelVector	faceNeighbors,
		BoundaryMesh	boundaryMesh
	)

Constructor for the UnstructuredMesh class.

Note: executor is determined from faceOwners

Parameters

points	The field of mesh points.
cellVolumes	The field of cell volumes in the mesh.
cellCenters	The field of cell centers in the mesh.
faceNormals	The field of face normal vectors.
faceCenters	The field of face centers.
faceAreas	The field of face areas.
faceOwners	The list of labels of face owner cells.
faceNeighbors	The list of labels of face neighbor cells.
boundaryMesh	The boundary mesh.

Member Function Documentation

◆ boundaryMesh() [1/2]

BoundaryMesh & NeoN::UnstructuredMesh::boundaryMesh ( )

◆ boundaryMesh() [2/2]

const BoundaryMesh & NeoN::UnstructuredMesh::boundaryMesh ( ) const

Get the boundary mesh.

Returns: The boundary mesh.

◆ cellCenters() [1/2]

vectorVector & NeoN::UnstructuredMesh::cellCenters ( )

◆ cellCenters() [2/2]

const vectorVector & NeoN::UnstructuredMesh::cellCenters ( ) const

Get the field of cell centers in the mesh.

Returns: The field of cell centers in the mesh.

◆ cellVolumes() [1/2]

scalarVector & NeoN::UnstructuredMesh::cellVolumes ( )

◆ cellVolumes() [2/2]

const scalarVector & NeoN::UnstructuredMesh::cellVolumes ( ) const

Get the field of cell volumes in the mesh.

Returns: The field of cell volumes in the mesh.

◆ exec()

const Executor & NeoN::UnstructuredMesh::exec ( ) const

Get the executor.

Returns: The executor.

◆ faceAreas() [1/2]

scalarVector & NeoN::UnstructuredMesh::faceAreas ( )

◆ faceAreas() [2/2]

const scalarVector & NeoN::UnstructuredMesh::faceAreas ( ) const

Get the field of face areas.

Returns: The field of face areas.

◆ faceCenters() [1/2]

vectorVector & NeoN::UnstructuredMesh::faceCenters ( )

◆ faceCenters() [2/2]

const vectorVector & NeoN::UnstructuredMesh::faceCenters ( ) const

Get the field of face centers.

Returns: The field of face centers.

◆ faceNeighbors() [1/2]

labelVector & NeoN::UnstructuredMesh::faceNeighbors ( )

◆ faceNeighbors() [2/2]

const labelVector & NeoN::UnstructuredMesh::faceNeighbors ( ) const

Get the list of labels of face neighbor cells.

Returns: The list of labels of face neighbor cells.

◆ faceNormals() [1/2]

vectorVector & NeoN::UnstructuredMesh::faceNormals ( )

◆ faceNormals() [2/2]

const vectorVector & NeoN::UnstructuredMesh::faceNormals ( ) const

Get the field of face normal vectors.

Returns: The field of face normal vectors.

◆ faceOwners() [1/2]

labelVector & NeoN::UnstructuredMesh::faceOwners ( )

◆ faceOwners() [2/2]

const labelVector & NeoN::UnstructuredMesh::faceOwners ( ) const

Get the list of labels of face owner cells.

Returns: The list of labels of face owner cells.

◆ globalOffset()

localIdx NeoN::UnstructuredMesh::globalOffset ( ) const

the offset local cellIds for the global mesh.

Returns: the global offset

◆ nBoundaries()

localIdx NeoN::UnstructuredMesh::nBoundaries ( ) const

Get the number of boundaries patches in the mesh.

Returns: The number of boundaries in the mesh.

◆ nBoundaryFaces()

localIdx NeoN::UnstructuredMesh::nBoundaryFaces ( ) const

Get the number of boundary faces in the mesh.

Returns: The number of boundary faces in the mesh.

◆ nCells()

localIdx NeoN::UnstructuredMesh::nCells ( ) const

Get the number of cells in the mesh.

Returns: The number of cells in the mesh.

◆ nInternalFaces()

localIdx NeoN::UnstructuredMesh::nInternalFaces ( ) const

Get the number of internal faces in the mesh.

Returns: The number of internal faces in the mesh.

◆ nProcBoundaryFaces()

localIdx NeoN::UnstructuredMesh::nProcBoundaryFaces ( ) const

Get the number of processor-boundary faces (inter-rank faces).

Returns 0 for single-process runs.

◆ nTotalFaces()

localIdx NeoN::UnstructuredMesh::nTotalFaces ( ) const

Get the total number of faces including boundary and processor faces in the mesh.

Returns: The total number of faces in the mesh.

◆ points() [1/2]

vectorVector & NeoN::UnstructuredMesh::points ( )

◆ points() [2/2]

const vectorVector & NeoN::UnstructuredMesh::points ( ) const

Get the field of mesh points.

Returns: The field of mesh points.

◆ stencilDB()

Dictionary & NeoN::UnstructuredMesh::stencilDB ( ) const

Get the stencil data base.

Returns: The stencil data base.

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

/home/runner/work/NeoN/NeoN/include/NeoN/mesh/unstructured/unstructuredMesh.hpp

Public Member Functions