Base class for zones. More...

Inheritance diagram for zone:

[legend]

Collaboration diagram for zone:

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

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

	zone (const word &name, labelList &&addr, const label index)
	Construct from components, moving contents. More...

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

	zone (const zone &, const labelUList &addr, const label index)
	Construct given the original zone and resetting the. More...

	zone (const zone &, labelList &&addr, const label index)
	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...

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

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

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

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

virtual bool	checkDefinition (const bool report=false) const =0
	Check zone definition. Return true if in error. 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...

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

virtual void	write (Ostream &) const
	Write. 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 addressing. More...

void	operator= (labelList &&)
	Move assignment of addressing. 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 List< T2 > &)
	Copy constructor from list containing another type. More...

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

	List (List< label > &, bool reuse)
	Construct as copy or re-use 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< T >
	UList ()
	Null constructor. More...

	UList (T *__restrict__ v, label size)
	Construct from components. 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 T *	cdata () const
	Return a const pointer to the first data element,. More...

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

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

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

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

const T &	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< T > &)
	Copy the pointer held by the given UList. More...

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

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

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

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

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

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

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

iterator	end ()
	Return an iterator to end traversing the 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...

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

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

reverse_iterator	rbegin ()
	Return 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	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...

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

const_reverse_iterator	rend () 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< T > &)
	Swap two ULists of the same type in constant time. More...

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

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

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

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

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

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

template<>
const bool &	operator[] (const label i) const

Protected Member Functions
void	calcLookupMap () const
	Construct the look-up map. 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...

label	index_
	Index of zone. More...

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

Friends
Ostream &	operator<< (Ostream &, const zone &)
	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< T >
typedef T	value_type
	Type of values the UList contains. More...

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

typedef const T &	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 T *	iterator
	Random access iterator for traversing UList. More...

typedef const T *	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...

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< T >
static const UList< T > &	null ()
	Return a null UList. More...

Detailed Description

Base class for zones.

Source files

Definition at line 57 of file zone.H.

Constructor & Destructor Documentation

◆ zone() [1/6]

zone	(	const word &	name,
		const labelUList &	addr,
		const label	index
	)

Construct from components.

Definition at line 86 of file zone.C.

Referenced by zone::calcLookupMap(), and zone::zone().

Here is the caller graph for this function:

◆ zone() [2/6]

zone	(	const word &	name,
		labelList &&	addr,
		const label	index
	)

Construct from components, moving contents.

Definition at line 100 of file zone.C.

References zone::zone().

Here is the call graph for this function:

◆ zone() [3/6]

zone	(	const word &	name,
		const dictionary &	dict,
		const word &	labelsName,
		const label	index
	)

Construct from dictionary.

Definition at line 114 of file zone.C.

References zone::zone().

Here is the call graph for this function:

◆ zone() [4/6]

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

Construct given the original zone and resetting the.

cell list and mesh zones information

Definition at line 129 of file zone.C.

References zone::zone().

Here is the call graph for this function:

◆ zone() [5/6]

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

Construct given the original zone, resetting the.

cell list and mesh zones information

Definition at line 143 of file zone.C.

◆ zone() [6/6]

zone ( const zone & )

delete

Disallow default bitwise copy construction.

◆ ~zone()

~zone ( )

virtual

Destructor.

Definition at line 158 of file zone.C.

Member Function Documentation

◆ calcLookupMap()

void calcLookupMap ( ) const

protected

Construct the look-up map.

Definition at line 52 of file zone.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "zone" )

Runtime type information.

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 147 of file zone.H.

References zone::localID(), and zone::name_.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ localID()

Foam::label localID ( const label globalID ) 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 166 of file zone.C.

References HashTableCore::end(), and HashTable< T, Key, Hash >::find().

Referenced by zone::name(), cellZone::whichCell(), faceZone::whichFace(), and pointZone::whichPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ index()

label index ( ) const

inline

Return the index of this zone in zone list.

Definition at line 158 of file zone.H.

References zone::checkDefinition(), zone::clearAddressing(), zone::index_, and zone::lookupMap().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupMap()

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

Return a reference to the look-up map.

Definition at line 41 of file zone.C.

Referenced by zone::index().

Here is the caller graph for this function:

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 183 of file zone.C.

References Foam::deleteDemandDrivenData().

Referenced by faceZone::clearAddressing(), and zone::index().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDefinition() [1/2]

virtual bool checkDefinition ( const bool report = false ) const

pure virtual

Check zone definition. Return true if in error.

Implemented in faceZone, pointZone, and cellZone.

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

Here is the caller graph for this function:

◆ checkDefinition() [2/2]

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

virtual

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

Definition at line 189 of file zone.C.

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

Here is the call graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField & )

inlinevirtual

Correct patch after moving points.

Reimplemented in faceZone, and pointZone.

Definition at line 180 of file zone.H.

References zone::operator<<, zone::operator=(), zone::write(), and zone::writeDict().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in faceZone.

Definition at line 233 of file zone.C.

References Foam::nl.

Referenced by zone::movePoints(), and Foam::operator<<().

Here is the caller graph for this function:

◆ writeDict()

virtual void writeDict ( Ostream & ) const

pure virtual

Write dictionary.

Implemented in faceZone, pointZone, and cellZone.

Referenced by zone::movePoints().

Here is the caller graph for this function:

◆ operator=() [1/4]

void operator= ( const zone & zn )

Assignment operator.

Definition at line 242 of file zone.C.

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

Referenced by zone::movePoints(), cellZone::operator=(), pointZone::operator=(), and faceZone::operator=().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=() [2/4]

void operator= ( zone && zn )

Move assignment operator.

Definition at line 248 of file zone.C.

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

Here is the call graph for this function:

◆ operator=() [3/4]

void operator= ( const labelUList & addr )

Assignment operator to addressing.

Definition at line 254 of file zone.C.

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

Here is the call graph for this function:

◆ operator=() [4/4]

void operator= ( labelList && addr )

Move assignment of addressing.

Definition at line 260 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 &
	)

friend

Ostream Operator.

Referenced by zone::movePoints().

Member Data Documentation

◆ name_

word name_

protected

Name of zone.

Definition at line 67 of file zone.H.

Referenced by zone::name().

◆ index_

label index_

protected

Index of zone.

Definition at line 70 of file zone.H.

Referenced by zone::index().

◆ lookupMapPtr_

Map<label>* lookupMapPtr_

mutableprotected

Map of labels in zone for fast location lookup.

Definition at line 76 of file zone.H.

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

src/OpenFOAM/meshes/polyMesh/zones/zone/zone.H
src/OpenFOAM/meshes/polyMesh/zones/zone/zone.C

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

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

◆ calcLookupMap()

◆ TypeName()

◆ name()

◆ localID()

◆ index()

◆ lookupMap()

◆ clearAddressing()

◆ checkDefinition() [1/2]

◆ checkDefinition() [2/2]

◆ movePoints()

◆ write()

◆ writeDict()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ name_

◆ index_

◆ lookupMapPtr_