Base class for mesh zones. More...

Inheritance diagram for zone:

Collaboration diagram for zone:

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

	zone ()
	Default construct. More...

	zone (const word &name, const label index)
	Construct an empty zone. 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 &origZone, const labelUList &addr, const label index)

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

virtual	~zone ()
	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 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 &pts)
	Correct patch after moving points. More...

virtual void	write (Ostream &os) const
	Write. More...

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

Public Member Functions inherited from zoneIdentifier
	zoneIdentifier (const zoneIdentifier &)=default
	Copy construct. More...

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

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

	zoneIdentifier ()
	Default construct. Uses 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 index)
	Copy construct, resetting the index. 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	write (Ostream &os) const

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

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

	List (List< label > &a, 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 SLList< label > &list)
	Construct as copy of SLList<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)
	Move construct from List. More...

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

	List (SortableList< label > &&list)
	Move construct from SortableList. More...

	List (SLList< label > &&list)
	Move construct from SLList. More...

	List (Istream &is)
	Construct from Istream. 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_nocopy (const label len)
	Adjust allocated size of list without necessarily. More...

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

void	setSize (const label n, const label &val)
	Alias for resize() 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)
	Append an element if not already in the list. More...

void	transfer (List< label > &list)

void	transfer (DynamicList< label, SizeMin > &list)

void	transfer (SortableList< label > &list)

label &	newElmt (const label i)

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

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

void	operator= (const SLList< label > &list)
	Assignment to SLList 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= (SortableList< label > &&list)
	Move assignment. Takes constant time. More...

void	operator= (SLList< label > &&list)
	Move assignment. Takes constant time. More...

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

Istream &	readList (Istream &is)

Istream &	readList (Istream &is)

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

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

Additional Inherited Members
Public Types inherited from List< label >
typedef SubList< label >	subList
	Declare type of subList. More...

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

Detailed Description

Base class for mesh zones.

A zone is a list of labels (eg, cells, faces, points) with a name and associated with an index within another list.

Source files

Definition at line 63 of file zone.H.

Constructor & Destructor Documentation

◆ zone() [1/7]

zone ( )

Default construct.

Definition at line 45 of file zone.C.

◆ zone() [2/7]

zone	(	const word &	name,
		const label	index
	)

Construct an empty zone.

Definition at line 53 of file zone.C.

◆ zone() [3/7]

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

Copy construct from components.

Definition at line 62 of file zone.C.

◆ zone() [4/7]

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

Move construct from components.

Definition at line 75 of file zone.C.

◆ zone() [5/7]

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

Construct from dictionary.

Definition at line 88 of file zone.C.

◆ zone() [6/7]

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

Construct given the name of the original zone (name is used) and resetting addressing and index.

Definition at line 100 of file zone.C.

◆ zone() [7/7]

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

Construct given the name of the original zone (name is used) and (move) resetting addressing and index.

Definition at line 111 of file zone.C.

◆ ~zone()

~zone ( )

virtual

Destructor.

Definition at line 123 of file zone.C.

Member Function Documentation

◆ TypeName()

TypeName ( "zone" )

Runtime type information.

◆ lookupMap()

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

Demand-driven: the look-up map from global to local id.

Definition at line 131 of file zone.C.

References DebugInFunction, Foam::endl(), and forAll.

Here is the call graph for this function:

◆ localID()

Foam::label localID ( const label globalID ) const

Lookup local address in zone for given global index.

Returns: the local address, or -1 if the item is not in the zone

Definition at line 152 of file zone.C.

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

Here is the caller graph for this function:

◆ addressing()

const labelList& addressing ( ) const

inlinenoexcept

The addressing used by the zone.

Definition at line 147 of file zone.H.

Referenced by faceZoneSet::faceZoneSet().

Here is the caller graph for this function:

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 158 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() [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(), and faceZone::checkDefinition().

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 164 of file zone.C.

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

Here is the call graph for this function:

◆ movePoints()

virtual void movePoints ( const pointField & pts )

inlinevirtual

Correct patch after moving points.

Reimplemented in faceZone, and pointZone.

Definition at line 167 of file zone.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in faceZone.

Definition at line 208 of file zone.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()

virtual void writeDict ( Ostream & os ) const

pure virtual

Write dictionary.

Implemented in faceZone, pointZone, and cellZone.

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream Operator.

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

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ zone() [1/7]

◆ zone() [2/7]

◆ zone() [3/7]

◆ zone() [4/7]

◆ zone() [5/7]

◆ zone() [6/7]

◆ zone() [7/7]

◆ ~zone()

Member Function Documentation

◆ TypeName()

◆ lookupMap()

◆ localID()

◆ addressing()

◆ clearAddressing()

◆ checkDefinition() [1/2]

◆ checkDefinition() [2/2]

◆ movePoints()

◆ write()

◆ writeDict()

Friends And Related Function Documentation

◆ operator<<