NeoN::BoundaryMesh Class Reference

Represents boundaries of an unstructured mesh. More...

#include <boundaryMesh.hpp>

Public Member Functions
	BoundaryMesh (const Executor &exec, labelVector faceCells, vectorVector cf, vectorVector cn, vectorVector sf, scalarVector magSf, vectorVector nf, vectorVector delta, scalarVector weights, scalarVector deltaCoeffs, std::vector< localIdx > offset)
	Constructor for the BoundaryMesh class.
const labelVector &	faceCells () const
	Get the field of face cells.
View< const label >	faceCells (const localIdx i) const
	Get a view of face cells for a specific boundary face.
const vectorVector &	cf () const
	Get the field of face centres.
View< const Vec3 >	cf (const localIdx i) const
	Get a view of face centres for a specific boundary face.
const vectorVector &	cn () const
	Get the field of face normals.
View< const Vec3 >	cn (const localIdx i) const
	Get a view of face normals for a specific boundary face.
const vectorVector &	sf () const
	Get the field of face areas normals.
View< const Vec3 >	sf (const localIdx i) const
	Get a view of face areas normals for a specific boundary face.
const scalarVector &	magSf () const
	Get the field of magnitudes of face areas normals.
View< const scalar >	magSf (const localIdx i) const
	Get a view of magnitudes of face areas normals for a specific boundary face.
const vectorVector &	nf () const
	Get the field of face unit normals.
View< const Vec3 >	nf (const localIdx i) const
	Get a view of face unit normals for a specific boundary face.
const vectorVector &	delta () const
	Get the field of delta vectors.
View< const Vec3 >	delta (const localIdx i) const
	Get a view of delta vectors for a specific boundary face.
const scalarVector &	weights () const
	Get the field of weights.
View< const scalar >	weights (const localIdx i) const
	Get a view of weights for a specific boundary face.
const scalarVector &	deltaCoeffs () const
	Get the field of delta coefficients.
View< const scalar >	deltaCoeffs (const localIdx i) const
	Get a view of delta coefficients for a specific boundary face.
const std::vector< localIdx > &	offset () const
	Get the offset of the boundary faces.

Detailed Description

Represents boundaries of an unstructured mesh.

The BoundaryMesh class stores information about the boundary faces and their properties in an unstructured mesh. It provides access to various fields such as face cells, face centres, face normals, face areas normals, magnitudes of face areas normals, delta vectors, weights, delta coefficients, and offsets.

The class also provides getter methods to access the individual fields and their components.

Template Parameters

Executor

The type of the executor used for computations.

Definition at line 27 of file boundaryMesh.hpp.

Constructor & Destructor Documentation

BoundaryMesh()

NeoN::BoundaryMesh::BoundaryMesh	(	const Executor &	exec,
		labelVector	faceCells,
		vectorVector	cf,
		vectorVector	cn,
		vectorVector	sf,
		scalarVector	magSf,
		vectorVector	nf,
		vectorVector	delta,
		scalarVector	weights,
		scalarVector	deltaCoeffs,
		std::vector< localIdx >	offset
	)

Constructor for the BoundaryMesh class.

Parameters

exec	The executor used for computations.
faceCells	A field with the neighbouring cell of each boundary face.
Cf	A field of face centres.
Cn	A field of neighbor cell centers.
Sf	A field of face areas normals.
magSf	A field of magnitudes of face areas normals.
nf	A field of face unit normals.
delta	A field of delta vectors.
weights	A field of weights used in cell to face interpolation.
deltaCoeffs	A field of cell to face distances.
offset	The offset of the boundary faces.

Member Function Documentation

cf() [1/2]

const vectorVector & NeoN::BoundaryMesh::cf

(

)

const

Get the field of face centres.

Returns

A constant reference to the field of face centres.

cf() [2/2]

View< const Vec3 > NeoN::BoundaryMesh::cf

(

const localIdx

i

)

const

Get a view of face centres for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of face centres for the specified boundary face.

cn() [1/2]

const vectorVector & NeoN::BoundaryMesh::cn

(

)

const

Get the field of face normals.

Returns

A constant reference to the field of face normals.

cn() [2/2]

View< const Vec3 > NeoN::BoundaryMesh::cn

(

const localIdx

i

)

const

Get a view of face normals for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of face normals for the specified boundary face.

delta() [1/2]

const vectorVector & NeoN::BoundaryMesh::delta

(

)

const

Get the field of delta vectors.

Returns

A constant reference to the field of delta vectors.

delta() [2/2]

View< const Vec3 > NeoN::BoundaryMesh::delta

(

const localIdx

i

)

const

Get a view of delta vectors for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of delta vectors for the specified boundary face.

deltaCoeffs() [1/2]

const scalarVector & NeoN::BoundaryMesh::deltaCoeffs

(

)

const

Get the field of delta coefficients.

Returns

A constant reference to the field of delta coefficients.

deltaCoeffs() [2/2]

View< const scalar > NeoN::BoundaryMesh::deltaCoeffs

(

const localIdx

i

)

const

Get a view of delta coefficients for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of delta coefficients for the specified boundary face.

faceCells() [1/2]

const labelVector & NeoN::BoundaryMesh::faceCells

(

)

const

Get the field of face cells.

Returns

A constant reference to the field of face cells.

faceCells() [2/2]

View< const label > NeoN::BoundaryMesh::faceCells

(

const localIdx

i

)

const

Get a view of face cells for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of face cells for the specified boundary face.

magSf() [1/2]

const scalarVector & NeoN::BoundaryMesh::magSf

(

)

const

Get the field of magnitudes of face areas normals.

Returns

A constant reference to the field of magnitudes of face areas normals.

magSf() [2/2]

View< const scalar > NeoN::BoundaryMesh::magSf

(

const localIdx

i

)

const

Get a view of magnitudes of face areas normals for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of magnitudes of face areas normals for the specified boundary face.

nf() [1/2]

const vectorVector & NeoN::BoundaryMesh::nf

(

)

const

Get the field of face unit normals.

Returns

A constant reference to the field of face unit normals.

nf() [2/2]

View< const Vec3 > NeoN::BoundaryMesh::nf

(

const localIdx

i

)

const

Get a view of face unit normals for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of face unit normals for the specified boundary face.

offset()

const std::vector< localIdx > & NeoN::BoundaryMesh::offset

(

)

const

Get the offset of the boundary faces.

Returns

A constant reference to the offset of the boundary faces.

sf() [1/2]

const vectorVector & NeoN::BoundaryMesh::sf

(

)

const

Get the field of face areas normals.

Returns

A constant reference to the field of face areas normals.

sf() [2/2]

View< const Vec3 > NeoN::BoundaryMesh::sf

(

const localIdx

i

)

const

Get a view of face areas normals for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of face areas normals for the specified boundary face.

weights() [1/2]

const scalarVector & NeoN::BoundaryMesh::weights

(

)

const

Get the field of weights.

Returns

A constant reference to the boundary field of weights.

weights() [2/2]

View< const scalar > NeoN::BoundaryMesh::weights

(

const localIdx

i

)

const

Get a view of weights for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A view of weights for the specified boundary face.

---

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

• /home/runner/work/NeoN/NeoN/include/NeoN/mesh/unstructured/boundaryMesh.hpp