faceZone Class Reference

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

Inheritance diagram for faceZone:

Collaboration diagram for faceZone:

Public Member Functions
	TypeName ("faceZone")
	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)
	faceZone (const word &name, const labelUList &addr, const bool flipMapValue, const label index, const faceZoneMesh &zm)
	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)
	faceZone (const word &name, labelList &&addr, boolList &&fm, const label index, const faceZoneMesh &zm)
	faceZone (const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)
	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
virtual autoPtr< faceZone >	clone (const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm) const
virtual	~faceZone ()
const faceZoneMesh &	zoneMesh () const noexcept
const boolList &	flipMap () const noexcept
label	whichFace (const label globalCellID) const
const primitiveFacePatch &	operator() () const
const labelList &	masterCells () const
const labelList &	slaveCells () const
const labelList &	meshEdges () const
virtual void	clearAddressing ()
virtual void	resetAddressing (const labelUList &addr, const bool flipMapValue)
virtual void	resetAddressing (const labelUList &addr, const boolUList &flipMap)
virtual void	resetAddressing (labelList &&addr, const bool flipMapValue)
virtual bool	checkDefinition (const bool report=false) const
virtual bool	checkParallelSync (const bool report=false) const
virtual void	movePoints (const pointField &pts)
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	write (Ostream &os) const
virtual void	writeDict (Ostream &os) const
Public Member Functions inherited from zone
	TypeName ("zone")
	zone ()
	zone (const word &name, const label index)
	zone (const word &name, const labelUList &addr, const label index)
	zone (const word &name, labelList &&addr, const label index)
	zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
	zone (const zone &origZone, const labelUList &addr, const label index)
	zone (const zone &origZone, labelList &&addr, const label index)
virtual	~zone ()
const Map< label > &	lookupMap () const
label	localID (const label globalID) const
const labelList &	addressing () const noexcept
virtual bool	checkDefinition (const label maxSize, const bool report=false) const
Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
zoneIdentifier &	operator= (const zoneIdentifier &)=default
virtual	~zoneIdentifier ()=default
	zoneIdentifier ()
	zoneIdentifier (const word &name, const label index)
	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	zoneIdentifier (const zoneIdentifier &ident, const label index)
const word &	name () const noexcept
word &	name () noexcept
label	index () const noexcept
label &	index () noexcept
const word &	physicalType () const noexcept
word &	physicalType () noexcept
const wordList &	inGroups () const noexcept
wordList &	inGroups () noexcept
bool	inGroup (const word &name) const
void	write (Ostream &os) const
Public Member Functions inherited from List
constexpr	List () noexcept
	List (const label len)
	List (const label len, const T &val)
	List (const label len, const Foam::zero)
	List (const Foam::one, const T &val)
	List (const Foam::one, T &&val)
	List (const Foam::one, const Foam::zero)
	List (const List< T > &a)
	List (const UList< T > &a)
	List (List< T > &a, bool reuse)
	List (const UList< T > &list, const labelUList &indices)
template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
template<unsigned N>
	List (const FixedList< T, N > &list)
	List (const PtrList< T > &list)
	List (const SLList< T > &list)
template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	List (std::initializer_list< T > list)
	List (List< T > &&list)
template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	List (SortableList< T > &&list)
	List (SLList< T > &&list)
	List (Istream &is)
autoPtr< List< T > >	clone () const
	~List ()
void	clear ()
void	resize (const label len)
void	resize (const label len, const T &val)
void	resize_nocopy (const label len)
void	setSize (const label n)
void	setSize (const label n, const T &val)
void	append (const T &val)
void	append (T &&val)
void	append (const UList< T > &list)
template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
label	appendUniq (const T &val)
void	transfer (List< T > &list)
template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)
void	transfer (SortableList< T > &list)
T &	newElmt (const label i)
void	operator= (const UList< T > &a)
void	operator= (const List< T > &list)
void	operator= (const SLList< T > &list)
template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
template<unsigned N>
void	operator= (const FixedList< T, N > &list)
void	operator= (std::initializer_list< T > list)
void	operator= (const T &val)
void	operator= (const Foam::zero)
void	operator= (List< T > &&list)
template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
void	operator= (SortableList< T > &&list)
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
void	shallowCopy (const UList< T > &)=delete
template<class TypeT = T>
std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	set (const label i, bool val=true)
template<class T >
	List (const label len)
template<class T >
	List (const label len, const T &val)
template<class T >
	List (const label len, const Foam::zero)
template<class T >
	List (const Foam::one, const T &val)
template<class T >
	List (const Foam::one, T &&val)
template<class T >
	List (const Foam::one, const Foam::zero)
template<class T >
	List (const UList< T > &a)
template<class T >
	List (const List< T > &a)
template<class T >
	List (List< T > &a, bool reuse)
template<class T >
	List (const UList< T > &list, const labelUList &indices)
template<class T >
	List (const PtrList< T > &list)
template<class T >
	List (const SLList< T > &list)
template<class T >
	List (std::initializer_list< T > list)
template<class T >
	List (List< T > &&list)
template<class T >
	List (SortableList< T > &&list)
template<class T >
	List (SLList< T > &&list)
template<class T >
void	transfer (List< T > &list)
template<class T >
void	transfer (SortableList< T > &list)
template<class T >
void	operator= (const UList< T > &a)
template<class T >
void	operator= (const List< T > &list)
template<class T >
void	operator= (const SLList< T > &list)
template<class T >
void	operator= (std::initializer_list< T > list)
template<class T >
void	operator= (List< T > &&list)
template<class T >
void	operator= (SortableList< T > &&list)
template<class T >
void	operator= (SLList< T > &&list)
Istream &	readList (Istream &is)
template<class T >
constexpr	List () noexcept
void	resize (const label newLen)
template<class T >
void	append (const T &val)
template<class T >
void	append (T &&val)
template<class T >
void	append (const UList< T > &list)
template<class T >
void	operator= (const T &val)
template<class T >
void	operator= (const Foam::zero)
template<class T >
	List (Istream &is)
Istream &	readList (Istream &is)

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
static const List< T > &	null ()

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

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

Additional Inherited Members
Public Types inherited from List
typedef SubList< T >	subList

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

• faceZone.H
• faceZone.C
• faceZoneNew.C

Definition at line 60 of file faceZone.H.

Constructor & Destructor Documentation

faceZone() [1/8]

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

Definition at line 191 of file faceZone.C.

faceZone() [2/8]

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

Definition at line 208 of file faceZone.C.

References List::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
	)

Definition at line 230 of file faceZone.C.

References List::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
	)

Definition at line 252 of file faceZone.C.

faceZone() [5/8]

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

Definition at line 273 of file faceZone.C.

faceZone() [6/8]

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

Definition at line 294 of file faceZone.C.

faceZone() [7/8]

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

Definition at line 314 of file faceZone.C.

faceZone() [8/8]

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

Definition at line 335 of file faceZone.C.

~faceZone()

~faceZone ( )

virtual

Definition at line 357 of file faceZone.C.

Member Function Documentation

TypeName()

TypeName

(

"faceZone"

)

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

Definition at line 223 of file faceZone.H.

References faceZone::flipMap(), zoneIdentifier::index(), and autoPtr::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

Definition at line 231 of file faceZone.H.

References zoneIdentifier::index(), and autoPtr::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

Definition at line 28 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

Definition at line 262 of file faceZone.H.

flipMap()

const boolList& flipMap ( ) const

inlinenoexcept

Definition at line 268 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

Definition at line 365 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

Definition at line 371 of file faceZone.C.

masterCells()

const Foam::labelList & masterCells

(

)

const

Definition at line 382 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

Definition at line 393 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

Definition at line 404 of file faceZone.C.

References mesh.

clearAddressing()

void clearAddressing ( )

virtual

Reimplemented from zone.

Definition at line 423 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

Definition at line 437 of file faceZone.C.

References List::operator=().

Here is the call graph for this function:

resetAddressing() [2/3]

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

virtual

Definition at line 449 of file faceZone.C.

References List::operator=().

Here is the call graph for this function:

resetAddressing() [3/3]

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

virtual

Definition at line 461 of file faceZone.C.

References List::transfer().

Here is the call graph for this function:

checkDefinition()

bool checkDefinition ( const bool  report = false ) const

virtual

Implements zone.

Definition at line 503 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

Definition at line 509 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

Reimplemented from zone.

Definition at line 601 of file faceZone.C.

updateMesh()

void updateMesh ( const mapPolyMesh &  mpm )

virtual

Definition at line 472 of file faceZone.C.

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

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from zone.

Definition at line 609 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

Implements zone.

Definition at line 617 of file faceZone.C.

References Ostream::beginBlock(), Ostream::endBlock(), Foam::name(), os(), Foam::type(), zoneIdentifier::write(), UList::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

Member Data Documentation

labelsName

const char *const labelsName = "faceLabels"

static

Definition at line 114 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