A list of mesh zones. More...

Inheritance diagram for ZoneMesh< ZoneType, MeshType >:

Collaboration diagram for ZoneMesh< ZoneType, MeshType >:

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

	ZoneMesh (const IOobject &io, const MeshType &mesh, const label size)
	Construct given size. More...

	ZoneMesh (const IOobject &io, const MeshType &mesh, const PtrList< ZoneType > &pzm)
	Construct given a PtrList. More...

	~ZoneMesh ()
	Destructor. More...

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

const Map< label > &	zoneMap () const
	Map of zones containing zone index for all zoned elements. More...

label	whichZone (const label objectIndex) const
	Given a global object index, return the zone it is in. More...

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

wordList	names () const
	A list of the zone names. More...

wordList	groupNames () const
	A list of the zone group names (if any) More...

wordList	names (const wordRe &matcher) const
	A list of zone names satisfying the input matcher. More...

wordList	names (const wordRes &matcher) const
	A list of zone names satisfying the input matchers. More...

wordList	sortedNames () const
	Sorted list of the zone names. More...

wordList	sortedNames (const wordRe &matcher) const
	Sorted list of zone names satisfying the input matcher. More...

wordList	sortedNames (const wordRes &matcher) const
	Sorted list of zone names satisfying the input matchers. More...

labelList	indices (const wordRe &matcher, const bool useGroups=true) const
	Return (sorted) zone indices for all matches. More...

labelList	indices (const wordRes &matcher, const bool useGroups=true) const
	Return (sorted) zone indices for all matches. More...

label	findIndex (const wordRe &key) const
	Zone index for the first match, return -1 if not found. More...

label	findIndex (const wordRes &matcher) const
	Zone index for the first match, return -1 if not found. More...

label	findZoneID (const word &zoneName) const
	Find zone index by name, return -1 if not found. More...

const ZoneType *	cfindZone (const word &zoneName) const
	Find zone by name and return const pointer, nullptr on error. More...

ZoneType *	findZone (const word &zoneName)
	Find zone by name and return pointer, nullptr on error. More...

bitSet	selection (const labelUList &zoneIds) const

bitSet	selection (const wordRe &matcher, const bool useGroups=true) const

bitSet	selection (const wordRes &matcher, const bool useGroups=true) const

const HashTable< labelList > &	groupZoneIDs () const
	The zone indices per zone group. More...

void	setGroup (const word &groupName, const labelUList &zoneIDs)
	Set/add group with 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. More...

void	movePoints (const pointField &pts)
	Correct zone mesh after moving points. More...

void	clearAddressing ()
	Clear addressing. More...

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

bool	hasFaceAreas () const

const ZoneType &	operator[] (const word &zoneName) const
	Return const reference to zone by name. More...

ZoneType &	operator[] (const word &zoneName)
	Return reference to an existing zone by name. More...

ZoneType &	operator() (const word &zoneName, const bool verbose=false)

void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

labelList	findIndices (const wordRes &key) const
	Identical to the indices() method (AUG-2018) More...

Public Member Functions inherited from PtrList< ZoneType >
constexpr	PtrList () noexcept
	Default construct. More...

	PtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	PtrList (const PtrList< ZoneType > &list)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< ZoneType > &&list)
	Move construct. More...

	PtrList (UList< ZoneType * > &list)
	Take ownership of pointers in the list, set old pointers to null. More...

	PtrList (const PtrList< ZoneType > &list, const CloneArg &cloneArgs)
	Copy construct using 'clone()' method on each element. More...

	PtrList (PtrList< ZoneType > &list, bool reuse)
	Construct as copy or re-use as specified. More...

	PtrList (const SLPtrList< ZoneType > &list)
	Copy construct using 'clone()' on each element of SLPtrList<T> More...

	PtrList (Istream &is, const INew &inew)
	Construct from Istream using given Istream constructor class. More...

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

	~PtrList ()
	Destructor. More...

PtrList< ZoneType >	clone (Args &&... args) const
	Make a copy by cloning each of the list elements. More...

Foam::PtrList< ZoneType >	clone (Args &&... args) const

const ZoneType *	set (const label i) const

autoPtr< ZoneType >	set (const label i, ZoneType *ptr)
	Set element to given pointer and return old element (can be null) More...

autoPtr< ZoneType >	set (const label i, autoPtr< ZoneType > &ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< ZoneType >	set (const label i, autoPtr< ZoneType > &&ptr)
	Set element to given autoPtr and return old element. More...

autoPtr< ZoneType >	set (const label i, std::unique_ptr< ZoneType > &&ptr)
	Set element to given unique_ptr and return old element. More...

autoPtr< ZoneType >	set (const label i, const refPtr< ZoneType > &ptr)
	Set element to given refPtr and return old element. More...

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

void	clear ()
	Clear the PtrList. Delete allocated entries and set size to zero. More...

void	resize (const label newLen)
	Adjust size of PtrList. More...

void	setSize (const label newLen)
	Same as resize() More...

void	emplace_append (Args &&... args)
	Construct and append an element to the end of the list. More...

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

void	append (autoPtr< ZoneType > &ptr)
	Move append an element to the end of the list. More...

void	append (autoPtr< ZoneType > &&ptr)
	Move append an element to the end of the list. More...

void	append (std::unique_ptr< ZoneType > &&ptr)
	Move append an element to the end of the list. More...

void	append (const refPtr< ZoneType > &ptr)
	Move or clone append a refPtr to the end of the list. More...

void	append (const tmp< ZoneType > &ptr)
	Move or clone append a tmp to the end of the list. More...

void	append (PtrList< ZoneType > &&other)
	Move append another list to the end of this list. More...

autoPtr< ZoneType >	emplace (const label i, Args &&... args)
	Construct and set an element. More...

Foam::autoPtr< ZoneType >	emplace (const label i, Args &&... args)

autoPtr< ZoneType >	release (const label i)
	Release ownership of the pointer at the given position. More...

void	transfer (PtrList< ZoneType > &list)
	Transfer into this list and annul the argument list. More...

void	operator= (const PtrList< ZoneType > &list)
	Copy assignment. More...

void	operator= (PtrList< ZoneType > &&list)
	Move assignment. More...

Public Member Functions inherited from UPtrList< T >
constexpr	UPtrList () noexcept
	Default construct. More...

	UPtrList (const label len)
	Construct with specified size, each element initialized to nullptr. More...

	UPtrList (const UPtrList< T > &list)
	Copy construct (shallow copies addresses) More...

	UPtrList (UPtrList< T > &&list)
	Move construct. More...

	UPtrList (UPtrList< T > &list, bool reuse)
	Construct as shallow copy or re-use as specified. More...

	UPtrList (PtrList< T > &list)
	Shallow copy from PtrList. More...

	UPtrList (const UList< T * > &list)
	Construct from UList of pointers (shallow copy) More...

	UPtrList (UList< T > &list)
	Construct from UList, taking the address of each list element. More...

label	size () const noexcept
	The number of elements in the list. More...

bool	empty () const noexcept
	True if the list is empty (ie, size() is zero) More...

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

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

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

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

const T *	test (const label i) const

T *	get (const label i)

const T *	get (const label i) const

const T *	set (const label i) const

void	clear ()
	Set list size to zero. More...

void	resize (const label newLen)
	Change the size of the list. More...

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

label	squeezeNull ()
	Squeeze out intermediate nullptr entries in the list of pointers. More...

void	append (T *ptr)
	Append an element to the end of the list. More...

void	append (UPtrList< T > &&other)
	Move append another list to the end of this list. More...

void	swap (UPtrList< T > &list)
	Swap content. More...

void	transfer (UPtrList< T > &list)
	Transfer contents into this list and annul the argument. More...

T *	set (const label i, T *ptr)

void	reorder (const labelUList &oldToNew, const bool check=false)

void	sortOrder (const labelUList &order, const bool check=false)

void	checkNonNull () const
	Check and raise FatalError if any nullptr exists in the list. More...

const T &	operator[] (const label i) const
	Return const reference to the element. More...

T &	operator[] (const label i)
	Return reference to the element. More...

const T *	operator() (const label i) const
	Return const pointer to the element - same as get(). More...

void	operator= (const UPtrList< T > &list)
	Copy assignment (shallow copies addresses) More...

void	operator= (UPtrList< T > &&list)
	Move assignment. More...

T **	begin_ptr () noexcept
	Iterator to begin of raw pointers traversal (use with caution) More...

T **	end_ptr () noexcept
	Iterator beyond end of raw pointers traversal (use with caution) More...

iterator	begin () noexcept
	Return an iterator to begin of UPtrList traversal. More...

iterator	end () noexcept
	Return iterator beyond end of UPtrList traversal. More...

const_iterator	cbegin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	cend () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

const_iterator	begin () const noexcept
	Return const_iterator to begin of UPtrList traversal. More...

const_iterator	end () const noexcept
	Return const_iterator beyond end of UPtrList traversal. More...

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

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters. More...

virtual	~regIOobject ()
	Destructor. More...

bool	checkIn ()
	Add object to registry, if not already registered. More...

bool	checkOut ()
	Remove all file watches and remove object from registry. More...

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

bool	registered () const noexcept

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

bool	store ()

void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry. More...

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

label &	eventNo () noexcept
	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 as up-to-date. More...

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

const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr. More...

dictionary &	getMetaData () noexcept
	Get or create meta-data. More...

void	removeMetaData ()
	Remove meta-data. More...

virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing) More...

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

bool	headerOk ()
	Read and check header info. Does not check the headerClassName. More...

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

void	close ()
	Close Istream. More...

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

virtual bool	read ()
	Read object. More...

virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched. More...

const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles. More...

labelList &	watchIndices () noexcept
	Write access to file-monitoring handles. More...

virtual bool	modified () const

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

virtual bool	writeData (Ostream &) const =0
	Pure virtual writeData function. More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

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

virtual bool	global () const
	Is object global. More...

void	operator= (const IOobject &io)
	Copy assignment. More...

virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const
	Write using given format, version and compression. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch) More...

	IOobject (const IOobject &)=default
	Copy construct. More...

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

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

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

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

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component. More...

	IOobject (const IOobject &io, readOption rOpt, writeOption wOpt)
	Copy construct, resetting read/write options. More...

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

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

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

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return the object name. More...

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

word &	headerClassName () noexcept
	Return non-constant access to the class name read from header. More...

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

string &	note () noexcept
	Modifiable access to the optional note. More...

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

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header. More...

bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading) More...

template<class Type >
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName. More...

template<class Type >
bool	isHeaderClassName () const
	Same as isHeaderClass() More...

virtual const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data (if any) or nullptr. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. More...

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

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

const fileName &	rootPath () const
	Return the Time::rootPath() More...

const fileName &	caseName () const
	Return the Time::caseName() More...

const fileName &	instance () const noexcept
	Read access to instance path component. More...

fileName &	instance () noexcept
	Write access to instance path component. More...

const fileName &	local () const noexcept
	Read access to local path component. More...

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

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

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

fileName	objectRelPath () const
	The object path relative to the root. More...

fileName	localFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. More...

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

bool	writeHeader (Ostream &os) const
	Write header with current type() More...

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

void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept
	Did last readHeader() succeed? More...

bool	bad () const noexcept
	Did last readHeader() fail? More...

InfoProxy< IOobject >	info () const
	Return info proxy, for printing information to a stream. More...

void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry) More...

readOption &	readOpt () noexcept
	Access to the read option. More...

writeOption &	writeOpt () noexcept
	Access to the write option. More...

bool &	registerObject () noexcept
	Access to the register object option. More...

bool &	globalObject () noexcept
	Access to the global object option. More...

template<>
bool	isHeaderClass () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Attributes
static int	disallowGenericZones
	Debug switch to disallow the use of generic zones. More...

Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes. More...

static char	scopeSeparator
	Character for scoping object names (':' or '_') More...

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

static float	fileModificationSkew
	Time skew (seconds) for file modification checks. More...

static int	maxFileModificationPolls
	Max number of times to poll for file modification changes. More...

Friends
Ostream &	operator (Ostream &os, const ZoneMesh< ZoneType, MeshType > &zones)

Additional Inherited Members
Public Types inherited from UPtrList< T >
typedef T	value_type
	Type of values the list contains. More...

typedef T &	reference
	A non-const reference to the value_type. More...

typedef const T &	const_reference
	A const reference to the value_type. More...

Public Types inherited from IOobject
enum	readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
	Enumeration defining the read options. More...

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

enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	fileCheckTypes : char { 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 *p)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry. More...

template<class Type >
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner. More...

static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner. More...

static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class StringType >
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string. More...

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

static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string. More...

static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name. More...

static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider. More...

static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider. More...

Protected Member Functions inherited from PtrList< ZoneType >
void	readIstream (Istream &is, const INew &inew)
	Read from Istream using Istream constructor class. More...

void	free ()
	Delete the allocated entries, but retain the list size. More...

Protected Member Functions inherited from UPtrList< T >
void	setAddressableSize (const label n) noexcept
	Adjust addressable size. More...

	UPtrList (Detail::PtrListDetail< T > &&ptrs)
	Low-level move construct. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary. More...

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

Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

Protected Attributes inherited from UPtrList< T >
Detail::PtrListDetail< T >	ptrs_
	The list of pointers. More...

Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

template<class ZoneType, class MeshType>
class Foam::ZoneMesh< ZoneType, MeshType >

A list of mesh zones.

Source files

Definition at line 65 of file ZoneMesh.H.

Constructor & Destructor Documentation

◆ ZoneMesh() [1/3]

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

Read constructor given IOobject and a MeshType reference.

Definition at line 205 of file ZoneMesh.C.

◆ ZoneMesh() [2/3]

ZoneMesh	(	const IOobject &	io,
		const MeshType &	mesh,
		const label	size
	)

Construct given size.

Definition at line 220 of file ZoneMesh.C.

◆ ZoneMesh() [3/3]

ZoneMesh	(	const IOobject &	io,
		const MeshType &	mesh,
		const PtrList< ZoneType > &	pzm
	)

Construct given a PtrList.

Definition at line 237 of file ZoneMesh.C.

◆ ~ZoneMesh()

~ZoneMesh

Destructor.

Definition at line 265 of file ZoneMesh.C.

Member Function Documentation

◆ mesh()

const MeshType & mesh ( ) const

inlinenoexcept

Return the mesh reference.

Definition at line 142 of file ZoneMesh.H.

Referenced by FacePostProcessing< CloudType >::postFace(), and RemoveParcels< CloudType >::postFace().

Here is the caller graph for this function:

◆ zoneMap()

const Foam::Map< Foam::label > & zoneMap

Map of zones containing zone index for all zoned elements.

Return -1 if the object is not in the zone

Definition at line 275 of file ZoneMesh.C.

◆ whichZone()

Foam::label whichZone ( const label objectIndex ) const

Given a global object index, return the zone it is in.

If object does not belong to any zones, return -1

Definition at line 287 of file ZoneMesh.C.

Referenced by cyclicAMIPolyPatch::addAMIFaces(), meshRefinement::mergeBaffles(), polyMeshAdder::mergePoints(), removeCells::setRefinement(), perfectInterface::setRefinement(), and edgeCollapser::setRefinement().

Here is the caller graph for this function:

◆ types()

Foam::wordList types

Return a list of zone types.

Definition at line 297 of file ZoneMesh.C.

◆ names() [1/3]

Foam::wordList names

A list of the zone names.

Definition at line 304 of file ZoneMesh.C.

Referenced by preserveFaceZones::add(), surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), preserveFaceZones::apply(), meshRefinement::checkCoupledFaceZones(), extractEulerianParticles::checkFaceZone(), directionalPressureGradientExplicitSource::directionalPressureGradientExplicitSource(), fvMeshTools::loadOrCreateMesh(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), fvMeshTools::newMesh(), cellTable::operator=(), porosityModel::porosityModel(), displacementLayeredMotionMotionSolver::solve(), CellZoneInjection< CloudType >::updateMesh(), and zoneMotion::zoneMotion().

Here is the caller graph for this function:

◆ groupNames()

Foam::wordList groupNames

A list of the zone group names (if any)

Definition at line 311 of file ZoneMesh.C.

Referenced by multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), porosityModel::porosityModel(), and zoneMotion::zoneMotion().

Here is the caller graph for this function:

◆ names() [2/3]

Foam::wordList names ( const wordRe & matcher ) const

A list of zone names satisfying the input matcher.

Definition at line 318 of file ZoneMesh.C.

◆ names() [3/3]

Foam::wordList names ( const wordRes & matcher ) const

A list of zone names satisfying the input matchers.

Definition at line 328 of file ZoneMesh.C.

◆ sortedNames() [1/3]

Foam::wordList sortedNames

Sorted list of the zone names.

Definition at line 339 of file ZoneMesh.C.

References Foam::sort().

Here is the call graph for this function:

◆ sortedNames() [2/3]

Foam::wordList sortedNames ( const wordRe & matcher ) const

Sorted list of zone names satisfying the input matcher.

Definition at line 349 of file ZoneMesh.C.

References Foam::sort().

Here is the call graph for this function:

◆ sortedNames() [3/3]

Foam::wordList sortedNames ( const wordRes & matcher ) const

Sorted list of zone names satisfying the input matchers.

Definition at line 362 of file ZoneMesh.C.

References Foam::sort().

Here is the call graph for this function:

◆ indices() [1/2]

Foam::labelList indices	(	const wordRe &	matcher,
		const bool	useGroups = `true`
	)		const

Return (sorted) zone indices for all matches.

Optionally matches zone groups. A no-op (returns empty list) for an empty matcher

Definition at line 376 of file ZoneMesh.C.

References HashTable< T, Key, Hash >::empty(), forAllConstIters, HashSet< Key, Hash >::insert(), wordRe::isPattern(), wordRe::match(), HashTable< T, Key, Hash >::resize(), and HashTable< T, Key, Hash >::sortedToc().

Referenced by ZoneMesh< ZoneType, MeshType >::findIndices(), multiSolidBodyMotionSolver::multiSolidBodyMotionSolver(), porosityModel::porosityModel(), sampledFaceZone::zoneIDs(), and zoneMotion::zoneMotion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ indices() [2/2]

Foam::labelList indices	(	const wordRes &	matcher,
		const bool	useGroups = `true`
	)		const

Return (sorted) zone indices for all matches.

Optionally matches zone groups. A no-op (returns empty list) for an empty matcher

Definition at line 449 of file ZoneMesh.C.

References HashTable< T, Key, Hash >::empty(), UList< T >::empty(), UList< T >::first(), forAllConstIters, HashSet< Key, Hash >::insert(), wordRes::match(), HashTable< T, Key, Hash >::resize(), UList< T >::size(), and HashTable< T, Key, Hash >::sortedToc().

Here is the call graph for this function:

◆ findIndex() [1/2]

Foam::label findIndex ( const wordRe & key ) const

Zone index for the first match, return -1 if not found.

A no-op (returns -1) for an empty key

Definition at line 496 of file ZoneMesh.C.

Referenced by cuttingSurfaceBase::cellSelection(), sampledCuttingPlane::sampledCuttingPlane(), sampledInterface::sampledInterface(), sampledIsoSurface::sampledIsoSurface(), and sampledPlane::sampledPlane().

Here is the caller graph for this function:

◆ findIndex() [2/2]

Foam::label findIndex ( const wordRes & matcher ) const

Zone index for the first match, return -1 if not found.

A no-op (returns -1) for an empty matcher

Definition at line 510 of file ZoneMesh.C.

References UList< T >::empty().

Here is the call graph for this function:

◆ findZoneID()

Foam::label findZoneID ( const word & zoneName ) const

Find zone index by name, return -1 if not found.

A no-op (returns -1) for an empty zoneName

Definition at line 524 of file ZoneMesh.C.

References DebugInFunction, Foam::endl(), Foam::Info, and UPtrList< T >::size().

Referenced by surfaceZonesInfo::addCellZone(), surfaceZonesInfo::addFaceZone(), meshRefinement::addPointZone(), cellZoneSet::cellZoneSet(), extractEulerianParticles::checkFaceZone(), FaceInteraction< CloudType >::FaceInteraction(), FacePostProcessing< CloudType >::FacePostProcessing(), faceZoneSet::faceZoneSet(), multiBandZoneAbsorptionEmission::multiBandZoneAbsorptionEmission(), pointZoneSet::pointZoneSet(), powerLawLopesdaCostaZone::powerLawLopesdaCostaZone(), RemoveParcels< CloudType >::RemoveParcels(), displacementLayeredMotionMotionSolver::solve(), CellZoneInjection< CloudType >::updateMesh(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), pointZoneSet::writeObject(), zeroATCcells::zeroATCcells(), and meshRefinement::zonify().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cfindZone()

const ZoneType * cfindZone ( const word & zoneName ) const

Find zone by name and return const pointer, nullptr on error.

A no-op (returns nullptr) for an empty zoneName

Definition at line 558 of file ZoneMesh.C.

References UPtrList< T >::begin(), UPtrList< T >::end(), Foam::endl(), UPtrList< T >::get(), and Foam::Info.

Here is the call graph for this function:

◆ findZone()

ZoneType * findZone ( const word & zoneName )

Find zone by name and return pointer, nullptr on error.

A no-op (returns nullptr) for an empty zoneName

Definition at line 594 of file ZoneMesh.C.

◆ selection() [1/3]

Foam::bitSet selection ( const labelUList & zoneIds ) const

Return all elements (cells, faces, points) contained in the listed zones.

The bitSet is empty (zero-size) if there are no elements matched anywhere.

Definition at line 604 of file ZoneMesh.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and bitSet::set().

Referenced by cuttingSurfaceBase::cellSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selection() [2/3]

Foam::bitSet selection	(	const wordRe &	matcher,
		const bool	useGroups = `true`
	)		const

Return all elements (cells, faces, points) that match the zone specification as a bitSet.

The bitSet is empty (zero-size) if there are no elements matched anywhere. Optionally matches zoneGroups. A no-op (returns empty bitSet) for an empty matcher

Definition at line 634 of file ZoneMesh.C.

◆ selection() [3/3]

Foam::bitSet selection	(	const wordRes &	matcher,
		const bool	useGroups = `true`
	)		const

Return all elements (cells, faces, points) that match the zone specification as a bitSet.

The bitSet is empty (zero-size) if there are no elements matched anywhere. A no-op (returns empty bitSet) for an empty matcher

Definition at line 646 of file ZoneMesh.C.

◆ groupZoneIDs()

const Foam::HashTable< Foam::labelList > & groupZoneIDs

The zone indices per zone group.

Definition at line 659 of file ZoneMesh.C.

◆ setGroup()

void setGroup	(	const word &	groupName,
		const labelUList &	zoneIDs
	)

Set/add group with zones.

Definition at line 671 of file ZoneMesh.C.

References forAll, UList< T >::found(), List< T >::resize(), UPtrList< T >::size(), and zoneIDs.

Here is the call graph for this function:

◆ checkDefinition()

bool checkDefinition ( const bool report = false ) const

Check zone definition. Return true if in error.

Definition at line 738 of file ZoneMesh.C.

Referenced by fvMeshTools::loadOrCreateMesh().

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.

Returns: True if any errors.

Definition at line 757 of file ZoneMesh.C.

References Foam::endl(), Foam::Info, procAddr(), UList< T >::size(), and UList< T >::slice().

Referenced by fvMeshTools::loadOrCreateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ movePoints()

void movePoints ( const pointField & pts )

Correct zone mesh after moving points.

Definition at line 838 of file ZoneMesh.C.

◆ clearAddressing()

void clearAddressing

Clear addressing.

Definition at line 715 of file ZoneMesh.C.

Referenced by meshRefinement::addPointZone(), meshRefinement::blockLeakFaces(), interRegionExplicitPorositySource::initialise(), polyMesh::updateMesh(), cellZoneSet::writeObject(), faceZoneSet::writeObject(), and pointZoneSet::writeObject().

Here is the caller graph for this function:

◆ clear()

void clear

Clear the zones.

Definition at line 730 of file ZoneMesh.C.

Referenced by polyMeshAdder::add(), cellTable::addCellZones(), fvMeshTools::loadOrCreateMesh(), blockMesh::mesh(), and fvMeshTools::newMesh().

Here is the caller graph for this function:

◆ hasFaceAreas()

bool hasFaceAreas ( ) const

inline

Definition at line 273 of file ZoneMesh.H.

References bool.

◆ operator[]() [1/2]

const ZoneType & operator[] ( const word & zoneName ) const

Return const reference to zone by name.

Fatal if the zone does not exist.

Definition at line 876 of file ZoneMesh.C.

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

Here is the call graph for this function:

◆ operator[]() [2/2]

ZoneType & operator[] ( const word & zoneName )

Return reference to an existing zone by name.

Fatal if the zone does not exist.

Definition at line 896 of file ZoneMesh.C.

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

Here is the call graph for this function:

◆ operator()()

ZoneType & operator()	(	const word &	zoneName,
		const bool	verbose = `false`
	)

Find an existing zone by name or create a new empty one if required.

To determine if the zone already existed or was newly created, it will be necessary to add additional logic in the caller. For example,

const label nOrig = zones.size();
 
ZoneType& zn = zones("zoneName");
 
if (nOrig == zones.size()) { existing... } else { new... }

Parameters

zoneName	the name of the zone
verbose	report if an existing zone was selected or a new zone was created.

Returns: non-const reference to the existing or new zone

Definition at line 916 of file ZoneMesh.C.

References append(), bool, Foam::endl(), and Foam::Info.

Here is the call graph for this function:

◆ updateMetaData()

void updateMetaData

virtual

Update internal meta-data (eg, prior to writing)

Reimplemented from regIOobject.

Definition at line 850 of file ZoneMesh.C.

References UList< T >::empty(), and dictionary::set().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

The writeData member function required by regIOobject.

Implements regIOobject.

Definition at line 866 of file ZoneMesh.C.

References os().

Here is the call graph for this function:

◆ findIndices()

labelList findIndices ( const wordRes & key ) const

inline

Identical to the indices() method (AUG-2018)

Definition at line 331 of file ZoneMesh.H.

References ZoneMesh< ZoneType, MeshType >::indices().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ operator

Ostream & operator	(	Ostream &	os,
		const ZoneMesh< ZoneType, MeshType > &	zones
	)

friend

Member Data Documentation

◆ disallowGenericZones

int disallowGenericZones

static

Debug switch to disallow the use of generic zones.

Definition at line 106 of file ZoneMesh.H.

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

src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/cellZoneMeshFwd.H
src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.H
src/OpenFOAM/meshes/polyMesh/zones/ZoneMesh/ZoneMesh.C

Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ZoneMesh() [1/3]

◆ ZoneMesh() [2/3]

◆ ZoneMesh() [3/3]

◆ ~ZoneMesh()

Member Function Documentation

◆ mesh()

◆ zoneMap()

◆ whichZone()

◆ types()

◆ names() [1/3]

◆ groupNames()

◆ names() [2/3]

◆ names() [3/3]

◆ sortedNames() [1/3]

◆ sortedNames() [2/3]

◆ sortedNames() [3/3]

◆ indices() [1/2]

◆ indices() [2/2]

◆ findIndex() [1/2]

◆ findIndex() [2/2]

◆ findZoneID()

◆ cfindZone()

◆ findZone()

◆ selection() [1/3]

◆ selection() [2/3]

◆ selection() [3/3]

◆ groupZoneIDs()

◆ setGroup()

◆ checkDefinition()

◆ checkParallelSync()

◆ movePoints()

◆ clearAddressing()

◆ clear()

◆ hasFaceAreas()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ operator()()

◆ updateMetaData()

◆ writeData()

◆ findIndices()

Friends And Related Function Documentation

◆ operator

Member Data Documentation

◆ disallowGenericZones