Base class for mesh zones. More...

Inheritance diagram for zone:

Collaboration diagram for zone:

Public Member Functions
	TypeName ("zone")
	Runtime type information. 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 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 &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 List< T >
constexpr	List () noexcept
	Null constructor. More...

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

	List (const label len, const T &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 T &val)
	Construct with length=1, copying the value as the only content. More...

	List (const Foam::one, T &&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< T > &a)
	Copy construct from list. More...

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

	List (List< T > &a, bool reuse)
	Construct as copy or re-use as specified. More...

	List (const UList< T > &list, const labelUList &indices)
	Copy construct subset of list. More...

template<unsigned N>
	List (const UList< T > &list, const FixedList< label, N > &indices)
	Copy construct subset of list. More...

template<class InputIterator >
	List (InputIterator begIter, InputIterator endIter)
	Construct given begin/end iterators. More...

template<unsigned N>
	List (const FixedList< T, N > &list)
	Construct as copy of FixedList<T, N> More...

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

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

template<class Addr >
	List (const IndirectListBase< T, Addr > &list)
	Construct as copy of IndirectList contents. More...

	List (std::initializer_list< T > list)
	Construct from an initializer list. More...

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

template<int SizeMin>
	List (DynamicList< T, SizeMin > &&list)
	Move construct from DynamicList. More...

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

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

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

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

	~List ()
	Destructor. More...

void	resize (const label newSize)
	Adjust allocated size of list. More...

void	resize (const label newSize, const T &val)
	Adjust allocated size of list and set val for new elements. More...

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

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

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

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

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

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

template<class Addr >
void	append (const IndirectListBase< T, Addr > &list)
	Append IndirectList contents at the end of this list. More...

void	transfer (List< T > &list)

template<int SizeMin>
void	transfer (DynamicList< T, SizeMin > &list)

void	transfer (SortableList< T > &list)

T &	newElmt (const label i)

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

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

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

template<class Addr >
void	operator= (const IndirectListBase< T, Addr > &list)
	Assignment from IndirectList. Takes linear time. More...

template<unsigned N>
void	operator= (const FixedList< T, N > &list)
	Copy assignment from FixedList. More...

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

void	operator= (const T &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< T > &&list)
	Move assignment. Takes constant time. More...

template<int SizeMin>
void	operator= (DynamicList< T, SizeMin > &&list)
	Move assignment. Takes constant time. More...

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

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

void	shallowCopy (const UList< T > &)=delete
	No shallowCopy permitted. More...

template<class TypeT = T>
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...

template<>
void	resize (const label newSize)

Protected Member Functions
void	calcLookupMap () const
	Construct the look-up map. 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 &os, const zone &zn)
	Ostream Operator. More...

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

Static Public Member Functions inherited from List< T >
static const List< T > &	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/6]

zone	(	const word &	name,
		const label	index
	)

Construct an empty zone.

Definition at line 82 of file zone.C.

◆ zone() [2/6]

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

Copy construct from components.

Definition at line 92 of file zone.C.

◆ zone() [3/6]

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

Move construct from components.

Definition at line 106 of file zone.C.

◆ zone() [4/6]

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

Construct from dictionary.

Definition at line 120 of file zone.C.

◆ zone() [5/6]

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

◆ zone() [6/6]

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

◆ ~zone()

~zone ( )

virtual

Destructor.

Definition at line 164 of file zone.C.

Member Function Documentation

◆ calcLookupMap()

void calcLookupMap ( ) const

protected

Construct the look-up map.

Definition at line 55 of file zone.C.

References Foam::abort(), DebugInfo, DebugInFunction, Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, and Foam::nl.

Referenced by zone::lookupMap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "zone" )

Runtime type information.

◆ name()

const word& name ( ) const

inline

Return name.

Definition at line 158 of file zone.H.

References zone::name_.

Referenced by multiBandZoneAbsorptionEmission::aCont(), meshRefinement::balance(), meshRefinement::checkCoupledFaceZones(), meshRefinement::createZoneBaffles(), snappyLayerDriver::doLayers(), multiBandZoneAbsorptionEmission::eCont(), meshRefinement::getZoneFaces(), meshRefinement::getZones(), fvMeshDistribute::printMeshInfo(), FLMAsurfaceFormat< Face >::write(), OBJsurfaceFormat< Face >::write(), AC3DsurfaceFormat< Face >::write(), OFFsurfaceFormat< Face >::write(), ABAQUSsurfaceFormat< Face >::write(), FacePostProcessing< CloudType >::write(), STLsurfaceFormat< Face >::writeAscii(), and meshRefinement::zonify().

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

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

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 169 of file zone.H.

References zone::index_.

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

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

References zone::calcLookupMap(), and zone::lookupMapPtr_.

Here is the call graph for this function:

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 178 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 184 of file zone.C.

References Foam::endl(), HashSet< Key, Hash >::insert(), 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 191 of file zone.H.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in faceZone.

Definition at line 228 of file zone.C.

References Foam::nl.

Referenced by Foam::operator<<().

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.

Member Data Documentation

◆ name_

word name_

protected

Name of zone.

Definition at line 78 of file zone.H.

Referenced by zone::name().

◆ index_

label index_

protected

Index of zone.

Definition at line 81 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 87 of file zone.H.

Referenced by zone::lookupMap().

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

Friends And Related Function Documentation

◆ operator<<

Member Data Documentation

◆ name_

◆ index_

◆ lookupMapPtr_