Represents an unstructured mesh in NeoFOAM. More...

#include <unstructuredMesh.hpp>

Public Member Functions
	UnstructuredMesh (vectorField points, scalarField cellVolumes, vectorField cellCentres, vectorField faceAreas, vectorField faceCentres, scalarField magFaceAreas, labelField faceOwner, labelField faceNeighbour, size_t nCells, size_t nInternalFaces, size_t nBoundaryFaces, size_t nBoundaries, size_t nFaces, BoundaryMesh boundaryMesh)
	Constructor for the UnstructuredMesh class.

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

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

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

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

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

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

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

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

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

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

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

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

size_t	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 NeoFOAM.

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 26 of file unstructuredMesh.hpp.

Constructor & Destructor Documentation

◆ UnstructuredMesh()

NeoFOAM::UnstructuredMesh::UnstructuredMesh	(	vectorField	points,
		scalarField	cellVolumes,
		vectorField	cellCentres,
		vectorField	faceAreas,
		vectorField	faceCentres,
		scalarField	magFaceAreas,
		labelField	faceOwner,
		labelField	faceNeighbour,
		size_t	nCells,
		size_t	nInternalFaces,
		size_t	nBoundaryFaces,
		size_t	nBoundaries,
		size_t	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 & NeoFOAM::UnstructuredMesh::boundaryMesh ( ) const

Get the boundary mesh.

Returns: The boundary mesh.

◆ cellCentres()

const vectorField & NeoFOAM::UnstructuredMesh::cellCentres ( ) const

Get the field of cell centres in the mesh.

Returns: The field of cell centres in the mesh.

◆ cellVolumes()

const scalarField & NeoFOAM::UnstructuredMesh::cellVolumes ( ) const

Get the field of cell volumes in the mesh.

Returns: The field of cell volumes in the mesh.

◆ exec()

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

Get the executor.

Returns: The executor.

◆ faceAreas()

const vectorField & NeoFOAM::UnstructuredMesh::faceAreas ( ) const

Get the field of area face normals.

Returns: The field of area face normals.

◆ faceCentres()

const vectorField & NeoFOAM::UnstructuredMesh::faceCentres ( ) const

Get the field of face centres.

Returns: The field of face centres.

◆ faceNeighbour()

const labelField & NeoFOAM::UnstructuredMesh::faceNeighbour ( ) const

Get the field of face neighbour cells.

Returns: The field of face neighbour cells.

◆ faceOwner()

const labelField & NeoFOAM::UnstructuredMesh::faceOwner ( ) const

Get the field of face owner cells.

Returns: The field of face owner cells.

◆ magFaceAreas()

const scalarField & NeoFOAM::UnstructuredMesh::magFaceAreas ( ) const

Get the field of magnitudes of face areas.

Returns: The field of magnitudes of face areas.

◆ nBoundaries()

size_t NeoFOAM::UnstructuredMesh::nBoundaries ( ) const

Get the number of boundaries in the mesh.

Returns: The number of boundaries in the mesh.

◆ nBoundaryFaces()

size_t NeoFOAM::UnstructuredMesh::nBoundaryFaces ( ) const

Get the number of boundary faces in the mesh.

Returns: The number of boundary faces in the mesh.

◆ nCells()

size_t NeoFOAM::UnstructuredMesh::nCells ( ) const

Get the number of cells in the mesh.

Returns: The number of cells in the mesh.

◆ nFaces()

size_t NeoFOAM::UnstructuredMesh::nFaces ( ) const

Get the number of faces in the mesh.

Returns: The number of faces in the mesh.

◆ nInternalFaces()

size_t NeoFOAM::UnstructuredMesh::nInternalFaces ( ) const

Get the number of internal faces in the mesh.

Returns: The number of internal faces in the mesh.

◆ points()

const vectorField & NeoFOAM::UnstructuredMesh::points ( ) const

Get the field of mesh points.

Returns: The field of mesh points.

◆ stencilDB()

StencilDataBase & NeoFOAM::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/NeoFOAM/NeoFOAM/include/NeoFOAM/mesh/unstructured/unstructuredMesh.hpp

Public Member Functions