Holds a reference to the original mesh (the baseMesh) and optionally to a subset of that mesh (the subMesh) with mapping lists for points, faces, and cells. More...

Collaboration diagram for faMeshSubset:

[legend]

Public Member Functions
	faMeshSubset (const faMeshSubset &)=delete
	No copy construct. More...

void	operator= (const faMeshSubset &)=delete
	No copy assignment. More...

	faMeshSubset (const faMesh &baseMesh)
	Construct using the entire mesh (no subset) More...

	faMeshSubset (const faMesh &baseMesh, const Foam::zero)
	Construct a zero-sized subset mesh, non-processor patches only. More...

const faMesh &	baseMesh () const noexcept
	Original mesh. More...

const faMesh &	mesh () const noexcept
	Return baseMesh or subMesh, depending on the current state. More...

bool	hasSubMesh () const noexcept
	Have subMesh? More...

const faMesh &	subMesh () const
	Return reference to subset mesh. More...

faMesh &	subMesh ()
	Return reference to subset mesh. More...

const labelList &	pointMap () const
	Return point map. More...

const labelList &	faceMap () const
	Return face map. More...

const labelList &	edgeFlipMap () const
	Return edge map with sign to encode flipped edges. More...

const labelList &	cellMap () const
	Return cell map. More...

const labelList &	patchMap () const
	Return patch map. More...

void	clear ()
	Reset subMesh and all maps. More...

void	reset ()
	Reset subMesh and all maps. Same as clear() More...

void	reset (const Foam::zero)
	Reset to a zero-sized subset mesh, non-processor patches only. More...

template<class Type >
tmp< GeometricField< Type, faPatchField, areaMesh > >	interpolate (const GeometricField< Type, faPatchField, areaMesh > &, const bool allowUnmapped=false) const
	Map area field. More...

template<class Type >
tmp< GeometricField< Type, faePatchField, edgeMesh > >	interpolate (const GeometricField< Type, faePatchField, edgeMesh > &, const bool allowUnmapped=false) const
	Map edge field. More...

Static Public Member Functions
template<class Type >
static tmp< GeometricField< Type, faPatchField, areaMesh > >	interpolate (const GeometricField< Type, faPatchField, areaMesh > &, const faMesh &sMesh, const bool allowUnmapped=false)
	Map area field. More...

template<class Type >
static tmp< GeometricField< Type, faePatchField, edgeMesh > >	interpolate (const GeometricField< Type, faePatchField, edgeMesh > &, const faMesh &sMesh)
	Map edge field. More...

Static Public Attributes
static word	exposedPatchName
	Name for exposed internal edges (default: oldInternalEdges) More...

Protected Member Functions
bool	checkHasSubMesh () const
	FatalError if subset has not been performed. More...

Detailed Description

Holds a reference to the original mesh (the baseMesh) and optionally to a subset of that mesh (the subMesh) with mapping lists for points, faces, and cells.

Caution Currently not really functional for subsetting beyond handling a simple zero-sized mesh.

Source files

Definition at line 61 of file faMeshSubset.H.

Constructor & Destructor Documentation

◆ faMeshSubset() [1/3]

faMeshSubset ( const faMeshSubset & )

delete

No copy construct.

◆ faMeshSubset() [2/3]

faMeshSubset ( const faMesh & baseMesh )

explicit

Construct using the entire mesh (no subset)

Definition at line 52 of file faMeshSubset.C.

◆ faMeshSubset() [3/3]

faMeshSubset	(	const faMesh &	baseMesh,
		const Foam::zero
	)

Construct a zero-sized subset mesh, non-processor patches only.

Definition at line 64 of file faMeshSubset.C.

References faMeshSubset::reset().

Here is the call graph for this function:

Member Function Documentation

◆ checkHasSubMesh()

bool checkHasSubMesh ( ) const

protected

FatalError if subset has not been performed.

Definition at line 35 of file faMeshSubset.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Here is the call graph for this function:

◆ operator=()

void operator= ( const faMeshSubset & )

delete

No copy assignment.

◆ baseMesh()

const Foam::faMesh & baseMesh ( ) const

inlinenoexcept

Original mesh.

Definition at line 23 of file faMeshSubsetI.H.

◆ mesh()

const Foam::faMesh & mesh ( ) const

inlinenoexcept

Return baseMesh or subMesh, depending on the current state.

Definition at line 29 of file faMeshSubsetI.H.

◆ hasSubMesh()

bool hasSubMesh ( ) const

inlinenoexcept

Have subMesh?

Definition at line 35 of file faMeshSubsetI.H.

◆ subMesh() [1/2]

const Foam::faMesh & subMesh ( ) const

inline

Return reference to subset mesh.

Definition at line 41 of file faMeshSubsetI.H.

◆ subMesh() [2/2]

Foam::faMesh & subMesh ( )

inline

Return reference to subset mesh.

Definition at line 49 of file faMeshSubsetI.H.

◆ pointMap()

const Foam::labelList & pointMap ( ) const

inline

Return point map.

Definition at line 57 of file faMeshSubsetI.H.

◆ faceMap()

const Foam::labelList & faceMap ( ) const

inline

Return face map.

Definition at line 65 of file faMeshSubsetI.H.

◆ edgeFlipMap()

const Foam::labelList & edgeFlipMap ( ) const

inline

Return edge map with sign to encode flipped edges.

Definition at line 73 of file faMeshSubsetI.H.

◆ cellMap()

const Foam::labelList & cellMap ( ) const

inline

Return cell map.

Definition at line 84 of file faMeshSubsetI.H.

◆ patchMap()

const Foam::labelList & patchMap ( ) const

inline

Return patch map.

Definition at line 92 of file faMeshSubsetI.H.

◆ clear()

void clear ( )

Reset subMesh and all maps.

Definition at line 74 of file faMeshSubset.C.

◆ reset() [1/2]

void reset ( )

Reset subMesh and all maps. Same as clear()

Definition at line 86 of file faMeshSubset.C.

References clear().

Referenced by faMeshSubset::faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [2/2]

void reset ( const Foam::zero )

Reset to a zero-sized subset mesh, non-processor patches only.

Definition at line 92 of file faMeshSubset.C.

References clear(), forAll, Foam::identity(), and faBoundaryMesh::nNonProcessor().

Here is the call graph for this function:

◆ interpolate() [1/4]

static tmp<GeometricField<Type, faPatchField, areaMesh> > interpolate	(	const GeometricField< Type, faPatchField, areaMesh > &	,
		const faMesh &	sMesh,
		const bool	allowUnmapped = `false`
	)

static

Map area field.

Optionally allow unmapped faces not to produce a warning

◆ interpolate() [2/4]

static tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate	(	const GeometricField< Type, faePatchField, edgeMesh > &	,
		const faMesh &	sMesh
	)

static

Map edge field.

Optionally allow unmapped faces not to produce a warning

◆ interpolate() [3/4]

tmp<GeometricField<Type, faPatchField, areaMesh> > interpolate	(	const GeometricField< Type, faPatchField, areaMesh > &	,
		const bool	allowUnmapped = `false`
	)		const

Map area field.

Optionally allow unmapped faces not to produce a warning

◆ interpolate() [4/4]

tmp<GeometricField<Type, faePatchField, edgeMesh> > interpolate	(	const GeometricField< Type, faePatchField, edgeMesh > &	,
		const bool	allowUnmapped = `false`
	)		const

Map edge field.

Member Data Documentation

◆ exposedPatchName

Foam::word exposedPatchName

static

Name for exposed internal edges (default: oldInternalEdges)

Definition at line 126 of file faMeshSubset.H.

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

src/finiteArea/faMesh/faMeshSubset/faMeshSubset.H
src/finiteArea/faMesh/faMeshSubset/faMeshSubset.C
src/finiteArea/faMesh/faMeshSubset/faMeshSubsetI.H

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ faMeshSubset() [1/3]

◆ faMeshSubset() [2/3]

◆ faMeshSubset() [3/3]

Member Function Documentation

◆ checkHasSubMesh()

◆ operator=()

◆ baseMesh()

◆ mesh()

◆ hasSubMesh()

◆ subMesh() [1/2]

◆ subMesh() [2/2]

◆ pointMap()

◆ faceMap()

◆ edgeFlipMap()

◆ cellMap()

◆ patchMap()

◆ clear()

◆ reset() [1/2]

◆ reset() [2/2]

◆ interpolate() [1/4]

◆ interpolate() [2/4]

◆ interpolate() [3/4]

◆ interpolate() [4/4]

Member Data Documentation

◆ exposedPatchName