Base class for zones. More...

Inheritance diagram for zone:

[legend]

Collaboration diagram for zone:

[legend]

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, const Xfer< labelList > &addr, const label index)
	Construct from components, transferring 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 &, const Xfer< labelList > &addr, const label index)
	Construct given the original zone, resetting the. 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...

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

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

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

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

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

	List (const Xfer< List< T > > &)
	Construct by transferring the parameter contents. More...

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

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

template<class InputIterator >
	List (InputIterator first, InputIterator last)
	Construct given start and end iterators. More...

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

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

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

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

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

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

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

	~List ()
	Destructor. More...

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

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

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

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

void	setSize (const label, const T &)
	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 T &)
	Append an element at the end of the list. More...

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

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

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

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

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

Xfer< List< T > >	xfer ()
	Transfer contents to the Xfer container. More...

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

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

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

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

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

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

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

template<class T >
	List (const label s)

template<class T >
	List (const label s, const T &a)

template<class T >
	List (const List< T > &a)

template<class T >
	List (const Xfer< List< T > > &lst)

template<class T >
	List (List< T > &a, bool reUse)

template<class T >
	List (const UList< T > &a, const labelUList &map)

template<class T >
	List (const PtrList< T > &lst)

template<class T >
	List (const SLList< T > &lst)

template<class T >
	List (const UIndirectList< T > &lst)

template<class T >
	List (const BiIndirectList< T > &lst)

template<class T >
void	transfer (List< T > &a)

template<class T >
void	transfer (SortableList< T > &a)

template<class T >
	List ()

template<class T >
	List (Istream &is)

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

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

	zone (const zone &)
	Disallow default bitwise copy construct. More...

Protected Member Functions inherited from List
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
typedef SubList< T >	subList
	Declare type of subList. More...

Static Public Member Functions inherited from List
static const List< T > &	null ()
	Return a null List. 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 zone & )

protected

Disallow default bitwise copy construct.

◆ zone() [2/6]

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

Construct from components.

Definition at line 90 of file zone.C.

◆ zone() [3/6]

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

Construct from components, transferring contents.

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

◆ zone() [5/6]

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

Construct given the original zone and resetting the.

cell list and zone mesh information

Definition at line 133 of file zone.C.

◆ zone() [6/6]

zone	(	const zone &	z,
		const Xfer< labelList > &	addr,
		const label	index
	)

Construct given the original zone, resetting the.

cell list and zone mesh information

Definition at line 147 of file zone.C.

◆ ~zone()

~zone ( )

virtual

Destructor.

Definition at line 162 of file zone.C.

Member Function Documentation

◆ lookupMap()

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

protected

Return a reference to the look-up map.

Definition at line 41 of file zone.C.

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

Here is the call graph for this function:

◆ 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, Foam::Info, Foam::nl, and List::size().

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

References zone::name_.

Referenced by meshRefinement::balance(), surfaceSlipDisplacementPointPatchVectorField::calcProjection(), surfaceDisplacementPointPatchVectorField::calcProjection(), displacementLayeredMotionMotionSolver::calcZoneMask(), displacementLayeredMotionMotionSolver::cellZoneSolve(), meshRefinement::checkCoupledFaceZones(), zoneToCell::combine(), zoneToFace::combine(), zoneToPoint::combine(), faceZoneToCell::combine(), meshRefinement::createZoneBaffles(), autoLayerDriver::doLayers(), displacementLayeredMotionMotionSolver::faceZoneEvaluate(), STARCD::getCellTable(), meshRefinement::getZoneBafflePatches(), meshRefinement::getZones(), moleculeCloud::initialiseMolecules(), printAllSets(), fvMeshDistribute::printMeshInfo(), triSurface::readVTK(), fvMeshSubset::subsetZones(), OBJsurfaceFormat< Face >::write(), AC3DsurfaceFormat< 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 170 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 161 of file zone.H.

References zone::index_.

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

Here is the caller graph for this function:

◆ clearAddressing()

void clearAddressing ( )

virtual

Clear addressing.

Reimplemented in faceZone.

Definition at line 187 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, cellZone, and pointZone.

Referenced by pointZone::checkDefinition(), cellZone::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 193 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.

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in faceZone.

Definition at line 237 of file zone.C.

References Foam::nl.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

◆ writeDict()

virtual void writeDict ( Ostream & ) const

pure virtual

Write dictionary.

Implemented in faceZone, cellZone, and pointZone.

Friends And Related Function Documentation

◆ operator<<

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

friend

Ostream Operator.

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

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

◆ lookupMap()

◆ calcLookupMap()

◆ TypeName()

◆ name()

◆ localID()

◆ index()

◆ clearAddressing()

◆ checkDefinition() [1/2]

◆ checkDefinition() [2/2]

◆ movePoints()

◆ write()

◆ writeDict()

Friends And Related Function Documentation

◆ operator<<

Field Documentation

◆ name_

◆ index_

◆ lookupMapPtr_