A list of mesh zones. More...

Inheritance diagram for ZoneList< ZoneType, ZonesType, MeshType >:

[legend]

Collaboration diagram for ZoneList< ZoneType, ZonesType, MeshType >:

Public Member Functions
	ZoneList (const IOobject &, const MeshType &)
	Read constructor given IOobject and a MeshType reference. More...

	ZoneList (ZoneList &&)=default
	Move constructor. More...

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

	~ZoneList ()
	Destructor. More...

const MeshType &	mesh () const
	Return the mesh reference. More...

bool	found (const label objectIndex) const
	Return true if objectIndex is in any zone. More...

labelList	whichZones (const label objectIndex) const
	Given a global object index, return the list of zones it is in. More...

wordList	types () const
	Return a list of zone types. More...

void	append (ZoneType *) const
	Append or update a zone. More...

void	append (const ZoneType &) const
	Append or update a zone. More...

void	clearAddressing ()
	Clear addressing. More...

void	clear ()
	Clear the zones. More...

bool	checkDefinition (const bool report=false) const
	Check zone definition. Return true if in error. More...

bool	checkParallelSync (const bool report=false) const
	Check whether all procs have all zones and in same order. Return. More...

void	insert (const List< labelHashSet > &zonesIndices)
	Insert given indices into zones. More...

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

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology 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...

void	swap (ZonesType &)
	Swap zones. More...

bool	readIfPresent ()
	Read zones if the zones file is present. More...

virtual bool	writeData (Ostream &) const
	writeData member function required by regIOobject More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

void	operator= (const ZoneList< ZoneType, ZonesType, MeshType > &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (const regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy constructor with new name, transferring registry registration. More...

	regIOobject (const IOobject &, const regIOobject &)
	Copy constructor with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)
	Assign to IOobject. More...

void	operator= (const regIOobject &)=delete
	Disallow default assignment. More...

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

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

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const word &typeName, const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Public Member Functions inherited from PtrListDictionary< ZoneType >
	PtrListDictionary (const label size)
	Construct given initial list size. More...

	PtrListDictionary (const PtrListDictionary &)
	Copy constructor. More...

	PtrListDictionary (PtrListDictionary &&)
	Move constructor. More...

	PtrListDictionary (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

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

label	findIndex (const word &key) const
	Return the index of the given the key or -1 if not found. More...

List< label >	findIndices (const wordRe &key) const
	Return the indices for all matches. More...

void	append (const word &key, ZoneType *)
	Append an element at the end of the list. More...

void	append (const word &key, const autoPtr< ZoneType > &)
	Append an element at the end of the list. More...

void	append (const word &key, const tmp< ZoneType > &)
	Append an element at the end of the list. More...

void	append (ZoneType *)
	Append an element at the end of the list. More...

void	append (const autoPtr< ZoneType > &)
	Append an element at the end of the list. More...

void	append (const tmp< ZoneType > &)
	Append an element at the end of the list. More...

autoPtr< ZoneType >	set (const label, const word &key, ZoneType *)
	Set element to pointer provided and return old element. More...

autoPtr< ZoneType >	set (const label, const word &key, const autoPtr< ZoneType > &)
	Set element to autoPtr value provided and return old element. More...

autoPtr< ZoneType >	set (const label, const word &key, const tmp< ZoneType > &)
	Set element to tmp value provided and return old element. More...

autoPtr< ZoneType >	set (const label, ZoneType *)
	Set element to pointer provided and return old element. More...

autoPtr< ZoneType >	set (const label, const autoPtr< ZoneType > &)
	Set element to autoPtr value provided and return old element. More...

autoPtr< ZoneType >	set (const label, const tmp< ZoneType > &)
	Set element to tmp value provided and return old element. More...

UPtrListDictionary< T2 >	convert ()
	Convert to list of different pointer type. More...

Foam::UPtrListDictionary< T2 >	convert ()

const ZoneType &	operator[] (const word &key) const
	Find and return entry. More...

ZoneType &	operator[] (const word &key)
	Find and return entry. More...

Public Member Functions inherited from DictionaryBase< IDLListType, T >
	DictionaryBase (const label size=128)
	Construct given initial table size. More...

	DictionaryBase (const DictionaryBase &)
	Copy constructor. More...

	DictionaryBase (DictionaryBase &&)
	Move constructor. More...

template<class INew >
	DictionaryBase (Istream &, const INew &)
	Construct from Istream using given Istream constructor class. More...

	DictionaryBase (Istream &)
	Construct from Istream using default Istream constructor class. More...

bool	found (const word &) const
	Search DictionaryBase for given keyword. More...

const T *	lookupPtr (const word &) const
	Find and return an entry if present, otherwise return nullptr. More...

T *	lookupPtr (const word &)
	Find and return an entry if present, otherwise return nullptr. More...

const T *	lookup (const word &) const
	Find and return entry. More...

T *	lookup (const word &)
	Find and return entry. More...

wordList	toc () const
	Return the table of contents. More...

wordList	sortedToc () const
	Return the table of contents as a sorted list. More...

void	insert (const word &, T *)
	Add at head of dictionary. More...

void	append (const word &, T *)
	Add at tail of dictionary. More...

T *	remove (const word &)
	Remove and return entry specified by keyword. More...

void	clear ()
	Clear the dictionary. More...

void	transfer (DictionaryBase< IDLListType, T > &)
	Transfer the contents of the argument into this DictionaryBase. More...

void	operator= (const DictionaryBase &)

const T *	operator[] (const word &key) const
	Find and return entry. More...

T *	operator[] (const word &key)
	Find and return entry. More...

Friends
Ostream &	operator (Ostream &, const ZoneList< ZoneType, ZonesType, MeshType > &)

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
void	setBad (const string &)
	Set the object state to bad. More...

template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Protected Member Functions inherited from DictionaryBase< IDLListType, T >
void	addEntries ()

Protected Attributes inherited from DictionaryBase< IDLListType, T >
HashTable< T * >	hashedTs_
	HashTable of the entries held on the IDLListType for quick lookup. More...

Detailed Description

template<class ZoneType, class ZonesType, class MeshType>
class Foam::ZoneList< ZoneType, ZonesType, MeshType >

A list of mesh zones.

Source files

Definition at line 67 of file ZoneList.H.

Constructor & Destructor Documentation

◆ ZoneList() [1/3]

ZoneList	(	const IOobject &	io,
		const MeshType &	mesh
	)

Read constructor given IOobject and a MeshType reference.

Definition at line 95 of file ZoneList.C.

◆ ZoneList() [2/3]

ZoneList ( ZoneList< ZoneType, ZonesType, MeshType > && )

default

Move constructor.

◆ ZoneList() [3/3]

ZoneList ( const ZoneList< ZoneType, ZonesType, MeshType > & )

delete

Disallow default bitwise copy construction.

◆ ~ZoneList()

~ZoneList

Destructor.

Definition at line 112 of file ZoneList.C.

Member Function Documentation

◆ mesh()

const MeshType& mesh ( ) const

inline

Return the mesh reference.

Definition at line 109 of file ZoneList.H.

Referenced by faceZone::calcFaceZonePatch(), cellZone::meshCentres(), pointZone::meshCentres(), and FacePostProcessing< CloudType >::preFace().

Here is the caller graph for this function:

◆ found()

bool found ( const label objectIndex ) const

Return true if objectIndex is in any zone.

Definition at line 121 of file ZoneList.C.

Referenced by interRegionPorosityForce::interRegionPorosityForce(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), and sampledIsoSurfaceSurface::sampledIsoSurfaceSurface().

Here is the caller graph for this function:

◆ whichZones()

Foam::labelList whichZones ( const label objectIndex ) const

Given a global object index, return the list of zones it is in.

Definition at line 139 of file ZoneList.C.

Referenced by meshRefinement::checkZoneFaces().

Here is the caller graph for this function:

◆ types()

Foam::wordList types

Return a list of zone types.

Definition at line 159 of file ZoneList.C.

◆ append() [1/2]

void append ( ZoneType * zonePtr ) const

Append or update a zone.

Definition at line 175 of file ZoneList.C.

References found.

Referenced by interRegionPorosityForce::interRegionPorosityForce(), and powerLawLopesdaCostaZone::powerLawLopesdaCostaZone().

Here is the caller graph for this function:

◆ append() [2/2]

void append ( const ZoneType & zone ) const

Append or update a zone.

Definition at line 200 of file ZoneList.C.

References found.

◆ clearAddressing()

void clearAddressing

Clear addressing.

Definition at line 224 of file ZoneList.C.

References forAll.

◆ clear()

void clear

Clear the zones.

Definition at line 236 of file ZoneList.C.

References clear().

Referenced by polyMeshAdder::add(), and cellTable::addCellZones().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

Check zone definition. Return true if in error.

Definition at line 244 of file ZoneList.C.

References forAll.

Referenced by Foam::meshCheck::checkTopology().

Here is the caller graph for this function:

◆ checkParallelSync()

bool checkParallelSync ( const bool report = false ) const

Check whether all procs have all zones and in same order. Return.

true if in error.

Definition at line 262 of file ZoneList.C.

References Foam::endl(), forAll, Foam::Info, and List< T >::size().

Referenced by Foam::meshCheck::checkTopology().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insert()

void insert ( const List< labelHashSet > & zonesIndices )

Insert given indices into zones.

Definition at line 340 of file ZoneList.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, DictionaryBase< IDLListType, T >::insert(), and List< T >::size().

Referenced by addPatchCellLayer::updateZones().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField & p )

virtual

Correct zones after moving points.

Definition at line 363 of file ZoneList.C.

References forAll, and p.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Definition at line 378 of file ZoneList.C.

References forAll.

Referenced by polyMesh::topoChangeZones().

Here is the caller graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Definition at line 393 of file ZoneList.C.

References forAll.

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Definition at line 408 of file ZoneList.C.

References forAll.

◆ swap()

void swap ( ZonesType & otherZones )

Swap zones.

For run-time mesh replacement and mesh to mesh mapping

Definition at line 423 of file ZoneList.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), PtrListDictionary< T >::append(), Foam::clone(), Foam::findIndex(), forAll, Foam::name(), and PtrListDictionary< T >::set().

Here is the call graph for this function:

◆ readIfPresent()

bool readIfPresent

Read zones if the zones file is present.

Definition at line 480 of file ZoneList.C.

References Foam::blockMeshTools::read().

Referenced by polyMesh::polyMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

writeData member function required by regIOobject

Implements regIOobject.

Definition at line 488 of file ZoneList.C.

References IOstream::good().

Here is the call graph for this function:

◆ writeObject()

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp,
		const bool	write
	)		const

virtual

Write using given format, version and compression.

Only write the zones file if there are zones in the list

Reimplemented from regIOobject.

Definition at line 496 of file ZoneList.C.

References Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const ZoneList< ZoneType, ZonesType, MeshType > & )

delete

Disallow default bitwise assignment.

Friends And Related Function Documentation

◆ operator

Ostream& operator	(	Ostream &	,
		const ZoneList< ZoneType, ZonesType, MeshType > &
	)

friend

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

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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<class ZoneType, class ZonesType, class MeshType> class Foam::ZoneList< ZoneType, ZonesType, MeshType >

Constructor & Destructor Documentation

◆ ZoneList() [1/3]

◆ ZoneList() [2/3]

◆ ZoneList() [3/3]

◆ ~ZoneList()

Member Function Documentation

◆ mesh()

◆ found()

◆ whichZones()

◆ types()

◆ append() [1/2]

◆ append() [2/2]

◆ clearAddressing()

◆ clear()

◆ checkDefinition()

◆ checkParallelSync()

◆ insert()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ swap()

◆ readIfPresent()

◆ writeData()

◆ writeObject()

◆ operator=()

Friends And Related Function Documentation

◆ operator

template<class ZoneType, class ZonesType, class MeshType>
class Foam::ZoneList< ZoneType, ZonesType, MeshType >