NeoFOAM::BoundaryMesh Class Reference

Represents boundaries of an unstructured mesh. More...

#include <boundaryMesh.hpp>

Public Member Functions
	BoundaryMesh (const Executor &exec, labelField faceCells, vectorField cf, vectorField cn, vectorField sf, scalarField magSf, vectorField nf, vectorField delta, scalarField weights, scalarField deltaCoeffs, std::vector< localIdx > offset)
	Constructor for the BoundaryMesh class.
const labelField &	faceCells () const
	Get the field of face cells.
std::span< const label >	faceCells (const localIdx i) const
	Get a span of face cells for a specific boundary face.
const vectorField &	cf () const
	Get the field of face centres.
std::span< const Vector >	cf (const localIdx i) const
	Get a span of face centres for a specific boundary face.
const vectorField &	cn () const
	Get the field of face normals.
std::span< const Vector >	cn (const localIdx i) const
	Get a span of face normals for a specific boundary face.
const vectorField &	sf () const
	Get the field of face areas normals.
std::span< const Vector >	sf (const localIdx i) const
	Get a span of face areas normals for a specific boundary face.
const scalarField &	magSf () const
	Get the field of magnitudes of face areas normals.
std::span< const scalar >	magSf (const localIdx i) const
	Get a span of magnitudes of face areas normals for a specific boundary face.
const vectorField &	nf () const
	Get the field of face unit normals.
std::span< const Vector >	nf (const localIdx i) const
	Get a span of face unit normals for a specific boundary face.
const vectorField &	delta () const
	Get the field of delta vectors.
std::span< const Vector >	delta (const localIdx i) const
	Get a span of delta vectors for a specific boundary face.
const scalarField &	weights () const
	Get the field of weights.
std::span< const scalar >	weights (const localIdx i) const
	Get a span of weights for a specific boundary face.
const scalarField &	deltaCoeffs () const
	Get the field of delta coefficients.
std::span< const scalar >	deltaCoeffs (const localIdx i) const
	Get a span 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()

NeoFOAM::BoundaryMesh::BoundaryMesh	(	const Executor &	exec,
		labelField	faceCells,
		vectorField	cf,
		vectorField	cn,
		vectorField	sf,
		scalarField	magSf,
		vectorField	nf,
		vectorField	delta,
		scalarField	weights,
		scalarField	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 vectorField & NeoFOAM::BoundaryMesh::cf

(

)

const

Get the field of face centres.

Returns

A constant reference to the field of face centres.

cf() [2/2]

std::span< const Vector > NeoFOAM::BoundaryMesh::cf

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

A span of face centres for the specified boundary face.

cn() [1/2]

const vectorField & NeoFOAM::BoundaryMesh::cn

(

)

const

Get the field of face normals.

Returns

A constant reference to the field of face normals.

cn() [2/2]

std::span< const Vector > NeoFOAM::BoundaryMesh::cn

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

A span of face normals for the specified boundary face.

delta() [1/2]

const vectorField & NeoFOAM::BoundaryMesh::delta

(

)

const

Get the field of delta vectors.

Returns

A constant reference to the field of delta vectors.

delta() [2/2]

std::span< const Vector > NeoFOAM::BoundaryMesh::delta

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

A span of delta vectors for the specified boundary face.

deltaCoeffs() [1/2]

const scalarField & NeoFOAM::BoundaryMesh::deltaCoeffs

(

)

const

Get the field of delta coefficients.

Returns

A constant reference to the field of delta coefficients.

deltaCoeffs() [2/2]

std::span< const scalar > NeoFOAM::BoundaryMesh::deltaCoeffs

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

A span of delta coefficients for the specified boundary face.

faceCells() [1/2]

const labelField & NeoFOAM::BoundaryMesh::faceCells

(

)

const

Get the field of face cells.

Returns

A constant reference to the field of face cells.

faceCells() [2/2]

std::span< const label > NeoFOAM::BoundaryMesh::faceCells

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

A span of face cells for the specified boundary face.

magSf() [1/2]

const scalarField & NeoFOAM::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]

std::span< const scalar > NeoFOAM::BoundaryMesh::magSf

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

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

nf() [1/2]

const vectorField & NeoFOAM::BoundaryMesh::nf

(

)

const

Get the field of face unit normals.

Returns

A constant reference to the field of face unit normals.

nf() [2/2]

std::span< const Vector > NeoFOAM::BoundaryMesh::nf

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

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

offset()

const std::vector< localIdx > & NeoFOAM::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 vectorField & NeoFOAM::BoundaryMesh::sf

(

)

const

Get the field of face areas normals.

Returns

A constant reference to the field of face areas normals.

sf() [2/2]

std::span< const Vector > NeoFOAM::BoundaryMesh::sf

(

const localIdx

i

)

const

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

Parameters

i	The index of the boundary face.

Returns

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

weights() [1/2]

const scalarField & NeoFOAM::BoundaryMesh::weights

(

)

const

Get the field of weights.

Returns

A constant reference to the boundary field of weights.

weights() [2/2]

std::span< const scalar > NeoFOAM::BoundaryMesh::weights

(

const localIdx

i

)

const

Get a span of weights for a specific boundary face.

Parameters

i	The index of the boundary face.

Returns

A span of weights for the specified boundary face.

---

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

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