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

#include <faMeshSubset.H>

Collaboration diagram for faMeshSubset:

[legend]

Public Member Functions
	faMeshSubset (const faMeshSubset &)=delete
	No copy construct.
void	operator= (const faMeshSubset &)=delete
	No copy assignment.
	faMeshSubset (const faMesh &baseMesh) noexcept
	Construct using the entire mesh (no subset).
	faMeshSubset (const faMesh &baseMesh, Foam::zero)
	Construct a zero-sized subset mesh, non-processor patches only.
const faMesh &	baseMesh () const noexcept
	Original mesh.
const faMesh &	mesh () const noexcept
	Return baseMesh or subMesh, depending on the current state.
bool	hasSubMesh () const noexcept
	Have subMesh?
const faMesh &	subMesh () const
	Return reference to subset mesh.
faMesh &	subMesh ()
	Return reference to subset mesh.
const labelList &	pointMap () const
	Return point map.
const labelList &	faceMap () const
	Return face map.
const labelList &	edgeFlipMap () const
	Return edge map with sign to encode flipped edges.
const labelList &	cellMap () const
	Return cell map.
const labelList &	patchMap () const
	Return patch map.
void	clear ()
	Reset subMesh and all maps.
void	reset ()
	Reset subMesh and all maps. Same as clear().
void	reset (Foam::zero)
	Reset to a zero-sized subset mesh, non-processor patches only.
template<class Type>
tmp< GeometricField< Type, faPatchField, areaMesh > >	interpolate (const GeometricField< Type, faPatchField, areaMesh > &, const bool allowUnmapped=false) const
	Map area field.
template<class Type>
tmp< GeometricField< Type, faePatchField, edgeMesh > >	interpolate (const GeometricField< Type, faePatchField, edgeMesh > &, const bool allowUnmapped=false) const
	Map edge field.

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.
template<class Type>
static tmp< GeometricField< Type, faePatchField, edgeMesh > >	interpolate (const GeometricField< Type, faePatchField, edgeMesh > &, const faMesh &sMesh)
	Map edge field.

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

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

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.

References faMeshSubset().

Referenced by faMeshSubset(), and operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faMeshSubset() [2/3]

faMeshSubset ( const faMesh & baseMesh )

explicitnoexcept

Construct using the entire mesh (no subset).

References baseMesh().

Here is the call graph for this function:

◆ faMeshSubset() [3/3]

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

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

References baseMesh(), cellMap(), edgeFlipMap(), faceMap(), hasSubMesh(), mesh(), Foam::noexcept, patchMap(), pointMap(), and subMesh().

Here is the call graph for this function:

Member Function Documentation

◆ checkHasSubMesh()

bool checkHasSubMesh ( ) const

protected

FatalError if subset has not been performed.

Referenced by cellMap(), faceMap(), patchMap(), pointMap(), subMesh(), and subMesh().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const faMeshSubset & )

delete

No copy assignment.

References faMeshSubset().

Here is the call graph for this function:

◆ baseMesh()

const Foam::faMesh & baseMesh ( ) const

inlinenoexcept

Original mesh.

Definition at line 23 of file faMeshSubsetI.H.

References Foam::noexcept.

Referenced by faMeshSubset(), and faMeshSubset().

Here is the caller graph for this function:

◆ mesh()

const Foam::faMesh & mesh ( ) const

inlinenoexcept

Return baseMesh or subMesh, depending on the current state.

Definition at line 29 of file faMeshSubsetI.H.

References Foam::noexcept.

Referenced by faMeshSubset().

Here is the caller graph for this function:

◆ hasSubMesh()

bool hasSubMesh ( ) const

inlinenoexcept

Have subMesh?

Definition at line 35 of file faMeshSubsetI.H.

References Foam::noexcept.

Referenced by faMeshSubset().

Here is the caller graph for this function:

◆ subMesh() [1/2]

const Foam::faMesh & subMesh ( ) const

inline

Return reference to subset mesh.

Definition at line 41 of file faMeshSubsetI.H.

References checkHasSubMesh().

Referenced by faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ subMesh() [2/2]

Foam::faMesh & subMesh ( )

inline

Return reference to subset mesh.

Definition at line 49 of file faMeshSubsetI.H.

References checkHasSubMesh().

Here is the call graph for this function:

◆ pointMap()

const Foam::labelList & pointMap ( ) const

inline

Return point map.

Definition at line 57 of file faMeshSubsetI.H.

References checkHasSubMesh().

Referenced by faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceMap()

const Foam::labelList & faceMap ( ) const

inline

Return face map.

Definition at line 65 of file faMeshSubsetI.H.

References checkHasSubMesh().

Referenced by faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ edgeFlipMap()

const Foam::labelList & edgeFlipMap ( ) const

inline

Return edge map with sign to encode flipped edges.

Definition at line 73 of file faMeshSubsetI.H.

Referenced by faMeshSubset().

Here is the caller graph for this function:

◆ cellMap()

const Foam::labelList & cellMap ( ) const

inline

Return cell map.

Definition at line 84 of file faMeshSubsetI.H.

References checkHasSubMesh().

Referenced by faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchMap()

const Foam::labelList & patchMap ( ) const

inline

Return patch map.

Definition at line 92 of file faMeshSubsetI.H.

References checkHasSubMesh().

Referenced by faMeshSubset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clear()

void clear ( )

Reset subMesh and all maps.

References clear().

Referenced by clear().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [1/2]

void reset ( )

Reset subMesh and all maps. Same as clear().

References reset().

Referenced by reset(), and reset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset() [2/2]

void reset ( Foam::zero )

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

References reset().

Here is the call graph for this function:

◆ interpolate() [1/4]

template<class Type>

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

References interpolate().

Referenced by interpolate(), interpolate(), interpolate(), and interpolate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolate() [2/4]

template<class Type>

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

References interpolate().

Here is the call graph for this function:

◆ interpolate() [3/4]

template<class Type>

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

References interpolate().

Here is the call graph for this function:

◆ interpolate() [4/4]

template<class Type>

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

Map edge field.

References interpolate().

Here is the call graph for this function:

Member Data Documentation

◆ exposedPatchName

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/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