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

#include <faceZone.H>

Inheritance diagram for faceZone:

Collaboration diagram for faceZone:

Public Member Functions
	TypeName ("faceZone")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, faceZone, dictionary,(const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm),(name, dict, index, zm))
	faceZone (const faceZone &)=delete
	No copy construct.
	faceZone (const faceZoneMesh &zm)
	Construct an empty zone - name="", index=0.
	faceZone (const word &name, const label index, const faceZoneMesh &zm)
	Construct an empty zone with specified name and index.
	faceZone (const word &name, const labelUList &addr, const bool flipMapValue, const label index, const faceZoneMesh &zm)
	Construct from components with uniform flip map value.
	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.
	faceZone (const word &name, const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm)
	Construct from components, copying addressing.
	faceZone (const word &name, labelList &&addr, boolList &&fm, const label index, const faceZoneMesh &zm)
	Construct from components, transferring addressing.
	faceZone (const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)
	Construct from dictionary.
	faceZone (const faceZone &originalZone, const faceZoneMesh &zm, const label newIndex=-1)
	Copy construct with new mesh reference.
	faceZone (const faceZone &originalZone, Foam::zero, const faceZoneMesh &zm, const label newIndex=-1)
	Construct empty with original zone information (name, index, groups) and mesh reference.
	faceZone (const faceZone &originalZone, Foam::zero, const label index, const faceZoneMesh &zm)
	Construct empty with original zone information (name, groups), resetting the index and zone mesh reference.
	faceZone (const faceZone &originalZone, 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.
	faceZone (const faceZone &originalZone, 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.
virtual autoPtr< faceZone >	clone (const faceZoneMesh &zm, const label newIndex=-1) const
	Construct and return a clone, resetting the zone mesh.
virtual autoPtr< faceZone >	clone (const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm) const
	Construct and return a clone, resetting the face list and zone mesh.
virtual	~faceZone ()=default
	Destructor.
label	max_index () const noexcept
	The maximum index the zone may contain == mesh nFaces().
const faceZoneMesh &	zoneMesh () const noexcept
	Return reference to the zone mesh.
const boolList &	flipMap () const noexcept
	Return face flip map.
label	whichFace (const label meshFaceID) const
	The local index of the given mesh face, -1 if not in the zone.
const primitiveFacePatch &	patch () const
	Return [demand-driven] reference to an equivalent primitive patch, with faces oriented according to flipMap().
virtual bool	checkDefinition (const bool report=false) const
	Check zone definition.
virtual bool	checkParallelSync (const bool report=false) const
	Check whether all procs have faces synchronised.
const labelList &	frontCells () const
	The front cells layer. Cells on the positive normal side of faces.
const labelList &	backCells () const
	The back cells layer. Cells on the negative normal side of faces.
const labelList &	meshEdges () const
	Return global edge index for local edges.
virtual void	clearAddressing ()
	Clear addressing (remove lookup maps, patch/geometric information).
virtual void	clearPrimitives ()
	Clear primitive addressing.
virtual void	resetAddressing (faceZone &&zn)
	Move reset addressing and flip map from another zone.
virtual void	resetAddressing (const faceZone &zn)
	Copy reset addressing and flip map from another zone.
virtual void	resetAddressing (const labelUList &addr, const bool flipMapValue)
	Reset addressing - use uniform flip map value.
virtual void	resetAddressing (labelList &&addr, const bool flipMapValue)
	Move reset addressing - use uniform flip map value.
virtual void	resetAddressing (const labelUList &addr, const boolUList &flipMap)
	Copy reset addressing and flip map.
void	operator= (const faceZone &zn)
	Assign addressing, clearing demand-driven data.
virtual void	movePoints (const pointField &pts)
	Correct patch after moving points.
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes in topology.
virtual void	write (Ostream &os) const
	Write (dictionary entries).
const primitiveFacePatch &	operator() () const
	Deprecated(2023-09) same as patch().
const labelList &	masterCells () const
	Deprecated(2023-09) same as frontCells.
const labelList &	slaveCells () const
	Deprecated(2023-09) same as backCells.
void	writeDict (Ostream &os) const
	Deprecated(2025-09) Write dictionary.
const labelList &	addressing () const noexcept
	The addressing (face IDs) used for the zone.
Public Member Functions inherited from zone
	TypeNameNoDebug ("zone")
	Runtime type information.
	zone ()
	Default construct: empty zone with name="", index=0.
	zone (const word &name, const label index)
	Construct an empty zone with specified name and index.
	zone (const word &name, const labelUList &addr, const label index)
	Copy construct from components.
	zone (const word &name, labelList &&addr, const label index)
	Move construct from components.
	zone (const word &name, const dictionary &dict, const word &labelsName, const label index)
	Construct from dictionary.
	zone (const zone &originalZone, const label index)
	Copy construct with new index.
	zone (const zone &originalZone, const labelUList &addr, const label index)
	Construct given the name of the original zone (name is used) with new addressing and index.
	zone (const zone &originalZone, labelList &&addr, const label index)
	Construct given the name of the original zone (name is used) and (move) resetting addressing and index.
virtual	~zone ()=default
	Destructor.
const Map< label > &	lookupMap () const
	Demand-driven: the look-up map from global to local id.
label	localID (const label globalID) const
	Lookup local address in zone for given global index.
const labelList &	addressing () const noexcept
	The addressing used by the zone.
virtual bool	checkDefinition (const label maxSize, const bool report=false) const
	Check zone definition with max size given. Return true if in error.
Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct.
	zoneIdentifier (zoneIdentifier &&)=default
	Move construct.
zoneIdentifier &	operator= (const zoneIdentifier &)=default
	Copy assignment.
zoneIdentifier &	operator= (zoneIdentifier &&)=default
	Move assignment.
virtual	~zoneIdentifier ()=default
	Destructor.
	zoneIdentifier ()
	Default construct: name="", index=0.
	zoneIdentifier (const word &name, const label index)
	Construct from mandatory components.
	zoneIdentifier (const word &name, const label index, const word &physicalType, const wordList &inGroups=wordList())
	Construct from components.
	zoneIdentifier (const word &name, const dictionary &dict, const label index)
	Construct from dictionary.
	zoneIdentifier (const zoneIdentifier &ident, const label newIndex)
	Copy construct, resetting the index (if non-negative).
	zoneIdentifier (zoneIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative).
const word &	name () const noexcept
	The zone name.
word &	name () noexcept
	Modifiable zone name.
label	index () const noexcept
	The index of this zone in the zone list.
label &	index () noexcept
	Modifiable index of this zone in the zone list.
const word &	physicalType () const noexcept
	The (optional) type of the zone.
word &	physicalType () noexcept
	Modifiable (optional) type of the zone.
const wordList &	inGroups () const noexcept
	The (optional) groups that the zone belongs to.
wordList &	inGroups () noexcept
	Modifiable (optional) groups that the zone belongs to.
bool	inGroup (const word &name) const
	True if given name is in a group.
void	addGroup (const word &name)
	Add (unique) group for the zone.
void	removeGroup (const word &name)
	Remove group for the zone.
void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces).
Public Member Functions inherited from List< label >
constexpr	List () noexcept
	Default construct.
	List (const label len)
	Construct with given size.
	List (const label len, const label &val)
	Construct with given size and value for all elements.
	List (const label len, Foam::zero)
	Construct with given size initializing all elements to zero.
	List (Foam::one, const label &val)
	Construct with length=1, copying the value as the only content.
	List (Foam::one, label &&val)
	Construct with length=1, moving the value as the only content.
	List (Foam::one, Foam::zero)
	Construct with length=1, initializing content to zero.
	List (const List< label > &list)
	Copy construct from list.
	List (const UList< label > &list)
	Copy construct contents from list.
	List (List< label > &list, bool reuse)
	Construct as copy or re-use as specified.
	List (const UList< label > &list, const labelUList &indices)
	Copy construct subset of list.
	List (const UList< label > &list, const FixedList< label, N > &indices)
	Copy construct subset of list.
	List (const FixedList< label, N > &list)
	Construct as copy of FixedList<T, N>.
	List (const UPtrList< label > &list)
	Construct as copy of UPtrList<T> content.
	List (const IndirectListBase< label, Addr > &list)
	Construct as copy of IndirectList contents.
	List (std::initializer_list< label > list)
	Construct from an initializer list.
	List (List< label > &&list) noexcept
	Move construct from List.
	List (DynamicList< label, SizeMin > &&list)
	Move construct from DynamicList.
	List (Istream &is)
	Construct from Istream.
autoPtr< List< label > >	clone () const
	Clone.
	~List ()
	Destructor.
void	clear ()
	Clear the list, i.e. set size to zero.
void	resize (const label len)
	Adjust allocated size of list.
void	resize (const label len, const label &val)
	Adjust allocated size of list and set val for new elements.
void	resize_copy (label count, const label len)
	Change allocated size of list, retaining the first count elements.
void	resize_fill (const label len, const label &val)
	Adjust allocated size of list and set val for all elements.
void	resize_nocopy (const label len)
	Adjust allocated size of list without necessarily.
void	transfer (List< label > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
void	transfer (DynamicList< label, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list.
label &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required.
label &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element.
void	push_back (const label &val)
	Append an element at the end of the list.
void	push_back (label &&val)
	Move append an element at the end of the list.
void	push_back (const UList< label > &list)
	Append a List to the end of this list.
void	push_back (const IndirectListBase< label, Addr > &list)
	Append IndirectList contents at the end of this list.
label	push_uniq (const label &val)
	Append an element if not already in the list.
void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list.
void	operator= (const UList< label > &list)
	Assignment to UList operator. Takes linear time.
void	operator= (const List< label > &list)
	Assignment operator. Takes linear time.
void	operator= (const IndirectListBase< label, Addr > &list)
	Assignment from IndirectList. Takes linear time.
void	operator= (const FixedList< label, N > &list)
	Copy assignment from FixedList.
void	operator= (std::initializer_list< label > list)
	Assignment to an initializer list.
void	operator= (const label &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
void	operator= (List< label > &&list)
	Move assignment. Takes constant time.
void	operator= (DynamicList< label, SizeMin > &&list)
	Move assignment. Takes constant time.
Istream &	readList (Istream &is)
	Read List from Istream, discarding contents of existing List.
void	shallowCopy (const UList< label > &)=delete
	No shallowCopy permitted.
bool	set (const label i, bool val=true)
	A bitSet::set() method for a list of bool.
void	append (const label &val)
	Append an element at the end of the list.
void	append (label &&val)
	Move append an element at the end of the list.
void	append (const UList< label > &list)
	Append a List to the end of this list.
void	append (const IndirectListBase< label, Addr > &list)
	Append IndirectList contents at the end of this list.
label	appendUniq (const label &val)
	Same as push_uniq().
void	setSize (label n)
	Alias for resize().
void	setSize (label n, const label &val)
	Alias for resize().
	List (const Expression::ListExpression< E > &expr)
	Construct from value expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
void	resize (const label len)
Public Member Functions inherited from UList< label >
	UList (const UList< label > &) noexcept=default
	Copy construct, shallow copy.
	UList (UList< label > &&) noexcept=default
	Move construct, shallow copy.
UList< label > &	operator= (const UList< label > &)=delete
	No copy assignment (default: shallow copy).
UList< label > &	operator= (UList< label > &&) noexcept=default
	Move assignment, shallow copy.
constexpr	UList () noexcept
	Default construct, zero-sized and nullptr.
	UList (label *__restrict__ ptr, const label len) noexcept
	Construct from components.
	UList (SubList< label > &&) noexcept
	Move construct from a SubList, shallow copy.
label	fcIndex (const label i) const noexcept
	The forward circular index. The next index in the list which returns to the first at the end of the list.
label	rcIndex (const label i) const noexcept
	The reverse circular index. The previous index in the list which returns to the last at the beginning of the list.
const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list).
label &	fcValue (const label i)
	Return forward circular value (ie, next value in the list).
const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list).
label &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list).
const label *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage.
label *	data () noexcept
	Return pointer to the underlying array serving as data storage.
const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,.
char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,.
label &	front ()
	Access first element of the list, position [0].
const label &	front () const
	Access first element of the list.
label &	back ()
	Access last element of the list, position [size()-1].
const label &	back () const
	Access last element of the list, position [size()-1].
std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data.
std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous.
void	checkStart (const label start) const
	Check start is within valid range [0,size).
void	checkSize (const label size) const
	Check size is within valid range [0,size].
void	checkRange (const label start, const label len) const
	Check that start and length define a valid range.
void	checkIndex (const label i) const
	Check index is within valid range [0,size).
bool	uniform () const
	True if all entries have identical values, and list is non-empty.
bool	contains (const label &val) const
	True if the value is contained in the list.
bool	contains (const label &val, label pos, label len=-1) const
	Is the value contained in the list?
label	find (const label &val) const
	Find index of the first occurrence of the value.
label	find (const label &val, label pos, label len=-1) const
	Find index of the first occurrence of the value.
label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value.
void	moveFirst (const label i)
	Move element to the first position.
void	moveLast (const label i)
	Move element to the last position.
void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list.
void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list.
void	shallowCopy (label *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size.
void	shallowCopy (std::nullptr_t) noexcept
	Copy nullptr and zero size.
void	shallowCopy (const UList< label > &list) noexcept
	Copy the pointer and size held by the given UList.
void	deepCopy (const UList< label > &list)
	Copy elements of the given UList. Sizes must match!
void	deepCopy (const IndirectListBase< label, Addr > &list)
	Copy elements of the given indirect list. Sizes must match!
SubList< label >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking.
const SubList< label >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking.
SubList< label >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking.
const SubList< label >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking.
label &	operator[] (const label i)
	Return element of UList.
const label &	operator[] (const label i) const
	Return element of constant UList.
	operator const Foam::List< label > & () const
	Allow cast to a const List<T>&.
void	operator= (const label &val)
	Assignment of all entries to the given value.
void	operator= (Foam::zero)
	Assignment of all entries to zero.
iterator	begin () noexcept
	Return an iterator to begin traversing the UList.
iterator	end () noexcept
	Return an iterator to end traversing the UList.
iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range.
const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList.
const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList.
const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range.
reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList.
reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList.
const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList.
const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList.
bool	empty () const noexcept
	True if List is empty (ie, size() is zero).
label	size () const noexcept
	The number of elements in the container.
label	capacity () const noexcept
	Size of the underlying storage.
void	swap (UList< label > &list) noexcept
	Swap content with another UList of the same type in constant time.
bool	operator== (const UList< label > &list) const
	Equality operation on ULists of the same type.
bool	operator!= (const UList< label > &list) const
	The opposite of the equality operation. Takes linear time.
bool	operator< (const UList< label > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator> (const UList< label > &list) const
	Compare two ULists lexicographically. Takes linear time.
bool	operator<= (const UList< label > &list) const
	Return true if !(a > b). Takes linear time.
bool	operator>= (const UList< label > &list) const
	Return true if !(a < b). Takes linear time.
Istream &	readList (Istream &is)
	Read List contents from Istream.
void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword.
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen.
bool	all () const
	True if all entries are 'true' or if the list is empty.
bool	any () const
	True if any entries are 'true'.
bool	none () const
	True if no entries are 'true'.
bool	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access.
bool	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access.
bool	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access.
std::string_view	view () const
	Return a string_view of the charList. Content is non-modifiable.
label &	first ()
	Access first element of the list, position [0].
const label &	first () const
	Access first element of the list.
label &	last ()
	Access last element of the list, position [size()-1].
const label &	last () const
	Access last element of the list, position [size()-1].
bool	found (const label &val, label pos=0) const
	Same as contains().
auto	expr () const
	Wrap value as expression.
void	operator= (const Expression::ListExpression< E > &expr)
	Assign values from expression.
	operator const Foam::List< label > & () const
	Allow cast to a const List<T>&.

Static Public Member Functions
static constexpr const char *	labelsName ()
	The name associated with the zone-labels dictionary entry.
static autoPtr< faceZone >	New (const word &name, const dictionary &dict, const label index, const faceZoneMesh &zm)
	Return a pointer to a new face zone created on freestore from dictionary.
Static Public Member Functions inherited from List< label >
static const List< label > &	null () noexcept
	Return a null List (reference to a nullObject). Behaves like an empty List.
Static Public Member Functions inherited from UList< label >
static const UList< label > &	null () noexcept
	Return a null UList (reference to a nullObject). Behaves like an empty UList.
static constexpr label	max_size () noexcept
	The size of the largest possible UList.

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

Additional Inherited Members
Public Types inherited from List< label >
typedef SubList< label >	subList
	Declare type of subList.
Public Types inherited from UList< label >
typedef label	value_type
	The value type the list contains.
typedef label *	pointer
	The pointer type for non-const access to value_type items.
typedef const label *	const_pointer
	The pointer type for const access to value_type items.
typedef label &	reference
	The type used for storing into value_type objects.
typedef const label &	const_reference
	The type used for reading from constant value_type objects.
typedef label *	iterator
	Random access iterator for traversing a UList.
typedef const label *	const_iterator
	Random access iterator for traversing a UList.
typedef label	size_type
	The type to represent the size of a UList.
typedef label	difference_type
	The difference between iterator objects.
typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access).
typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access).
using	is_List
	Have unique tag.
Protected Member Functions inherited from UList< label >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage.
void	size (const label n)
	Older name for setAddressableSize.
void	writeEntry (Ostream &os) const
	Write the UList with its compound type.
labelRange	validateRange (const labelRange &requestedRange) const
	Return a validated (start,size) subset range, which means that it always addresses a valid section of the list.
void	fill_uniform (const label &val)
	Assign all entries to the given value.
void	fill_uniform (Foam::zero)
	Assign all entries to zero.

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 60 of file faceZone.H.

Constructor & Destructor Documentation

◆ faceZone() [1/13]

faceZone ( const faceZone & )

delete

No copy construct.

References dict, faceZone(), zoneIdentifier::index(), and Foam::name().

Referenced by declareRunTimeSelectionTable(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), faceZone(), operator<<, operator=(), resetAddressing(), and resetAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ faceZone() [2/13]

faceZone ( const faceZoneMesh & zm )

explicit

Construct an empty zone - name="", index=0.

Definition at line 211 of file faceZone.C.

References zone::zone().

Here is the call graph for this function:

◆ faceZone() [3/13]

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

Construct an empty zone with specified name and index.

Definition at line 218 of file faceZone.C.

References zoneIdentifier::index(), Foam::name(), and zone::zone().

Here is the call graph for this function:

◆ faceZone() [4/13]

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 230 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), Foam::name(), List< label >::operator=(), and UList< label >::size().

Here is the call graph for this function:

◆ faceZone() [5/13]

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 248 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), Foam::name(), UList< label >::size(), and List< label >::transfer().

Here is the call graph for this function:

◆ faceZone() [6/13]

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

Construct from components, copying addressing.

Definition at line 265 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), Foam::name(), and List< label >::operator=().

Here is the call graph for this function:

◆ faceZone() [7/13]

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

Construct from components, transferring addressing.

Definition at line 290 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), Foam::name(), and List< label >::transfer().

Here is the call graph for this function:

◆ faceZone() [8/13]

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

Construct from dictionary.

Definition at line 315 of file faceZone.C.

References dict, faceZone(), zoneIdentifier::index(), labelsName(), keyType::LITERAL, Foam::name(), and zone::zone().

Here is the call graph for this function:

◆ faceZone() [9/13]

faceZone	(	const faceZone &	originalZone,
		const faceZoneMesh &	zm,
		const label	newIndex = -1 )

Copy construct with new mesh reference.

Parameters

newIndex The new index (optional. -1 retains the original value)

Definition at line 331 of file faceZone.C.

References faceZone(), flipMap(), and zone::zone().

Here is the call graph for this function:

◆ faceZone() [10/13]

faceZone	(	const faceZone &	originalZone,
		Foam::zero	,
		const faceZoneMesh &	zm,
		const label	newIndex = -1 )

Construct empty with original zone information (name, index, groups) and mesh reference.

Parameters

newIndex The new index (optional. -1 retains the original value)

Definition at line 345 of file faceZone.C.

References faceZone(), and zone::zone().

Here is the call graph for this function:

◆ faceZone() [11/13]

faceZone	(	const faceZone &	originalZone,
		Foam::zero	,
		const label	index,
		const faceZoneMesh &	zm )

Construct empty with original zone information (name, groups), resetting the index and zone mesh reference.

Parameters

index The new index (-1 retains the original value)

Definition at line 358 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), and zone::zone().

Here is the call graph for this function:

◆ faceZone() [12/13]

faceZone	(	const faceZone &	originalZone,
		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.

Parameters

index The new index (-1 retains the original value)

Definition at line 371 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), and List< label >::operator=().

Here is the call graph for this function:

◆ faceZone() [13/13]

faceZone	(	const faceZone &	originalZone,
		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.

Parameters

index The new index (-1 retains the original value)

Definition at line 389 of file faceZone.C.

References faceZone(), zoneIdentifier::index(), and List< label >::transfer().

Here is the call graph for this function:

◆ ~faceZone()

virtual ~faceZone ( )

virtualdefault

Destructor.

References Foam::noexcept.

Member Function Documentation

◆ labelsName()

constexpr const char * labelsName ( )

inlinestaticconstexpr

The name associated with the zone-labels dictionary entry.

Definition at line 143 of file faceZone.H.

Referenced by faceZone(), and write().

Here is the caller graph for this function:

◆ 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)	)

References dict, faceZone(), zoneIdentifier::index(), and Foam::name().

Here is the call graph for this function:

◆ clone() [1/2]

virtual autoPtr< faceZone > clone	(	const faceZoneMesh &	zm,
		const label	newIndex = -1 ) const

inlinevirtual

Construct and return a clone, resetting the zone mesh.

Parameters

newIndex The new index (optional. -1 retains the original value)

Definition at line 321 of file faceZone.H.

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

Parameters

index The new index (-1 retains the original value)

Definition at line 335 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 27 of file faceZoneNew.C.

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

Here is the call graph for this function:

◆ max_index()

Foam::label max_index ( ) const

noexcept

The maximum index the zone may contain == mesh nFaces().

Definition at line 409 of file faceZone.C.

References Foam::noexcept.

Referenced by checkDefinition().

Here is the caller graph for this function:

◆ zoneMesh()

const faceZoneMesh & zoneMesh ( ) const

inlinenoexcept

Return reference to the zone mesh.

Definition at line 379 of file faceZone.H.

References Foam::noexcept, and zoneMesh().

Referenced by checkParallelSync(), meshEdges(), and zoneMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flipMap()

const boolList & flipMap ( ) const

inlinenoexcept

Return face flip map.

Definition at line 389 of file faceZone.H.

References Foam::noexcept.

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

Here is the caller graph for this function:

◆ whichFace()

label whichFace ( const label meshFaceID ) const

inline

The local index of the given mesh face, -1 if not in the zone.

Definition at line 394 of file faceZone.H.

References zone::localID().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patch()

const Foam::primitiveFacePatch & patch ( ) const

Return [demand-driven] reference to an equivalent primitive patch, with faces oriented according to flipMap().

Definition at line 426 of file faceZone.C.

Referenced by meshEdges(), and operator()().

Here is the caller graph for this function:

◆ checkDefinition()

virtual bool checkDefinition ( const bool report = false ) const

inlinevirtual

Check zone definition.

Returns: True if any errors.

Implements zone.

Definition at line 413 of file faceZone.H.

References zone::checkDefinition(), and max_index().

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 595 of file faceZone.C.

References coupled, Foam::endl(), flipMap(), forAll, zoneIdentifier::index(), mesh, IOobject::name(), name, Foam::Pout, Foam::returnReduceOr(), syncTools::swapBoundaryFaceList(), polyBoundaryMesh::whichPatch(), and zoneMesh().

Here is the call graph for this function:

◆ frontCells()

const Foam::labelList & frontCells ( ) const

The front cells layer. Cells on the positive normal side of faces.

Warning: may contain negative indices for boundary faces!

Definition at line 436 of file faceZone.C.

Referenced by masterCells().

Here is the caller graph for this function:

◆ backCells()

const Foam::labelList & backCells ( ) const

The back cells layer. Cells on the negative normal side of faces.

Warning: may contain negative indices for boundary faces!

Definition at line 446 of file faceZone.C.

Referenced by slaveCells().

Here is the caller graph for this function:

◆ meshEdges()

const Foam::labelList & meshEdges ( ) const

Return global edge index for local edges.

Definition at line 456 of file faceZone.C.

References mesh, meshEdges(), patch(), and zoneMesh().

Referenced by meshEdges().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing (remove lookup maps, patch/geometric information).

Reimplemented from zone.

Definition at line 486 of file faceZone.C.

References zone::clearAddressing().

Referenced by operator=(), resetAddressing(), resetAddressing(), resetAddressing(), resetAddressing(), resetAddressing(), and updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearPrimitives()

void clearPrimitives ( )

virtual

Clear primitive addressing.

Reimplemented from zone.

Definition at line 493 of file faceZone.C.

References zone::clearPrimitives().

Here is the call graph for this function:

◆ resetAddressing() [1/5]

void resetAddressing ( faceZone && zn )

virtual

Move reset addressing and flip map from another zone.

Definition at line 500 of file faceZone.C.

References clearAddressing(), faceZone(), and List< label >::transfer().

Here is the call graph for this function:

◆ resetAddressing() [2/5]

void resetAddressing ( const faceZone & zn )

virtual

Copy reset addressing and flip map from another zone.

Definition at line 514 of file faceZone.C.

References clearAddressing(), faceZone(), and List< label >::operator=().

Here is the call graph for this function:

◆ resetAddressing() [3/5]

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

virtual

Reset addressing - use uniform flip map value.

Clears demand-driven data.

Definition at line 527 of file faceZone.C.

References clearAddressing(), and List< label >::operator=().

Here is the call graph for this function:

◆ resetAddressing() [4/5]

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

virtual

Move reset addressing - use uniform flip map value.

Clears demand-driven data.

Definition at line 539 of file faceZone.C.

References clearAddressing(), and List< label >::transfer().

Here is the call graph for this function:

◆ resetAddressing() [5/5]

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

virtual

Copy reset addressing and flip map.

Clears demand-driven data.

Definition at line 551 of file faceZone.C.

References clearAddressing(), flipMap(), and List< label >::operator=().

Here is the call graph for this function:

◆ operator=()

void operator= ( const faceZone & zn )

Assign addressing, clearing demand-driven data.

Definition at line 705 of file faceZone.C.

References clearAddressing(), faceZone(), and List< label >::operator=().

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 686 of file faceZone.C.

References pts.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes in topology.

Definition at line 563 of file faceZone.C.

References clearAddressing(), Foam::faceMap(), flipMap(), forAll, List< T >::resize(), mapPolyMesh::reverseFaceMap(), UList< label >::size(), and List< label >::transfer().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write (dictionary entries).

Reimplemented from zone.

Definition at line 695 of file faceZone.C.

References labelsName(), os(), zone::write(), and UList< label >::writeEntry().

Referenced by Foam::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator()()

const primitiveFacePatch & operator() ( ) const

inline

Deprecated(2023-09) same as patch().

Deprecated: (2023-09) same as patch()

Definition at line 545 of file faceZone.H.

References patch().

Here is the call graph for this function:

◆ masterCells()

const labelList & masterCells ( ) const

inline

Deprecated(2023-09) same as frontCells.

Deprecated: (2023-09) same as frontCells #1832

Definition at line 552 of file faceZone.H.

References frontCells().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ slaveCells()

const labelList & slaveCells ( ) const

inline

Deprecated(2023-09) same as backCells.

Deprecated: (2023-09) same as backCells #1832

Definition at line 559 of file faceZone.H.

References backCells().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDict()

void writeDict ( Ostream & os ) const

inline

Deprecated(2025-09) Write dictionary.

Deprecated: (2025-09) Write dictionary

Definition at line 567 of file faceZone.H.

References zoneIdentifier::name(), os(), write(), and writeDict().

Referenced by writeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addressing()

const labelList & addressing ( ) const

inlinenoexcept

The addressing (face IDs) used for the zone.

Definition at line 182 of file zone.H.

◆ operator<<

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

friend

Ostream Operator.

References faceZone(), and os().

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

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ faceZone() [1/13]

◆ faceZone() [2/13]

◆ faceZone() [3/13]

◆ faceZone() [4/13]

◆ faceZone() [5/13]

◆ faceZone() [6/13]

◆ faceZone() [7/13]

◆ faceZone() [8/13]

◆ faceZone() [9/13]

◆ faceZone() [10/13]

◆ faceZone() [11/13]

◆ faceZone() [12/13]

◆ faceZone() [13/13]

◆ ~faceZone()

Member Function Documentation

◆ labelsName()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ max_index()

◆ zoneMesh()

◆ flipMap()

◆ whichFace()

◆ patch()

◆ checkDefinition()

◆ checkParallelSync()

◆ frontCells()

◆ backCells()

◆ meshEdges()

◆ clearAddressing()

◆ clearPrimitives()

◆ resetAddressing() [1/5]

◆ resetAddressing() [2/5]

◆ resetAddressing() [3/5]

◆ resetAddressing() [4/5]

◆ resetAddressing() [5/5]

◆ operator=()

◆ movePoints()

◆ updateMesh()

◆ write()

◆ operator()()

◆ masterCells()

◆ slaveCells()

◆ writeDict()

◆ addressing()

Friends And Related Symbol Documentation

◆ operator<<