Base class for zones. More...

Inheritance diagram for Zone< ZoneType, ZonesType >:

[legend]

Collaboration diagram for Zone< ZoneType, ZonesType >:

[legend]

Public Member Functions
	declareRunTimeSelectionTable (autoPtr, ZoneType, dictionary,(const word &name, const dictionary &dict, const ZonesType &mz),(name, dict, mz))

	Zone (const word &name, const labelUList &indices, const ZonesType &zones)
	Construct from components. More...

	Zone (const word &name, labelList &&indices, const ZonesType &zones)
	Construct from components, moving contents. More...

	Zone (const word &name, const dictionary &, const ZonesType &zones)
	Construct from dictionary. More...

	Zone (const Zone &, const labelUList &indices, const ZonesType &zones)
	Construct given the original zone and resetting the. More...

	Zone (const Zone &, labelList &&indices, const ZonesType &zones)
	Construct given the original zone, resetting the. More...

	Zone (const Zone &)=delete
	Disallow default bitwise copy construction. More...

virtual	~Zone ()
	Destructor. More...

const word &	name () const
	Return name. More...

const word &	keyword () const
	Return name as the keyword. More...

const ZonesType &	zones () const
	Return ZonesType reference. More...

label	localIndex (const label globalIndex) const
	Map storing the local index for every global index. Used to find. More...

const Map< label > &	lookupMap () const
	Return a reference to the look-up map. More...

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

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

void	insert (const labelHashSet &newIndices)
	Insert given indices into zone. More...

void	swap (Zone &)
	Swap two zones. More...

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

virtual void	topoChange (const polyTopoChangeMap &map)=0
	Update zone using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

void	operator= (const Zone &)
	Assignment operator. More...

void	operator= (Zone &&)
	Move assignment operator. More...

void	operator= (const labelUList &)
	Assignment operator to indices. More...

void	operator= (labelList &&)
	Move assignment of indices. More...

Public Member Functions inherited from List< label >
	List ()
	Null constructor. More...

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

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

	List (const label, const zero)
	Construct with given size initialising all elements to zero. More...

	List (const List< label > &)
	Copy constructor. More...

	List (const UList< T2 > &)
	Copy constructor from list containing another type. More...

	List (List< label > &&)
	Move constructor. More...

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

	List (const UList< label > &, const labelUList &mapAddressing)
	Construct as subset. More...

	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

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

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

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

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

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

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

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

label	size () const
	Return the number of elements in the UList. More...

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

	~List ()
	Destructor. More...

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

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

void	setSize (const label)
	Reset size of List. More...

void	setSize (const label, const label &)
	Reset size of List and value for new elements. More...

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

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

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

void	append (const UIndirectList< label > &)
	Append a UIndirectList at the end of this list. More...

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

void	transfer (DynamicList< label, SizeInc, SizeMult, SizeDiv > &)
	Transfer the contents of the argument List into this list. More...

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

label &	newElmt (const label)
	Return subscript-checked element of UList. More...

void	shallowCopy (const UList< label > &)=delete
	Disallow implicit shallowCopy. More...

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

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

void	operator= (List< label > &&)
	Move assignment operator. More...

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

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

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

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

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

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

Public Member Functions inherited from UList< label >
void	operator= (const label &)
	Assignment of all entries to the given value. More...

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

	UList ()
	Null constructor. More...

	UList (label *__restrict__ v, label size)
	Construct from components. More...

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

label	fcIndex (const label i) const
	Return the forward circular index, i.e. the next index. More...

label	rcIndex (const label i) const
	Return the reverse circular index, i.e. the previous index. More...

std::streamsize	byteSize () const
	Return the binary size in number of characters of the UList. More...

const label *	cdata () const
	Return a const pointer to the first data element,. More...

label *	data ()
	Return a pointer to the first data element,. More...

label &	first ()
	Return the first element of the list. More...

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

label &	last ()
	Return the last element of the list. More...

const label &	last () const
	Return the last element of the list. More...

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

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

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

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

void	deepCopy (const UList< label > &)
	Copy elements of the given UList. More...

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

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

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

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

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

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

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

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

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

const_iterator	cend () const
	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...

label	size () const
	Return the number of elements in the UList. More...

label	max_size () const
	Return size of the largest possible UList. More...

bool	empty () const
	Return true if the UList is empty (ie, size() is zero) More...

void	swap (UList< label > &)
	Swap two ULists of the same type in constant time. More...

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

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

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

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

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

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

Static Public Member Functions
static autoPtr< ZoneType >	New (const word &name, const dictionary &, const ZonesType &)
	Return a pointer to a new cell zone. 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 null UList. More...

Protected Member Functions
template<class Type >
void	select (const Type &zone)
	Select the. More...

void	calcLookupMap () const
	Construct the look-up map. More...

void	topoChange (const labelList &map, const labelList &reverseMap)
	Update the addressing using the maps provided. More...

Protected Member Functions inherited from List< label >
void	size (const label)
	Override size to be inconsistent with allocated storage. More...

Protected Attributes
word	name_
	Name of zone. More...

const ZonesType &	zones_
	Reference to zone list. More...

Map< label > *	lookupMapPtr_
	Map of labels in zone for fast location lookup. More...

Friends
Ostream &	operator (Ostream &, const Zone< ZoneType, ZonesType > &)
	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
	Type of values the UList contains. More...

typedef label &	reference
	Type that can be used for storing into. More...

typedef const label &	const_reference
	Type that can be used for storing into. More...

typedef label	difference_type
	The type that can represent the difference between any two. More...

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

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

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

typedef std::reverse_iterator< iterator >	reverse_iterator
	Reverse iterator for reverse traversal of UList. More...

typedef std::reverse_iterator< const_iterator >	const_reverse_iterator
	Reverse iterator for reverse traversal of constant UList. More...

Detailed Description

template<class ZoneType, class ZonesType>
class Foam::Zone< ZoneType, ZonesType >

Base class for zones.

Source files

Definition at line 64 of file Zone.H.

Constructor & Destructor Documentation

◆ Zone() [1/6]

Zone	(	const word &	name,
		const labelUList &	indices,
		const ZonesType &	zones
	)

Construct from components.

Definition at line 111 of file Zone.C.

◆ Zone() [2/6]

Zone	(	const word &	name,
		labelList &&	indices,
		const ZonesType &	zones
	)

Construct from components, moving contents.

Definition at line 126 of file Zone.C.

◆ Zone() [3/6]

Zone	(	const word &	name,
		const dictionary &	dict,
		const ZonesType &	zones
	)

Construct from dictionary.

Definition at line 141 of file Zone.C.

◆ Zone() [4/6]

Zone	(	const Zone< ZoneType, ZonesType > &	z,
		const labelUList &	indices,
		const ZonesType &	zones
	)

Construct given the original zone and resetting the.

cell list and mesh zones information

Definition at line 156 of file Zone.C.

◆ Zone() [5/6]

Zone	(	const Zone< ZoneType, ZonesType > &	z,
		labelList &&	indices,
		const ZonesType &	zones
	)

Construct given the original zone, resetting the.

cell list and mesh zones information

Definition at line 171 of file Zone.C.

◆ Zone() [6/6]

Zone ( const Zone< ZoneType, ZonesType > & )

delete

Disallow default bitwise copy construction.

◆ ~Zone()

~Zone

virtual

Destructor.

Definition at line 223 of file Zone.C.

Member Function Documentation

◆ select()

void select ( const Type & zone )

protected

Select the.

Definition at line 35 of file Zone.C.

References forAll, List< T >::setSize(), and List< T >::size().

Here is the call graph for this function:

◆ calcLookupMap()

void calcLookupMap

protected

Construct the look-up map.

Definition at line 56 of file Zone.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, forAll, HashTable< T, Key, Hash >::insert(), Foam::nl, and List< T >::size().

Here is the call graph for this function:

◆ topoChange() [1/2]

void topoChange	(	const labelList &	map,
		const labelList &	reverseMap
	)

protected

Update the addressing using the maps provided.

Definition at line 78 of file Zone.C.

References forAll.

Referenced by cellZone::topoChange(), and pointZone::topoChange().

Here is the caller graph for this function:

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		ZoneType	,
		dictionary	,
		(const word &name, const dictionary &dict, const ZonesType &mz)	,
		(name, dict, mz)
	)

◆ New()

Foam::autoPtr< ZoneType > New	(	const word &	name,
		const dictionary &	dict,
		const ZonesType &	mz
	)

static

Return a pointer to a new cell zone.

created on freestore from dictionary

Definition at line 186 of file Zone.C.

References InfoInFunction.

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 184 of file Zone.H.

References Zone< ZoneType, ZonesType >::name_.

Referenced by meshRefinement::checkCoupledFaceZones(), fvMeshDistribute::printMeshInfo(), FacePostProcessing< CloudType >::write(), and meshRefinement::zonify().

Here is the caller graph for this function:

◆ keyword()

const word& keyword ( ) const

inline

Return name as the keyword.

Definition at line 190 of file Zone.H.

References Zone< ZoneType, ZonesType >::name_.

◆ zones()

const ZonesType & zones

Return ZonesType reference.

Definition at line 232 of file Zone.C.

◆ localIndex()

Foam::label localIndex ( const label globalIndex ) const

Map storing the local index for every global index. Used to find.

the index of the item in the zone from the known global index. If the item is not in the zone, returns -1

Definition at line 239 of file Zone.C.

Referenced by edgeCollapser::markFaceZoneEdges(), and faceZoneList::zonesFlipFace().

Here is the caller graph for this function:

◆ lookupMap()

const Foam::Map< Foam::label > & lookupMap

Return a reference to the look-up map.

Definition at line 260 of file Zone.C.

◆ clearAddressing()

void clearAddressing

virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 272 of file Zone.C.

References Foam::deleteDemandDrivenData().

Referenced by faceZone::clearAddressing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDefinition()

bool checkDefinition	(	const label	maxSize,
		const bool	report = `false`
	)		const

Check zone definition with max size given. Return true if in error.

Definition at line 279 of file Zone.C.

References Foam::endl(), forAll, HashSet< Key, Hash >::insert(), Foam::nl, SeriousErrorInFunction, and WarningInFunction.

Referenced by cellZone::checkDefinition(), faceZone::checkDefinition(), and pointZone::checkDefinition().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

void insert ( const labelHashSet & newIndices )

Insert given indices into zone.

Definition at line 328 of file Zone.C.

References HashSet< Key, Hash >::insert(), List< label >::operator=(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ swap()

void swap ( Zone< ZoneType, ZonesType > & z )

Swap two zones.

Definition at line 337 of file Zone.C.

References UList< label >::swap().

Referenced by faceZone::swap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField & )

inlinevirtual

Correct patch after moving points.

Reimplemented in faceZone.

Definition at line 223 of file Zone.H.

◆ topoChange() [2/2]

virtual void topoChange ( const polyTopoChangeMap & map )

pure virtual

Update zone using the given map.

Implemented in pointZone, cellZone, and faceZone.

◆ mapMesh()

void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Definition at line 345 of file Zone.C.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Definition at line 352 of file Zone.C.

◆ writeDict()

virtual void writeDict ( Ostream & ) const

pure virtual

Write dictionary.

Implemented in pointZone, faceZone, and cellZone.

◆ operator=() [1/4]

void operator= ( const Zone< ZoneType, ZonesType > & zn )

Assignment operator.

Definition at line 361 of file Zone.C.

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

Referenced by faceZone::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( Zone< ZoneType, ZonesType > && zn )

Move assignment operator.

Definition at line 369 of file Zone.C.

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

Here is the call graph for this function:

◆ operator=() [3/4]

void operator= ( const labelUList & indices )

Assignment operator to indices.

Definition at line 377 of file Zone.C.

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

Here is the call graph for this function:

◆ operator=() [4/4]

void operator= ( labelList && indices )

Move assignment of indices.

Definition at line 385 of file Zone.C.

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

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const Zone< ZoneType, ZonesType > &
	)

friend

Ostream Operator.

Member Data Documentation

◆ name_

word name_

protected

Name of zone.

Definition at line 74 of file Zone.H.

Referenced by Zone< ZoneType, ZonesType >::keyword(), and Zone< ZoneType, ZonesType >::name().

◆ zones_

const ZonesType& zones_

protected

Reference to zone list.

Definition at line 77 of file Zone.H.

◆ lookupMapPtr_

Map<label>* lookupMapPtr_

mutableprotected

Map of labels in zone for fast location lookup.

Definition at line 83 of file Zone.H.

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

src/OpenFOAM/meshes/zones/Zone/Zone.H
src/OpenFOAM/meshes/zones/Zone/Zone.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

template<class ZoneType, class ZonesType> class Foam::Zone< ZoneType, ZonesType >

Constructor & Destructor Documentation

◆ Zone() [1/6]

◆ Zone() [2/6]

◆ Zone() [3/6]

◆ Zone() [4/6]

◆ Zone() [5/6]

◆ Zone() [6/6]

◆ ~Zone()

Member Function Documentation

◆ select()

◆ calcLookupMap()

◆ topoChange() [1/2]

◆ declareRunTimeSelectionTable()

◆ New()

◆ name()

◆ keyword()

◆ zones()

◆ localIndex()

◆ lookupMap()

◆ clearAddressing()

◆ checkDefinition()

◆ insert()

◆ swap()

◆ movePoints()

◆ topoChange() [2/2]

◆ mapMesh()

◆ distribute()

◆ writeDict()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ name_

◆ zones_

◆ lookupMapPtr_

template<class ZoneType, class ZonesType>
class Foam::Zone< ZoneType, ZonesType >