Represents an unstructured mesh in NeoN. More...

#include <unstructuredMesh.hpp>

Public Member Functions
	UnstructuredMesh (vectorVector points, scalarVector cellVolumes, vectorVector cellCentres, vectorVector faceAreas, vectorVector faceCentres, scalarVector magFaceAreas, labelVector faceOwner, labelVector faceNeighbour, localIdx nCells, localIdx nInternalFaces, localIdx nBoundaryFaces, localIdx nBoundaries, localIdx nFaces, BoundaryMesh boundaryMesh)
	Constructor for the UnstructuredMesh class.

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

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

const vectorVector &	cellCentres () const
	Get the field of cell centres in the mesh.

const vectorVector &	faceCentres () const
	Get the field of face centres.

const vectorVector &	faceAreas () const
	Get the field of area face normals.

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

const labelVector &	faceOwner () const
	Get the field of face owner cells.

const labelVector &	faceNeighbour () const
	Get the field of face neighbour cells.

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	nBoundaries () const
	Get the number of boundaries in the mesh.

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

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

StencilDataBase &	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 centres, face areas, face centres, 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 28 of file unstructuredMesh.hpp.

Constructor & Destructor Documentation

◆ UnstructuredMesh()

NeoN::UnstructuredMesh::UnstructuredMesh	(	vectorVector	points,
		scalarVector	cellVolumes,
		vectorVector	cellCentres,
		vectorVector	faceAreas,
		vectorVector	faceCentres,
		scalarVector	magFaceAreas,
		labelVector	faceOwner,
		labelVector	faceNeighbour,
		localIdx	nCells,
		localIdx	nInternalFaces,
		localIdx	nBoundaryFaces,
		localIdx	nBoundaries,
		localIdx	nFaces,
		BoundaryMesh	boundaryMesh
	)

Constructor for the UnstructuredMesh class.

Parameters

points	The field of mesh points.
cellVolumes	The field of cell volumes in the mesh.
cellCentres	The field of cell centres in the mesh.
faceAreas	The field of area face normals.
faceCentres	The field of face centres.
magFaceAreas	The field of magnitudes of face areas.
faceOwner	The field of face owner cells.
faceNeighbour	The field of face neighbour cells.
nCells	The number of cells in the mesh.
nInternalFaces	The number of internal faces in the mesh.
nBoundaryFaces	The number of boundary faces in the mesh.
nBoundaries	The number of boundaries in the mesh.
nFaces	The number of faces in the mesh.
boundaryMesh	The boundary mesh.

Member Function Documentation

◆ boundaryMesh()

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

Get the boundary mesh.

Returns: The boundary mesh.

◆ cellCentres()

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

Get the field of cell centres in the mesh.

Returns: The field of cell centres in the mesh.

◆ cellVolumes()

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()

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

Get the field of area face normals.

Returns: The field of area face normals.

◆ faceCentres()

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

Get the field of face centres.

Returns: The field of face centres.

◆ faceNeighbour()

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

Get the field of face neighbour cells.

Returns: The field of face neighbour cells.

◆ faceOwner()

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

Get the field of face owner cells.

Returns: The field of face owner cells.

◆ magFaceAreas()

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

Get the field of magnitudes of face areas.

Returns: The field of magnitudes of face areas.

◆ nBoundaries()

localIdx NeoN::UnstructuredMesh::nBoundaries ( ) const

Get the number of boundaries 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.

◆ nFaces()

localIdx NeoN::UnstructuredMesh::nFaces ( ) const

Get the number of faces in the mesh.

Returns: The number of faces 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.

◆ points()

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

Get the field of mesh points.

Returns: The field of mesh points.

◆ stencilDB()

StencilDataBase & 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