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 faceZone &)=delete
	No copy construct. More...

	faceZone (const faceZoneMesh &zm)
	Construct an empty zone - name="", index=0. More...

	faceZone (const word &name, const label index, const faceZoneMesh &zm)
	Construct an empty zone with specified name and index. 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)
	Construct from components with uniform flip map value, transferring addressing. More...

	faceZone (const word &name, const labelUList &addr, const boolUList &fm, const label index, const faceZoneMesh &zm)
	Construct from components, copying addressing. 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 &originalZone, const Foam::zero, const faceZoneMesh &zm, const label newIndex=-1)
	Construct empty with original zone information (name, index, groups) and mesh reference. Optionally specify a new index. More...

	faceZone (const faceZone &originalZone, const Foam::zero, const label index, const faceZoneMesh &zm)
	Construct empty with original zone information (name, groups), resetting the index and zone mesh reference. More...

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

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

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
	Construct and return a clone, resetting the face list and zone mesh. More...

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

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

const labelList &	addressing () const noexcept
	The addressing (face IDs) used for the zone. 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 &	patch () const
	Return [demand-driven] reference to an equivalent primitive patch, with faces oriented according to flipMap() More...

const labelList &	frontCells () const
	The front cells layer. Cells on the positive normal side of faces. More...

const labelList &	backCells () const
	The back cells layer. Cells on the negative normal side of faces. More...

const labelList &	meshEdges () const
	Return global edge index for local edges. 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...

virtual void	clearAddressing ()
	Clear addressing (remove lookup maps, patch/geometric information) More...

virtual void	clearPrimitives ()
	Clear primitive addressing. More...

virtual void	resetAddressing (faceZone &&zn)
	Move reset addressing and flip map from another zone. More...

virtual void	resetAddressing (const faceZone &zn)
	Copy reset addressing and flip map from another zone. More...

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

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

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

void	operator= (const faceZone &zn)
	Assign addressing, clearing demand-driven data. More...

const primitiveFacePatch &	operator() () const
	Deprecated(2023-09) same as patch() More...

const labelList &	masterCells () const
	Deprecated(2023-09) same as frontCells. More...

const labelList &	slaveCells () const
	Deprecated(2023-09) same as backCells. More...

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

	zone ()
	Default construct. More...

	zone (const word &name, const label index)
	Construct an empty zone with specified name and index. 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 &originalZone, const labelUList &addr, const label index)
	Construct given the name of the original zone (name is used) with new addressing and index (-ve: retain zone index). More...

	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 (-ve: retain zone index). More...

virtual	~zone ()=default
	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 (zoneIdentifier &&)=default
	Move construct. More...

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

zoneIdentifier &	operator= (zoneIdentifier &&)=default
	Move assignment. More...

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

	zoneIdentifier ()
	Default construct: 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 newIndex)
	Copy construct, resetting the index (if non-negative) More...

	zoneIdentifier (zoneIdentifier &&ident, const label newIndex)
	Move construct, resetting the index (if non-negative) 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	addGroup (const word &name)
	Add (unique) group for the zone. More...

void	removeGroup (const word &name)
	Remove group for the zone. More...

void	write (Ostream &os) const
	Write (physicalType, inGroups) dictionary entries (without surrounding braces) More...

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 > &list)
	Copy construct from list. More...

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

	List (List< label > &list, 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 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) noexcept
	Move construct from List. More...

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

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

	List (const SLList< label > &list)
	Copy construct from SLList. 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_fill (const label len, const label &val)
	Adjust allocated size of list and set val for all elements. More...

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

void	resize_unsafe (const label len) noexcept
	Change the addressed list size directly without affecting any memory management (advanced usage). More...

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

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

void	transfer (List< label > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

void	transfer (DynamicList< label, SizeMin > &list)
	Transfer the contents of the argument List into this list and annul the argument list. More...

label &	newElmt (const label i)
	Return subscript-checked element of UList and resizing the list if required. More...

label &	emplace_back (Args &&... args)
	Construct an element at the end of the list, return reference to the new list element. More...

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

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

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

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

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

void	pop_back (label n=1)
	Reduce size by 1 or more elements. Can be called on an empty list. More...

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

void	operator= (const List< label > &list)
	Assignment 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= (const SLList< label > &list)
	Copy assign from SLList in linear time. More...

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

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

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)
	Same as push_uniq() More...

Public Member Functions inherited from UList< label >
label	size () const noexcept
	The number of elements in the container. More...

void	writeEntry (const word &keyword, Ostream &os) const
	Write the List as a dictionary entry with keyword. 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...

	UList (const UList< label > &)=default
	Copy construct. More...

constexpr	UList () noexcept
	Default construct, zero-sized and nullptr. More...

	UList (label *__restrict__ v, const label len) noexcept
	Construct from components. More...

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

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

const label &	fcValue (const label i) const
	Return forward circular value (ie, next value in the list) More...

label &	fcValue (const label i)
	Return forward circular value (ie, next value in the list) More...

const label &	rcValue (const label i) const
	Return reverse circular value (ie, previous value in the list) More...

label &	rcValue (const label i)
	Return reverse circular value (ie, previous value in the list) More...

const label *	cdata () const noexcept
	Return pointer to the underlying array serving as data storage. More...

label *	data () noexcept
	Return pointer to the underlying array serving as data storage. More...

const char *	cdata_bytes () const noexcept
	Return pointer to the underlying array serving as data storage,. More...

char *	data_bytes () noexcept
	Return pointer to the underlying array serving as data storage,. More...

label &	front ()
	Access first element of the list, position [0]. More...

const label &	front () const
	Access first element of the list. More...

label &	back ()
	Access last element of the list, position [size()-1]. More...

const label &	back () const
	Access last element of the list, position [size()-1]. More...

std::streamsize	size_bytes () const noexcept
	Number of contiguous bytes for the List data. More...

std::streamsize	byteSize () const
	Number of contiguous bytes for the List data, runtime FatalError if type is not contiguous. More...

void	checkStart (const label start) const
	Check start is within valid range [0,size) More...

void	checkSize (const label size) const
	Check size is within valid range [0,size]. More...

void	checkRange (const label start, const label len) const
	Check that start and length define a valid range. More...

void	checkIndex (const label i) const
	Check index is within valid range [0,size) More...

bool	uniform () const
	True if all entries have identical values, and list is non-empty. More...

bool	contains (const label &val) const
	True if the value is contained in the list. More...

bool	contains (const label &val, label pos, label len=-1) const
	Is the value contained in the list? More...

label	find (const label &val) const
	Find index of the first occurrence of the value. More...

label	find (const label &val, label pos, label len=-1) const
	Find index of the first occurrence of the value. More...

label	rfind (const label &val, label pos=-1) const
	Find index of the last occurrence of the value. More...

void	moveFirst (const label i)
	Move element to the first position. More...

void	moveLast (const label i)
	Move element to the last position. More...

void	swapFirst (const label i)
	Swap element with the first element. Fatal on an empty list. More...

void	swapLast (const label i)
	Swap element with the last element. Fatal on an empty list. More...

void	shallowCopy (label *__restrict__ ptr, const label len) noexcept
	Copy the pointer and size. More...

void	shallowCopy (const UList< label > &list) noexcept
	Copy the pointer and size held by the given UList. More...

void	deepCopy (const UList< label > &list)
	Copy elements of the given UList. Sizes must match! More...

void	deepCopy (const IndirectListBase< label, Addr > &list)
	Copy elements of the given indirect list. Sizes must match! More...

SubList< label >	slice (const label pos, label len=-1)
	Return SubList slice (non-const access) - no range checking. More...

const SubList< label >	slice (const label pos, label len=-1) const
	Return SubList slice (const access) - no range checking. More...

SubList< label >	slice (const labelRange &range)
	Return SubList slice (non-const access) - with range checking. More...

const SubList< label >	slice (const labelRange &range) const
	Return SubList slice (const access) - with range checking. More...

label &	operator[] (const label i)
	Return element of UList. More...

const label &	operator[] (const label i) const
	Return element of constant UList. More...

const bool &	operator[] (const label i) const

UPstream::commsStruct &	operator[] (const label procID)

const UPstream::commsStruct &	operator[] (const label procID) const

Foam::UPstream::commsStruct &	operator[] (const label procID)

const Foam::UPstream::commsStruct &	operator[] (const label procID) const

	operator const Foam::List< label > & () const
	Allow cast to a const List<T>&. More...

iterator	begin () noexcept
	Return an iterator to begin traversing the UList. More...

iterator	begin (const label i) noexcept
	Return iterator at offset i from begin, clamped to [0,size] range. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	begin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...

iterator	end () noexcept
	Return an iterator to end traversing the UList. More...

const_iterator	end () const noexcept
	Return const_iterator to end traversing the constant UList. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin traversing the constant UList. More...

const_iterator	cbegin (const label i) const noexcept
	Return const_iterator at offset i from begin, clamped to [0,size] range. More...

const_iterator	cend () const noexcept
	Return const_iterator to end traversing the constant UList. More...

reverse_iterator	rbegin ()
	Return reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	rbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

reverse_iterator	rend ()
	Return reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	rend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

const_reverse_iterator	crbegin () const
	Return const_reverse_iterator to begin reverse traversing the UList. More...

const_reverse_iterator	crend () const
	Return const_reverse_iterator to end reverse traversing the UList. More...

bool	empty () const noexcept
	True if List is empty (ie, size() is zero) More...

label	capacity () const noexcept
	Size of the underlying storage. More...

void	swap (UList< label > &list) noexcept
	Swap content with another UList of the same type in constant time. More...

bool	operator== (const UList< label > &list) const
	Equality operation on ULists of the same type. More...

bool	operator!= (const UList< label > &list) const
	The opposite of the equality operation. Takes linear time. More...

bool	operator< (const UList< label > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator> (const UList< label > &list) const
	Compare two ULists lexicographically. Takes linear time. More...

bool	operator<= (const UList< label > &list) const
	Return true if !(a > b). Takes linear time. More...

bool	operator>= (const UList< label > &list) const
	Return true if !(a < b). Takes linear time. More...

Istream &	readList (Istream &is)
	Read List contents from Istream. More...

Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write List, with line-breaks in ASCII when length exceeds shortLen. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	test (const label i) const
	Test `bool` value at specified position, always false for out-of-range access. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	get (const label i) const
	Return `bool` value at specified position, always false for out-of-range access. More...

std::enable_if< std::is_same< bool, TypeT >::value, bool >::type	unset (const label i)
	Unset the `bool` entry at specified position, always false for out-of-range access. More...

label &	first ()
	Access first element of the list, position [0]. More...

const label &	first () const
	Access first element of the list. More...

label &	last ()
	Access last element of the list, position [size()-1]. More...

const label &	last () const
	Access last element of the list, position [size()-1]. More...

bool	found (const label &val, label pos=0) const
	Same as contains() More...

Static Public Member Functions
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. More...

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

Static Public Member Functions inherited from UList< label >
static const UList< label > &	null ()
	Return a UList reference to a nullObject. More...

static constexpr label	max_size () noexcept
	The size of the largest possible UList. More...

Static Public Attributes
static const char *const	labelsName = "faceLabels"
	The name associated with the zone-labels dictionary entry ("faceLabels") More...

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

Public Types inherited from UList< label >
typedef label	value_type
	The value type the list contains. More...

typedef label *	pointer
	The pointer type for non-const access to value_type items. More...

typedef const label *	const_pointer
	The pointer type for const access to value_type items. More...

typedef label &	reference
	The type used for storing into value_type objects. More...

typedef const label &	const_reference
	The type used for reading from constant value_type objects. More...

typedef label *	iterator
	Random access iterator for traversing a UList. More...

typedef const label *	const_iterator
	Random access iterator for traversing a UList. More...

typedef label	size_type
	The type to represent the size of a UList. More...

typedef label	difference_type
	The difference between iterator objects. More...

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator (non-const access) More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator (const access) More...

Protected Member Functions inherited from UList< label >
void	setAddressableSize (const label n) noexcept
	Set addressed size to be inconsistent with allocated storage. More...

void	size (const label n)
	Older name for setAddressableSize. More...

void	writeEntry (Ostream &os) const
	Write the UList with its compound type. More...

void	writeEntry (Ostream &os) const
	Character list writeEntry. More...

void	writeEntry (Ostream &os) const

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

void	fill_uniform (const label &val)
	Assign all entries to the given value. More...

void	fill_uniform (const Foam::zero)
	Assign all entries to zero. More...

UList< label > &	operator= (const UList< label > &)=delete
	No copy assignment (default: shallow copy) More...

void	operator= (const Foam::zero)
	Character list assign zero - avoids Foam::zero casting ambiguities. More...

void	operator= (const Foam::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/12]

faceZone ( const faceZone & )

delete

No copy construct.

◆ faceZone() [2/12]

faceZone ( const faceZoneMesh & zm )

explicit

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

Definition at line 214 of file faceZone.C.

◆ faceZone() [3/12]

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

Construct an empty zone with specified name and index.

Definition at line 221 of file faceZone.C.

◆ faceZone() [4/12]

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

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

Here is the call graph for this function:

◆ faceZone() [5/12]

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

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

Here is the call graph for this function:

◆ faceZone() [6/12]

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

Construct from components, copying addressing.

Definition at line 268 of file faceZone.C.

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

Here is the call graph for this function:

◆ faceZone() [7/12]

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

Construct from components, transferring addressing.

Definition at line 293 of file faceZone.C.

References List< label >::transfer().

Here is the call graph for this function:

◆ faceZone() [8/12]

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

Construct from dictionary.

Definition at line 318 of file faceZone.C.

◆ faceZone() [9/12]

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

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

Definition at line 334 of file faceZone.C.

◆ faceZone() [10/12]

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

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

Definition at line 347 of file faceZone.C.

◆ faceZone() [11/12]

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.

Definition at line 360 of file faceZone.C.

◆ faceZone() [12/12]

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.

Definition at line 378 of file faceZone.C.

◆ ~faceZone()

virtual ~faceZone ( )

virtualdefault

Destructor.

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 307 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 317 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 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

Return reference to the zone mesh.

Definition at line 354 of file faceZone.H.

◆ addressing()

const labelList& addressing ( ) const

inlinenoexcept

The addressing (face IDs) used for the zone.

Definition at line 359 of file faceZone.H.

Referenced by faceZoneSet::faceZoneSet().

Here is the caller graph for this function:

◆ flipMap()

const boolList& flipMap ( ) const

inlinenoexcept

Return face flip map.

Definition at line 367 of file faceZone.H.

Referenced by repatchPolyTopoChanger::changeAnchorPoint(), repatchPolyTopoChanger::changePatchID(), faceZone::clone(), ensightMesh::correct(), directionalPressureGradientExplicitSource::correct(), meshRefinement::doSplitFaces(), faceZoneSet::faceZoneSet(), meshRefinement::getZoneFaces(), heatExchangerModel::initialise(), fluxSummary::initialiseFaceZone(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), duplicatePoints::setRefinement(), removeCells::setRefinement(), perfectInterface::setRefinement(), tetDecomposer::setRefinement(), combineFaces::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 397 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(), tetDecomposer::setRefinement(), combineFaces::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:

◆ patch()

const Foam::primitiveFacePatch & patch ( ) const

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

Definition at line 403 of file faceZone.C.

Referenced by faceZone::operator()().

Here is the caller 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 413 of file faceZone.C.

Referenced by faceZone::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 423 of file faceZone.C.

Referenced by faceZone::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 433 of file faceZone.C.

References mesh, and Foam::foamVersion::patch.

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

virtual

Check zone definition. Return true if in error.

Implements zone.

Definition at line 574 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 580 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::returnReduceOr(), 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 671 of file faceZone.C.

References pts.

◆ updateMesh()

void updateMesh ( const mapPolyMesh & mpm )

virtual

Update for changes in topology.

Definition at line 542 of file faceZone.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from zone.

Definition at line 679 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 687 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:

◆ clearAddressing()

void clearAddressing ( )

virtual

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

Reimplemented from zone.

Definition at line 463 of file faceZone.C.

References zone::clearAddressing().

Here is the call graph for this function:

◆ clearPrimitives()

void clearPrimitives ( )

virtual

Clear primitive addressing.

Reimplemented from zone.

Definition at line 470 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 477 of file faceZone.C.

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

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

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

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

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

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

Here is the call 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 514 of file faceZone.H.

References faceZone::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 521 of file faceZone.H.

References faceZone::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 528 of file faceZone.H.

References faceZone::backCells().

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

Here is the call graph for this function:

Here is the caller 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 144 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/12]

◆ faceZone() [2/12]

◆ faceZone() [3/12]

◆ faceZone() [4/12]

◆ faceZone() [5/12]

◆ faceZone() [6/12]

◆ faceZone() [7/12]

◆ faceZone() [8/12]

◆ faceZone() [9/12]

◆ faceZone() [10/12]

◆ faceZone() [11/12]

◆ faceZone() [12/12]

◆ ~faceZone()

Member Function Documentation

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ clone() [1/2]

◆ clone() [2/2]

◆ New()

◆ zoneMesh()

◆ addressing()

◆ flipMap()

◆ whichFace()

◆ patch()

◆ frontCells()

◆ backCells()

◆ meshEdges()

◆ checkDefinition()

◆ checkParallelSync()

◆ movePoints()

◆ updateMesh()

◆ write()

◆ writeDict()

◆ clearAddressing()

◆ clearPrimitives()

◆ resetAddressing() [1/5]

◆ resetAddressing() [2/5]

◆ resetAddressing() [3/5]

◆ resetAddressing() [4/5]

◆ resetAddressing() [5/5]

◆ operator=()

◆ operator()()

◆ masterCells()

◆ slaveCells()

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ labelsName