A subset of mesh faces organised as a primitive patch. More...

Inheritance diagram for faceZone:

Collaboration diagram for faceZone:

Public Member Functions
	TypeName ("faceZone")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm),(name, dict, index, zm))

	faceZone (const word &name, const label index, const faceZoneMesh &zm)
	Construct an empty zone. More...

	faceZone (const word &name, const labelUList &addr, const bool flipMapValue, const label index, const faceZoneMesh &zm)
	Construct from components with uniform flip map value. More...

	faceZone (const word &name, labelList &&addr, const bool flipMapValue, const label index, const faceZoneMesh &zm)

	faceZone (const word &name, const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm)
	Construct from components. More...

	faceZone (const word &name, labelList &&addr, boolList &&fm, const label index, const faceZoneMesh &zm)
	Construct from components, transferring addressing. More...

	faceZone (const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)
	Construct from dictionary. More...

	faceZone (const faceZone &origZone, const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm)

	faceZone (const faceZone &origZone, labelList &&addr, boolList &&fm, const label index, const faceZoneMesh &zm)

virtual autoPtr< faceZone >	clone (const faceZoneMesh &zm) const
	Construct and return a clone, resetting the zone mesh. More...

virtual autoPtr< faceZone >	clone (const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm) const

virtual	~faceZone ()
	Destructor. More...

const faceZoneMesh &	zoneMesh () const noexcept
	Return reference to the zone mesh. More...

const boolList &	flipMap () const noexcept
	Return face flip map. More...

label	whichFace (const label globalCellID) const
	Helper function to re-direct to zone::localID(...) More...

const primitiveFacePatch &	operator() () const
	Return reference to primitive patch. More...

const labelList &	masterCells () const

const labelList &	slaveCells () const
	Return labels of slave cells. More...

const labelList &	meshEdges () const
	Return global edge index for local edges. More...

virtual void	clearAddressing ()
	Clear addressing. More...

virtual void	resetAddressing (const labelUList &addr, const bool flipMapValue)
	Reset addressing - use uniform flip map value. More...

virtual void	resetAddressing (const labelUList &addr, const boolUList &flipMap)
	Reset addressing and flip map. More...

virtual void	resetAddressing (labelList &&addr, const bool flipMapValue)
	Move reset addressing - use uniform flip map value. More...

virtual bool	checkDefinition (const bool report=false) const
	Check zone definition. Return true if in error. More...

virtual bool	checkParallelSync (const bool report=false) const
	Check whether all procs have faces synchronised. More...

virtual void	movePoints (const pointField &pts)
	Correct patch after moving points. More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes in topology. More...

virtual void	write (Ostream &os) const
	Write. More...

virtual void	writeDict (Ostream &os) const
	Write dictionary. More...

Public Member Functions inherited from zone
	TypeName ("zone")
	Runtime type information. More...

	zone ()
	Default construct. More...

	zone (const word &name, const label index)
	Construct an empty zone. More...

	zone (const word &name, const labelUList &addr, const label index)
	Copy construct from components. More...

	zone (const word &name, labelList &&addr, const label index)
	Move construct from components. More...

	zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
	Construct from dictionary. More...

	zone (const zone &origZone, const labelUList &addr, const label index)

	zone (const zone &origZone, labelList &&addr, const label index)

virtual	~zone ()
	Destructor. More...

const Map< label > &	lookupMap () const
	Demand-driven: the look-up map from global to local id. More...

label	localID (const label globalID) const
	Lookup local address in zone for given global index. More...

const labelList &	addressing () const noexcept
	The addressing used by the zone. More...

virtual bool	checkDefinition (const label maxSize, const bool report=false) const
	Check zone definition with max size given. Return true if in error. More...

Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct. More...

zoneIdentifier &	operator= (const zoneIdentifier &)=default
	Copy assignment. More...

virtual	~zoneIdentifier ()=default
	Destructor. More...

	zoneIdentifier ()
	Default construct. Uses name="", index=0. More...

	zoneIdentifier (const word &name, const label index)
	Construct from mandatory components. More...

	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components. More...

	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary. More...

	zoneIdentifier (const zoneIdentifier &ident, const label index)
	Copy construct, resetting the index. More...

const word &	name () const noexcept
	The zone name. More...

word &	name () noexcept
	Modifiable zone name. More...

label	index () const noexcept
	The index of this zone in the zone list. More...

label &	index () noexcept
	Modifiable index of this zone in the zone list. More...

const word &	physicalType () const noexcept
	The (optional) type of the zone. More...

word &	physicalType () noexcept
	Modifiable (optional) type of the zone. More...

const wordList &	inGroups () const noexcept
	The (optional) groups that the zone belongs to. More...

wordList &	inGroups () noexcept
	Modifiable (optional) groups that the zone belongs to. More...

bool	inGroup (const word &name) const
	True if given name is in a group. More...

void	write (Ostream &os) const

Public Member Functions inherited from List< label >
constexpr	List () noexcept
	Default construct. More...

	List (const label len)
	Construct with given size. More...

	List (const label len, const label &val)
	Construct with given size and value for all elements. More...

	List (const label len, const Foam::zero)
	Construct with given size initializing all elements to zero. More...

	List (const Foam::one, const label &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, label &&val)
	Construct with length=1, moving the value as the only content. More...

	List (const Foam::one, const Foam::zero)
	Construct with length=1, initializing content to zero. More...

	List (const List< label > &a)
	Copy construct from list. More...

	List (const UList< label > &a)
	Copy construct contents from list. More...

	List (List< label > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< label > &list, const labelUList &indices)
	Copy construct subset of list. More...

	List (const UList< label > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

	List (const FixedList< label, N > &list)
	Construct as copy of FixedList<T, N> More...

	List (const PtrList< label > &list)
	Construct as copy of PtrList<T> More...

	List (const SLList< label > &list)
	Construct as copy of SLList<T> More...

	List (const IndirectListBase< label, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< label > list)
	Construct from an initializer list. More...

	List (List< label > &&list)
	Move construct from List. More...

	List (DynamicList< label, SizeMin > &&list)
	Move construct from DynamicList. More...

	List (SortableList< label > &&list)
	Move construct from SortableList. More...

	List (SLList< label > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. More...

autoPtr< List< label > >	clone () const
	Clone. More...

	~List ()
	Destructor. More...

void	clear ()
	Clear the list, i.e. set size to zero. More...

void	resize (const label len)
	Adjust allocated size of list. More...

void	resize (const label len, const label &val)
	Adjust allocated size of list and set val for new elements. More...

void	resize (const label newLen)

void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

void	setSize (const label n)
	Alias for resize() More...

void	setSize (const label n, const label &val)
	Alias for resize() More...

void	append (const label &val)
	Append an element at the end of the list. More...

void	append (label &&val)
	Move append an element at the end of the list. More...

void	append (const UList< label > &list)
	Append a List to the end of this list. More...

void	append (const IndirectListBase< label, Addr > &list)
	Append IndirectList contents at the end of this list. More...

label	appendUniq (const label &val)
	Append an element if not already in the list. More...

void	transfer (List< label > &list)

void	transfer (DynamicList< label, SizeMin > &list)

void	transfer (SortableList< label > &list)

label &	newElmt (const label i)

void	operator= (const UList< label > &a)
	Assignment to UList operator. Takes linear time. More...

void	operator= (const List< label > &list)
	Assignment operator. Takes linear time. More...

void	operator= (const SLList< label > &list)
	Assignment to SLList operator. Takes linear time. More...

void	operator= (const IndirectListBase< label, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

void	operator= (const FixedList< label, N > &list)
	Copy assignment from FixedList. More...

void	operator= (std::initializer_list< label > list)
	Assignment to an initializer list. More...

void	operator= (const label &val)
	Assignment of all entries to the given value. More...

void	operator= (const Foam::zero)
	Assignment of all entries to zero. More...

void	operator= (List< label > &&list)
	Move assignment. Takes constant time. More...

void	operator= (DynamicList< label, SizeMin > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SortableList< label > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< label > &&list)
	Move assignment. Takes constant time. More...

Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List. More...

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

void	shallowCopy (const UList< label > &)=delete
	No shallowCopy permitted. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool. More...

Static Public Member Functions
static autoPtr< faceZone >	New (const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)

Static Public Member Functions inherited from List< label >
static const List< label > &	null ()
	Return a null List. More...

Static Public Attributes
static const char *const	labelsName = "faceLabels"

Friends
Ostream &	operator<< (Ostream &os, const faceZone &zn)
	Ostream Operator. More...

Additional Inherited Members
Public Types inherited from List< label >
typedef SubList< label >	subList
	Declare type of subList. More...

Detailed Description

A subset of mesh faces organised as a primitive patch.

For quick check whether a face belongs to the zone use the lookup mechanism in faceZoneMesh, where all the zoned faces are registered with their zone number.

Source files

Definition at line 64 of file faceZone.H.

Constructor & Destructor Documentation

◆ faceZone() [1/8]

faceZone	(	const word &	name,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct an empty zone.

Definition at line 198 of file faceZone.C.

◆ faceZone() [2/8]

faceZone	(	const word &	name,
		const labelUList &	addr,
		const bool	flipMapValue,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct from components with uniform flip map value.

Definition at line 215 of file faceZone.C.

References List< T >::resize().

Here is the call graph for this function:

◆ faceZone() [3/8]

faceZone	(	const word &	name,
		labelList &&	addr,
		const bool	flipMapValue,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct from components with uniform flip map value, transferring addressing.

Definition at line 237 of file faceZone.C.

References List< T >::resize().

Here is the call graph for this function:

◆ faceZone() [4/8]

faceZone	(	const word &	name,
		const labelUList &	addr,
		const boolUList &	fm,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct from components.

Definition at line 259 of file faceZone.C.

◆ faceZone() [5/8]

faceZone	(	const word &	name,
		labelList &&	addr,
		boolList &&	fm,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct from components, transferring addressing.

Definition at line 280 of file faceZone.C.

◆ faceZone() [6/8]

faceZone	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct from dictionary.

Definition at line 301 of file faceZone.C.

◆ faceZone() [7/8]

faceZone	(	const faceZone &	origZone,
		const labelUList &	addr,
		const boolUList &	fm,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct with a new index and zone mesh information, the name of the original zone, resetting the face addressing and flip-map.

Definition at line 321 of file faceZone.C.

◆ faceZone() [8/8]

faceZone	(	const faceZone &	origZone,
		labelList &&	addr,
		boolList &&	fm,
		const label	index,
		const faceZoneMesh &	zm
	)

Construct with a new index and zone mesh information, the name of the original zone, (move) resetting the face addressing and flip-map.

Definition at line 342 of file faceZone.C.

◆ ~faceZone()

~faceZone ( )

virtual

Destructor.

Definition at line 364 of file faceZone.C.

Member Function Documentation

◆ TypeName()

TypeName ( "faceZone" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		faceZone	,
		dictionary	,
		(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)	,
		(name, dict, index, zm)
	)

◆ clone() [1/2]

virtual autoPtr<faceZone> clone ( const faceZoneMesh & zm ) const

inlinevirtual

Construct and return a clone, resetting the zone mesh.

Definition at line 227 of file faceZone.H.

References faceZone::flipMap(), zoneIdentifier::index(), and autoPtr< T >::New().

Here is the call graph for this function:

◆ clone() [2/2]

virtual autoPtr<faceZone> clone	(	const labelUList &	addr,
		const boolUList &	fm,
		const label	index,
		const faceZoneMesh &	zm
	)		const

inlinevirtual

Construct and return a clone, resetting the face list and zone mesh

Definition at line 235 of file faceZone.H.

References zoneIdentifier::index(), and autoPtr< T >::New().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::faceZone > New	(	const word &	name,
		const dictionary &	dict,
		const label	index,
		const faceZoneMesh &	zm
	)

static

Return a pointer to a new face zone created on freestore from dictionary

Definition at line 35 of file faceZoneNew.C.

References DebugInFunction, dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::name().

Here is the call graph for this function:

◆ zoneMesh()

const faceZoneMesh& zoneMesh ( ) const

inlinenoexcept

Return reference to the zone mesh.

Definition at line 266 of file faceZone.H.

◆ flipMap()

const boolList& flipMap ( ) const

inlinenoexcept

Return face flip map.

Definition at line 272 of file faceZone.H.

Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), faceZone::clone(), ensightMesh::correct(), directionalPressureGradientExplicitSource::correct(), meshRefinement::doSplitFaces(), faceZoneSet::faceZoneSet(), meshRefinement::getZoneFaces(), fluxSummary::initialiseFaceZone(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), duplicatePoints::setRefinement(), removeCells::setRefinement(), perfectInterface::setRefinement(), combineFaces::setRefinement(), tetDecomposer::setRefinement(), edgeCollapser::setRefinement(), addPatchCellLayer::setRefinement(), combineFaces::setUnrefinement(), and meshRefinement::splitFacesUndo().

Here is the caller graph for this function:

◆ whichFace()

Foam::label whichFace ( const label globalCellID ) const

Helper function to re-direct to zone::localID(...)

Definition at line 372 of file faceZone.C.

References zone::localID().

Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), meshRefinement::doSplitFaces(), edgeCollapser::markFaceZoneEdges(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), duplicatePoints::setRefinement(), removeCells::setRefinement(), perfectInterface::setRefinement(), combineFaces::setRefinement(), tetDecomposer::setRefinement(), edgeCollapser::setRefinement(), addPatchCellLayer::setRefinement(), combineFaces::setUnrefinement(), and meshRefinement::splitFacesUndo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator()()

const Foam::primitiveFacePatch & operator() ( ) const

Return reference to primitive patch.

Definition at line 378 of file faceZone.C.

◆ masterCells()

const Foam::labelList & masterCells ( ) const

Return labels of master cells (cells next to the master face zone in the prescribed direction)

Definition at line 389 of file faceZone.C.

Referenced by layerAdditionRemoval::changeTopology(), directionalPressureGradientExplicitSource::correct(), and snappyLayerDriver::doLayers().

Here is the caller graph for this function:

◆ slaveCells()

const Foam::labelList & slaveCells ( ) const

Return labels of slave cells.

Definition at line 400 of file faceZone.C.

Referenced by directionalPressureGradientExplicitSource::correct(), and snappyLayerDriver::doLayers().

Here is the caller graph for this function:

◆ meshEdges()

const Foam::labelList & meshEdges ( ) const

Return global edge index for local edges.

Definition at line 411 of file faceZone.C.

References mesh.

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Reimplemented from zone.

Definition at line 430 of file faceZone.C.

References zone::clearAddressing(), and Foam::deleteDemandDrivenData().

Here is the call graph for this function:

◆ resetAddressing() [1/3]

void resetAddressing	(	const labelUList &	addr,
		const bool	flipMapValue
	)

virtual

Reset addressing - use uniform flip map value.

Clears demand-driven data.

Definition at line 444 of file faceZone.C.

References List< T >::operator=().

Here is the call graph for this function:

◆ resetAddressing() [2/3]

void resetAddressing	(	const labelUList &	addr,
		const boolUList &	flipMap
	)

virtual

Reset addressing and flip map.

Clears demand-driven data.

Definition at line 456 of file faceZone.C.

References List< T >::operator=().

Here is the call graph for this function:

◆ resetAddressing() [3/3]

void resetAddressing	(	labelList &&	addr,
		const bool	flipMapValue
	)

virtual

Move reset addressing - use uniform flip map value.

Clears demand-driven data.

Definition at line 468 of file faceZone.C.

References List< T >::transfer().

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

virtual

Check zone definition. Return true if in error.

Implements zone.

Definition at line 510 of file faceZone.C.

References zone::checkDefinition(), and mesh.

Here is the call graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool report = false ) const

virtual

Check whether all procs have faces synchronised.

Returns: True if any errors.

Definition at line 516 of file faceZone.C.

References polyMesh::boundaryMesh(), coupled(), Foam::endl(), forAll, primitiveMesh::isInternalFace(), mesh, Foam::name(), IOobject::name(), primitiveMesh::nBoundaryFaces(), primitiveMesh::nInternalFaces(), Foam::Pout, Foam::returnReduce(), syncTools::swapBoundaryFaceList(), and polyBoundaryMesh::whichPatch().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const pointField & pts )

virtual

Correct patch after moving points.

Reimplemented from zone.

Definition at line 608 of file faceZone.C.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes in topology.

Definition at line 479 of file faceZone.C.

References Foam::faceMap(), forAll, mapPolyMesh::reverseFaceMap(), and List< T >::setSize().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from zone.

Definition at line 616 of file faceZone.C.

References Foam::name(), Foam::nl, and os().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

virtual

Write dictionary.

Implements zone.

Definition at line 624 of file faceZone.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), os(), Foam::type(), zoneIdentifier::write(), UList< T >::writeEntry(), and Ostream::writeEntry().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator<<

Ostream& operator<<	(	Ostream &	os,
		const faceZone &	zn
	)

friend

Ostream Operator.

Member Data Documentation

◆ labelsName

const char *const labelsName = "faceLabels"

static

The name associated with the zone-labels dictionary entry ("faceLabels")

Definition at line 118 of file faceZone.H.

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

src/OpenFOAM/meshes/polyMesh/zones/faceZone/faceZone.H
src/OpenFOAM/meshes/polyMesh/zones/faceZone/faceZone.C
src/OpenFOAM/meshes/polyMesh/zones/faceZone/faceZoneNew.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ faceZone() [1/8]

◆ faceZone() [2/8]

◆ faceZone() [3/8]

◆ faceZone() [4/8]

◆ faceZone() [5/8]

◆ faceZone() [6/8]

◆ faceZone() [7/8]

◆ faceZone() [8/8]

◆ ~faceZone()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ zoneMesh()

◆ flipMap()

◆ whichFace()

◆ operator()()

◆ masterCells()

◆ slaveCells()

◆ meshEdges()

◆ clearAddressing()

◆ resetAddressing() [1/3]

◆ resetAddressing() [2/3]

◆ resetAddressing() [3/3]

◆ checkDefinition()

◆ checkParallelSync()

◆ movePoints()

◆ updateMesh()

◆ write()

◆ writeDict()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ labelsName