General set of labels of mesh quantity (points, cells, faces). More...

#include <topoSet.H>

Inheritance diagram for topoSet:

[legend]

Collaboration diagram for topoSet:

[legend]

Public Member Functions
	TypeName ("topoSet")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, topoSet, word,(const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt),(mesh, name, rOpt, wOpt))
	declareRunTimeSelectionTable (autoPtr, topoSet, size,(const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt),(mesh, name, size, wOpt))
	declareRunTimeSelectionTable (autoPtr, topoSet, set,(const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt),(mesh, name, set, wOpt))
	topoSet (const IOobject &io, const word &wantedType)
	Construct from IOobject as explicitly passed type.
	topoSet (const IOobject &io, const Foam::zero)
	Construct empty (no-read) with IOobject information.
	topoSet (const IOobject &io, const label initialCapacity)
	Construct empty (no-read) with initial labelHashSet capacity, with IOobject information.
	topoSet (const IOobject &io, const labelHashSet &labels)
	Copy construct (no-read) from labelHashSet, with IOobject information.
	topoSet (const IOobject &io, labelHashSet &&labels)
	Move construct (no-read) from labelHashSet, with IOobject information.
	topoSet (const polyMesh &mesh, const word &wantedType, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Construct from polyMesh and name.
	topoSet (const polyMesh &mesh, const word &name, const label initialCapacity, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Construct empty (no-read) with initial labelHashSet capacity.
	topoSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Copy construct (no-read) from labelHashSet.
	topoSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Move construct (no-read) from labelHashSet.
	topoSet (const polyMesh &mesh, const word &name, const labelUList &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Copy construct (no-read) from list of labels.
autoPtr< topoSet >	clone () const
	Clone.
virtual	~topoSet ()=default
	Destructor.
virtual bool	contains (const label id) const
	Has the given index?
virtual bool	found (const label id) const
	Has the given index?
virtual bool	set (const label id)
	Set an index.
virtual bool	unset (const label id)
	Unset an index.
virtual void	set (const labelUList &labels)
	Set multiple indices.
virtual void	unset (const labelUList &labels)
	Unset multiple indices.
virtual void	invert (const label maxLen)
	Invert contents.
virtual void	subset (const labelUList &elems)
	Subset contents. Only elements present in both sets remain.
virtual void	subset (const topoSet &set)
	Subset contents. Only elements present in both sets remain.
virtual void	addSet (const labelUList &elems)
	Add given elements to the set.
virtual void	addSet (const topoSet &set)
	Add given elements to the set.
virtual void	subtractSet (const labelUList &elems)
	Subtract given elements from the set.
virtual void	subtractSet (const topoSet &set)
	Subtract given elements from the set.
virtual void	sync (const polyMesh &mesh)
	Sync set across coupled patches.
virtual void	writeDebug (Ostream &os, const label maxLen) const
	Write labels columnwise to os. Truncate to maxLen.
virtual void	writeDebug (Ostream &os, const primitiveMesh &, const label maxLen) const =0
	Like above but also writes mesh related quantity (usually coordinate).
virtual bool	writeData (Ostream &) const
	Write contents.
virtual void	updateMesh (const mapPolyMesh &morphMap)
	Update any stored data for new labels. Not implemented.
virtual void	distribute (const mapDistributePolyMesh &)=0
	Update any stored data for mesh redistribution.
virtual label	maxSize (const polyMesh &mesh) const =0
	Return max allowable index (+1). Not implemented.
void	operator= (const topoSet &)
	Copy labelHashSet part only.
virtual void	deleteSet (const topoSet &set)
	Deprecated(2018-10) subtract elements present in set.
Public Member Functions inherited from regIOobject
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	regIOobject (const IOobject &io, const bool isTimeObject=false)
	Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
bool	registered () const noexcept
	Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a `void` type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
template<class Type>
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (respects is_globalIOobject trait) and check its info. A `void` type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A `void` type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
template<class StringType>
Foam::word	groupName (StringType base, const word &group)
template<class Type>
Foam::fileName	typeFilePath (const bool search) const
Public Member Functions inherited from IOobjectOption
constexpr	IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.
Public Member Functions inherited from HashSet< label, Hash< label > >
constexpr	HashSet () noexcept=default
	Default construct: empty without allocation (capacity=0).
constexpr	HashSet (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashSet (const label initialCapacity)
	Construct empty with initial table capacity.
	HashSet (const this_type &rhs)
	Copy construct.
	HashSet (this_type &&rhs) noexcept
	Move construct.
	HashSet (Istream &is)
	Construct from Istream with default initial table capacity.
	HashSet (const FixedList< label, N > &list)
	Construct from FixedList of Key.
	HashSet (const UList< label > &list)
	Construct from UList of Key.
	HashSet (const IndirectListBase< label, Addr > &list)
	Construct from an indirect list.
	HashSet (std::initializer_list< label > list)
	Construct from an initializer list of Key.
	HashSet (const HashTable< AnyType, label, AnyHash > &tbl)
	Construct from the keys of another HashTable, the type of values held is arbitrary.
bool	test (const label &key) const
	Same as contains() - return true if key exists in the set.
bool	insert (const label &key)
	Insert a new entry, not overwriting existing entries.
bool	set (const label &key)
	Same as insert (no value to overwrite).
bool	unset (const label &key)
	Unset the specified key - same as erase.
void	merge (HashSet< label, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
void	merge (HashSet< label, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
label	insert (InputIter first, InputIter last)
	Insert keys from the input iterator range.
label	insert (std::initializer_list< label > list)
	Insert keys from a initializer list of Key.
label	insert (const FixedList< label, N > &list)
	Insert keys from the list of Key.
label	insert (const UList< label > &list)
	Insert keys from the list of Key.
label	insert (const IndirectListBase< label, Addr > &list)
	Insert keys from the list of Key.
label	set (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
label	set (std::initializer_list< label > list)
	Same as insert (no value to overwrite).
label	set (const FixedList< label, N > &list)
	Same as insert (no value to overwrite).
label	set (const UList< label > &list)
	Same as insert (no value to overwrite).
label	set (const IndirectListBase< label, Addr > &list)
	Same as insert (no value to overwrite).
label	setMany (InputIter first, InputIter last)
	Same as insert (no value to overwrite).
label	unset (InputIter first, InputIter last)
	Unset the keys listed in the input iterator range.
label	unset (std::initializer_list< label > list)
	Unset the listed keys - same as erase.
label	unset (const FixedList< label, N > &list)
	Unset the listed keys - same as erase.
label	unset (const UList< label > &list)
	Unset the listed keys - same as erase.
label	unset (const IndirectListBase< label, Addr > &list)
	Unset the listed keys - same as erase.
iterator	begin ()
const_iterator	begin () const
const_iterator	cbegin () const
iterator	end () noexcept
const_iterator	end () const noexcept
constexpr const_iterator	cend () const noexcept
Ostream &	writeList (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	operator() (const label &key) const noexcept
	Return true if the entry exists, same as contains().
bool	operator[] (const label &key) const noexcept
	Return true if the entry exists, same as contains().
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (this_type &&rhs)
	Move assign.
bool	operator== (const this_type &rhs) const
	Sets are equal if all keys are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
void	operator= (const UList< label > &rhs)
	Assignment from a UList of keys.
void	operator= (const FixedList< label, N > &rhs)
	Assignment from a FixedList of keys.
void	operator= (std::initializer_list< label > rhs)
	Assignment from an initializer list of keys.
this_type &	operator\|= (const this_type &rhs)
	Add entries to this HashSet.
this_type &	operator&= (const this_type &rhs)
	Only retain entries contained in both HashSets.
this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor).
this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '\|=' operator.
this_type &	operator-= (const this_type &rhs)
	Remove entries from this HashSet. Uses erase().
List< label >	tocValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
List< label >	tocEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	countValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	countEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	filterValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet.
label	filterEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet.
Foam::label	assignMany (const label nItems, InputIter first, InputIter last)
Foam::label	insert (InputIter first, InputIter last)
Foam::label	insert (const FixedList< label, N > &list)
Foam::label	insert (const IndirectListBase< label, Addr > &list)
Foam::label	unset (InputIter first, InputIter last)
Foam::label	unset (const FixedList< label, N > &list)
Foam::label	unset (const IndirectListBase< label, Addr > &list)
Public Member Functions inherited from HashTable< T, Key, Hash >
constexpr	HashTable () noexcept
	Default construct: empty without allocation (capacity=0).
constexpr	HashTable (Foam::zero) noexcept
	Construct empty without allocation (capacity=0).
	HashTable (const label initialCapacity)
	Construct empty with initial table capacity.
	HashTable (Istream &is)
	Construct from Istream.
	HashTable (const this_type &ht)
	Copy construct.
	HashTable (this_type &&rhs) noexcept
	Move construct.
	HashTable (std::initializer_list< std::pair< Key, T > > list, const bool overwrite=false)
	Construct from key/value pairs in initializer list.
	HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false)
	Construct from key/value pairs.
	~HashTable ()
	Destructor.
bool	empty () const noexcept
	True if the hash table is empty.
label	size () const noexcept
	The number of elements in table.
label	capacity () const noexcept
	The size of the underlying table (the number of buckets).
T &	at (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	at (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
bool	contains (const Key &key) const
	True if hashed key is contained (found) in table.
iterator	find (const Key &key)
	Find and return an iterator set at the hashed entry.
const_iterator	find (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const_iterator	cfind (const Key &key) const
	Find and return an const_iterator set at the hashed entry.
const T &	lookup (const Key &key, const T &deflt) const
	Return hashed entry if it exists, or return the given default.
List< Key >	toc () const
	The table of contents (the keys) in unsorted order.
List< Key >	sortedToc () const
	The table of contents (the keys) in sorted order.
template<class Compare>
List< Key >	sortedToc (const Compare &comp) const
	The table of contents (the keys) sorted according to the specified comparator.
template<class UnaryPredicate>
List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the keys.
template<class UnaryPredicate>
List< Key >	tocValues (const UnaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the unary predicate applied to the values.
template<class BinaryPredicate>
List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const
	The table of contents (the keys) selected according to the binary predicate applied to the keys and values.
UPtrList< const node_type >	csorted () const
	Const access to the hash-table contents in sorted order (sorted by keys).
UPtrList< node_type >	sorted ()
	Non-const access to the hash-table contents in sorted order (sorted by keys).
template<class UnaryPredicate>
label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate.
template<class UnaryPredicate>
label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate.
template<class BinaryPredicate>
label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate.
template<class... Args>
bool	emplace (const Key &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries.
template<class... Args>
bool	emplace_set (const Key &key, Args &&... args)
	Emplace set an entry, overwriting any existing entries.
bool	insert (const Key &key, const T &obj)
	Copy insert a new entry, not overwriting existing entries.
bool	insert (const Key &key, T &&obj)
	Move insert a new entry, not overwriting existing entries.
bool	set (const Key &key, const T &obj)
	Copy assign a new entry, overwriting existing entries.
bool	set (const Key &key, T &&obj)
	Move assign a new entry, overwriting existing entries.
bool	erase (const iterator &iter)
	Erase an entry specified by given iterator.
bool	erase (const Key &key)
	Erase an entry specified by the given key.
template<class AnyType, class AnyHash>
label	erase (const HashTable< AnyType, Key, AnyHash > &other)
	Remove table entries given by keys of the other hash-table.
label	erase (std::initializer_list< Key > keys)
	Remove table entries given by the listed keys.
template<class InputIter>
label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys.
template<unsigned N>
label	erase (const FixedList< Key, N > &keys)
	Remove table entries given by the listed keys.
label	erase (const UList< Key > &keys)
	Remove table entries given by the listed keys.
template<class AnyType, class AnyHash>
label	retain (const HashTable< AnyType, Key, AnyHash > &other)
	Retain table entries given by keys of the other hash-table.
template<class UnaryPredicate>
label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys.
template<class UnaryPredicate>
label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values.
template<class BinaryPredicate>
label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value.
void	clear ()
	Remove all entries from table.
void	clearStorage ()
	Remove all entries from table and the table itself.
void	setCapacity (label newCapacity)
	Change the hash table capacity (number of buckets).
void	resize (label newCapacity)
	Rehash the hash table with new number of buckets. Currently identical to setCapacity().
void	reserve (label numEntries)
	Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table.
void	swap (HashTable< T, Key, Hash > &rhs) noexcept
	Swap contents into this table.
void	transfer (HashTable< T, Key, Hash > &rhs)
	Transfer contents into this table.
void	merge (HashTable< T, Key, Hash > &source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
void	merge (HashTable< T, Key, Hash > &&source)
	Attempts to extract entries from source parameter and insert them into `this`, does not overwrite existing entries. The source will contains any items that could not be merged.
T &	operator[] (const Key &key)
	Find and return a hashed entry. FatalError if it does not exist.
const T &	operator[] (const Key &key) const
	Find and return a hashed entry. FatalError if it does not exist.
T &	operator() (const Key &key)
	Return existing entry or create a new entry.
T &	operator() (const Key &key, const T &deflt)
	Return existing entry or insert a new entry.
void	operator= (const this_type &rhs)
	Copy assign.
void	operator= (std::initializer_list< std::pair< Key, T > > rhs)
	Copy assign from an initializer list.
void	operator= (this_type &&rhs)
	Move assign.
bool	operator== (const this_type &rhs) const
	Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size.
bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation.
this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable.
const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys.
iterator	begin ()
	iterator set to the beginning of the HashTable
const_iterator	begin () const
	const_iterator set to the beginning of the HashTable
const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
iterator	end () noexcept
	iterator to signal the end (for any HashTable)
const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable)
constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable)
Ostream &	printInfo (Ostream &os) const
	Print information.
Ostream &	writeKeys (Ostream &os, const label shortLen=0) const
	Write unordered keys (list), with line-breaks when length exceeds shortLen.
bool	found (const Key &key) const
	Same as contains().
UPtrList< const node_type >	sorted () const
	Deprecated(2023-07) use csorted() method.
template<class Compare>
Foam::List< Key >	sortedToc (const Compare &comp) const
template<class UnaryPredicate>
Foam::List< Key >	tocKeys (const UnaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::List< Key >	tocValues (const UnaryPredicate &pred, const bool invert) const
template<class BinaryPredicate>
Foam::List< Key >	tocEntries (const BinaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const
template<class UnaryPredicate>
Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const
template<class BinaryPredicate>
Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const
template<class InputIter>
Foam::label	erase (InputIter first, InputIter last)
template<unsigned N>
Foam::label	erase (const FixedList< Key, N > &keys)
template<class AnyType, class AnyHash>
Foam::label	erase (const HashTable< AnyType, Key, AnyHash > &other)
template<class AnyType, class AnyHash>
Foam::label	retain (const HashTable< AnyType, Key, AnyHash > &other)
template<class UnaryPredicate>
Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)
template<class UnaryPredicate>
Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)
template<class BinaryPredicate>
Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)
Public Member Functions inherited from HashTableCore
	ClassName ("HashTable")
	Declare type-name (with debug switch).
constexpr	HashTableCore () noexcept=default
	Default construct.

Static Public Member Functions
static fileName	localPath (const polyMesh &mesh, const word &name)
	Name of file set will use.
static IOobject	findIOobject (const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Find IOobject in the polyMesh/sets/ (used as constructor helper).
static IOobject	findIOobject (const polyMesh &mesh, const word &name, IOobjectOption::registerOption reg, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE)
	Find IOobject in the polyMesh/sets/ (used as constructor helper).
static IOobject	findIOobject (const Time &runTime, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER)
	Find IOobject in the polyMesh/sets/ (used as constructor helper).
static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE)
	Return a pointer to a toposet read from file.
static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE)
	Return a pointer to a new toposet of given size.
static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE)
	Return a pointer to a new toposet as copy of another toposet.
template<class Container>
static void	updateMesh (const fileName &instance, const mapPolyMesh &, Container &items)
	Helper: call updateMesh on all items in container (and updates instance).
template<class Container>
static void	setInstance (const fileName &instance, Container &items)
	Helper: set instance on all items in container.
static void	removeFiles (const polyMesh &)
	Helper: remove all sets files from mesh instance.
Static Public Member Functions inherited from regIOobject
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ \| READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.
Static Public Member Functions inherited from HashTableCore
static label	canonicalSize (const label size) noexcept
	Return a canonical (power-of-two) of the requested size.

Static Public Attributes
static int	disallowGenericSets
	Debug switch to disallow the use of generic sets.
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
Static Public Attributes inherited from HashTableCore
static constexpr int32_t	maxTableSize = (1 << (32-3))
	Maximum allowable internal table size (must be a power of two!).

Protected Member Functions
bool	readIOcontents (const word &wantedType, labelHashSet &contents)
	Read into labelHashSet if IOobject flags set. Return true if read.
void	checkLabels (const labelUList &labels, const label maxSize)
	Check limits on addressable range.
void	checkLabels (const labelHashSet &labels, const label maxSize)
	Check limits on addressable range.
virtual void	updateLabels (const labelUList &map)
	Update map from map.
virtual void	check (const label maxSize)
	Check limits on addressable range.
label	writeDebug (Ostream &os, const label maxElem, labelHashSet::const_iterator &iter) const
	Write part of contents nicely formatted.
label	writeDebug (Ostream &os, const pointField &coords, const label maxElem, labelHashSet::const_iterator &iter) const
	Write part of contents nicely formatted.
void	writeDebug (Ostream &os, const pointField &coords, const label maxLen) const
	Write labels and coordinates columnwise to os. Truncate to maxLen.
	topoSet (const topoSet &)=delete
	No copy construct.
Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...
enum	fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp \| inotify) \| (all \| masterOnly). More...
Public Types inherited from IOobjectOption
enum	readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 }
	Enumeration defining read preferences. More...
enum	writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
	Enumeration defining write preferences. More...
enum	registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 }
	Enumeration for use with registerObject(). Values map to bool (false/true). More...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Public Types inherited from HashSet< label, Hash< label > >
typedef HashSet< label, Hash >	this_type
	The template instance used for this HashSet.
typedef HashTable< Foam::zero, label, Hash >	parent_type
	The template instance used for the parent HashTable.
using	iterator
	An iterator, returning reference to the key.
using	const_iterator
	A const_iterator, returning reference to the key.
Public Types inherited from HashTable< T, Key, Hash >
typedef HashTable< T, Key, Hash >	this_type
	The template instance used for this HashTable.
using	node_type
	A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions.
typedef Key	key_type
	The second template parameter, type of keys used.
typedef T	mapped_type
	The first template parameter, type of objects contained.
typedef T	value_type
	Same as mapped_type for OpenFOAM HashTables.
typedef Hash	hasher
	The third template parameter, the hash index method.
typedef T *	pointer
	Pointer type for storing into value_type objects.
typedef T &	reference
	Reference to the stored value_type.
typedef const T *	const_pointer
	Const pointer type for the stored value_type.
typedef const T &	const_reference
	Const reference to the stored value_type.
typedef label	difference_type
	The type to represent the difference between two iterators.
typedef label	size_type
	The type that can represent the size of a HashTable.
using	key_iterator = key_iterator_base<iterator>
	Forward iterator returning the key.
using	const_key_iterator = key_iterator_base<const_iterator>
	Forward const iterator returning the key.
Static Protected Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)
	Helper: write content for FoamFile IOobject header with optional meta information.
static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
	Helper: write dictionary content for FoamFile header with optional meta information.
Static Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Detailed Description

General set of labels of mesh quantity (points, cells, faces).

Source files

Definition at line 59 of file topoSet.H.

Constructor & Destructor Documentation

◆ topoSet() [1/11]

topoSet ( const topoSet & )

protecteddelete

No copy construct.

References topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ topoSet() [2/11]

topoSet	(	const IOobject &	io,
		const word &	wantedType )

Construct from IOobject as explicitly passed type.

Can't use typeName info here since subclasses not yet instantiated

Definition at line 424 of file topoSet.C.

References io, readIOcontents(), and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [3/11]

topoSet	(	const IOobject &	io,
		const Foam::zero	)

Construct empty (no-read) with IOobject information.

Definition at line 432 of file topoSet.C.

References io, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [4/11]

topoSet	(	const IOobject &	io,
		const label	initialCapacity )

Construct empty (no-read) with initial labelHashSet capacity, with IOobject information.

Definition at line 438 of file topoSet.C.

References io, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [5/11]

topoSet	(	const IOobject &	io,
		const labelHashSet &	labels )

Copy construct (no-read) from labelHashSet, with IOobject information.

Definition at line 445 of file topoSet.C.

References io, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [6/11]

topoSet	(	const IOobject &	io,
		labelHashSet &&	labels )

Move construct (no-read) from labelHashSet, with IOobject information.

Definition at line 452 of file topoSet.C.

References io, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [7/11]

topoSet	(	const polyMesh &	mesh,
		const word &	wantedType,
		const word &	name,
		IOobjectOption::readOption	rOpt = IOobjectOption::MUST_READ,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

Construct from polyMesh and name.

Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().

Definition at line 459 of file topoSet.C.

References findIOobject(), mesh, IOobject::name(), readIOcontents(), and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [8/11]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const label	initialCapacity,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

Construct empty (no-read) with initial labelHashSet capacity.

Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().

Definition at line 475 of file topoSet.C.

References findIOobject(), mesh, IOobject::name(), IOobjectOption::NO_READ, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [9/11]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const labelHashSet &	labels,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

Copy construct (no-read) from labelHashSet.

Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().

Definition at line 489 of file topoSet.C.

References findIOobject(), mesh, IOobject::name(), IOobjectOption::NO_READ, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [10/11]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		labelHashSet &&	labels,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

Move construct (no-read) from labelHashSet.

Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().

Definition at line 503 of file topoSet.C.

References findIOobject(), mesh, IOobject::name(), IOobjectOption::NO_READ, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ topoSet() [11/11]

topoSet	(	const polyMesh &	mesh,
		const word &	name,
		const labelUList &	labels,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

Copy construct (no-read) from list of labels.

Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().

Definition at line 517 of file topoSet.C.

References findIOobject(), mesh, IOobject::name(), IOobjectOption::NO_READ, and regIOobject::regIOobject().

Here is the call graph for this function:

◆ ~topoSet()

virtual ~topoSet ( )

virtualdefault

Destructor.

References mesh, os(), set(), and topoSet().

Here is the call graph for this function:

Member Function Documentation

◆ readIOcontents()

bool readIOcontents	(	const word &	wantedType,
		labelHashSet &	contents )

protected

Read into labelHashSet if IOobject flags set. Return true if read.

Definition at line 138 of file topoSet.C.

References regIOobject::close(), IOstream::good(), regIOobject::headerOk(), IOobjectOption::isReadOptional(), and IOobjectOption::isReadRequired().

Referenced by topoSet(), and topoSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkLabels() [1/2]

void checkLabels	(	const labelUList &	labels,
		const label	maxSize )

protected

Check limits on addressable range.

Definition at line 220 of file topoSet.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, maxSize(), name, Foam::nl, and Foam::type().

Referenced by check().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkLabels() [2/2]

void checkLabels	(	const labelHashSet &	labels,
		const label	maxSize )

protected

Check limits on addressable range.

Definition at line 236 of file topoSet.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, maxSize(), name, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ updateLabels()

void updateLabels ( const labelUList & map )

protectedvirtual

Update map from map.

Used to update cell/face labels after morphing

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 164 of file topoSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, name, Foam::nl, HashSet< Key, Hash >::set(), HashTable< T, Key, Hash >::size(), UList< T >::size(), HashTable< T, Key, Hash >::transfer(), and Foam::type().

Referenced by cellSet::updateMesh(), faceSet::updateMesh(), and pointSet::updateMesh().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ check()

void check ( const label maxSize )

protectedvirtual

Check limits on addressable range.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 252 of file topoSet.C.

References checkLabels(), and maxSize().

Referenced by cellSet::cellSet(), cellZoneSet::cellZoneSet(), faceSet::faceSet(), faceZoneSet::faceZoneSet(), pointSet::pointSet(), and pointZoneSet::pointZoneSet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDebug() [1/5]

Foam::label writeDebug	(	Ostream &	os,
		const label	maxElem,
		labelHashSet::const_iterator &	iter ) const

protected

Write part of contents nicely formatted.

Prints labels only.

Returns: number of labels written

Definition at line 259 of file topoSet.C.

References HashSet< label, Hash< label > >::cend(), n, Foam::nl, and os().

Referenced by cellBitSet::writeDebug(), cellSet::writeDebug(), faceBitSet::writeDebug(), faceBoolSet::writeDebug(), faceSet::writeDebug(), pointBitSet::writeDebug(), pointSet::writeDebug(), writeDebug(), and writeDebug().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeDebug() [2/5]

Foam::label writeDebug	(	Ostream &	os,
		const pointField &	coords,
		const label	maxElem,
		labelHashSet::const_iterator &	iter ) const

protected

Write part of contents nicely formatted.

Prints label and corresponding coordinate.

Returns: number of labels written

Definition at line 284 of file topoSet.C.

References HashSet< label, Hash< label > >::cend(), n, Foam::nl, and os().

Here is the call graph for this function:

◆ writeDebug() [3/5]

void writeDebug	(	Ostream &	os,
		const pointField &	coords,
		const label	maxLen ) const

protected

Write labels and coordinates columnwise to os. Truncate to maxLen.

Definition at line 309 of file topoSet.C.

References HashSet< label, Hash< label > >::cbegin(), Foam::endl(), boundBox::max(), boundBox::min(), n, Foam::nl, os(), HashTable< T, Key, Hash >::size(), HashTable< T, Key, Hash >::toc(), and writeDebug().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "topoSet" )

Runtime type information.

◆ localPath()

Foam::fileName localPath	(	const polyMesh &	mesh,
		const word &	name )

static

Name of file set will use.

Definition at line 126 of file topoSet.C.

References mesh, and IOobject::name().

Here is the call graph for this function:

◆ findIOobject() [1/3]

Foam::IOobject findIOobject	(	const polyMesh &	mesh,
		const word &	name,
		IOobjectOption::readOption	rOpt = IOobjectOption::MUST_READ,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

static

Find IOobject in the polyMesh/sets/ (used as constructor helper).

Definition at line 351 of file topoSet.C.

References DebugInfo, disallowGenericSets, Foam::endl(), io, mesh, polyMesh::meshSubDir, IOobject::name(), IOobjectOption::NO_READ, word::null, IOobjectOption::READ_IF_PRESENT, and topoSet().

Referenced by cellSet::cellSet(), cellSet::cellSet(), cellSet::cellSet(), findIOobject(), fvExprDriver::getTopoSetLabels(), cellSet::readContents(), faceSet::readContents(), pointSet::readContents(), topoSet(), topoSet(), topoSet(), topoSet(), topoSet(), and fvExprDriver::topoSetType().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findIOobject() [2/3]

IOobject findIOobject	(	const polyMesh &	mesh,
		const word &	name,
		IOobjectOption::registerOption	reg,
		IOobjectOption::readOption	rOpt = IOobjectOption::MUST_READ,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE )

inlinestatic

Find IOobject in the polyMesh/sets/ (used as constructor helper).

Definition at line 173 of file topoSet.H.

References findIOobject(), mesh, IOobjectOption::MUST_READ, IOobject::name(), and IOobjectOption::NO_WRITE.

Here is the call graph for this function:

◆ findIOobject() [3/3]

Foam::IOobject findIOobject	(	const Time &	runTime,
		const word &	name,
		IOobjectOption::readOption	rOpt = IOobjectOption::MUST_READ,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE,
		IOobjectOption::registerOption	reg = IOobjectOption::LEGACY_REGISTER )

static

Find IOobject in the polyMesh/sets/ (used as constructor helper).

Definition at line 387 of file topoSet.C.

References polyMesh::meshSubDir, IOobjectOption::MUST_READ, IOobject::name(), word::null, IOobjectOption::READ_IF_PRESENT, and runTime.

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [1/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		word	,
		(const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)	,
		(mesh, name, rOpt, wOpt)	)

References mesh, IOobject::name(), and topoSet().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [2/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		size	,
		(const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt)	,
		(mesh, name, size, wOpt)	)

References mesh, IOobject::name(), HashTable< T, Key, Hash >::size(), and topoSet().

Here is the call graph for this function:

◆ declareRunTimeSelectionTable() [3/3]

declareRunTimeSelectionTable	(	autoPtr	,
		topoSet	,
		set	,
		(const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt)	,
		(mesh, name, set, wOpt)	)

References io, IOobjectOption::LEGACY_REGISTER, mesh, IOobjectOption::MUST_READ, IOobject::name(), IOobjectOption::NO_WRITE, set(), and topoSet().

Here is the call graph for this function:

◆ clone()

autoPtr< topoSet > clone ( ) const

inline

Clone.

Definition at line 358 of file topoSet.H.

References NotImplemented.

◆ New() [1/3]

Foam::autoPtr< Foam::topoSet > New	(	const word &	setType,
		const polyMesh &	mesh,
		const word &	name,
		IOobjectOption::readOption	rOpt = IOobjectOption::MUST_READ,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE )

static

Return a pointer to a toposet read from file.

Definition at line 47 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and IOobject::name().

Here is the call graph for this function:

◆ New() [2/3]

Foam::autoPtr< Foam::topoSet > New	(	const word &	setType,
		const polyMesh &	mesh,
		const word &	name,
		const label	size,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE )

static

Return a pointer to a new toposet of given size.

Definition at line 73 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, IOobject::name(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ New() [3/3]

Foam::autoPtr< Foam::topoSet > New	(	const word &	setType,
		const polyMesh &	mesh,
		const word &	name,
		const topoSet &	set,
		IOobjectOption::writeOption	wOpt = IOobjectOption::NO_WRITE )

static

Return a pointer to a new toposet as copy of another toposet.

Definition at line 99 of file topoSet.C.

References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, IOobject::name(), set(), and topoSet().

Here is the call graph for this function:

◆ contains()

bool contains ( const label id ) const

virtual

Has the given index?

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 533 of file topoSet.C.

Referenced by faceZoneSet::invert().

Here is the caller graph for this function:

◆ found()

bool found ( const label id ) const

virtual

Has the given index?

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 539 of file topoSet.C.

Referenced by cellToFaceZone::applyToSet(), faceZoneToFaceZone::applyToSet(), searchableSurfaceToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), setToCellZone::applyToSet(), setToFaceZone::applyToSet(), setToPointZone::applyToSet(), polyMeshFilter::filter(), meshRefinement::mergePatchFacesUndo(), and meshRefinement::splitFacesUndo().

Here is the caller graph for this function:

◆ set() [1/2]

bool set ( const label id )

virtual

Set an index.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 545 of file topoSet.C.

Referenced by cellZoneSet::addSet(), faceZoneSet::addSet(), pointZoneSet::addSet(), addSet(), cellSet::cellSet(), cellZoneSet::cellZoneSet(), declareRunTimeSelectionTable(), deleteSet(), faceSet::faceSet(), faceZoneSet::faceZoneSet(), New(), pointSet::pointSet(), pointZoneSet::pointZoneSet(), cellZoneSet::subset(), faceZoneSet::subset(), pointZoneSet::subset(), subset(), cellZoneSet::subtractSet(), cellZoneSet::subtractSet(), faceZoneSet::subtractSet(), pointZoneSet::subtractSet(), pointZoneSet::subtractSet(), subtractSet(), faceZoneSet::sync(), cellZoneSet::TypeNameNoDebug(), faceZoneSet::TypeNameNoDebug(), pointZoneSet::TypeNameNoDebug(), cellZoneSet::updateSet(), faceZoneSet::updateSet(), pointZoneSet::updateSet(), and ~topoSet().

Here is the caller graph for this function:

◆ unset() [1/2]

bool unset ( const label id )

virtual

Unset an index.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 551 of file topoSet.C.

◆ set() [2/2]

void set ( const labelUList & labels )

virtual

Set multiple indices.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 557 of file topoSet.C.

◆ unset() [2/2]

void unset ( const labelUList & labels )

virtual

Unset multiple indices.

Reimplemented in topoBitSet, and topoBoolSet.

Definition at line 563 of file topoSet.C.

◆ invert()

void invert ( const label maxLen )

virtual

Invert contents.

Insert all members [0,maxLen) which were not in set.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 569 of file topoSet.C.

References clear(), HashTable< T, Key, Hash >::contains(), Foam::max(), reserve(), HashSet< label, Hash< label > >::set(), and HashTable< T, Key, Hash >::size().

Here is the call graph for this function:

◆ subset() [1/2]

void subset ( const labelUList & elems )

virtual

Subset contents. Only elements present in both sets remain.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 597 of file topoSet.C.

References Foam::min(), DynamicList< T, SizeMin >::push_back(), and UList< T >::size().

Here is the call graph for this function:

◆ subset() [2/2]

void subset ( const topoSet & set )

virtual

Subset contents. Only elements present in both sets remain.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 590 of file topoSet.C.

References set(), and topoSet().

Here is the call graph for this function:

◆ addSet() [1/2]

void addSet ( const labelUList & elems )

virtual

Add given elements to the set.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 625 of file topoSet.C.

◆ addSet() [2/2]

void addSet ( const topoSet & set )

virtual

Add given elements to the set.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 618 of file topoSet.C.

References set(), and topoSet().

Here is the call graph for this function:

◆ subtractSet() [1/2]

void subtractSet ( const labelUList & elems )

virtual

Subtract given elements from the set.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 639 of file topoSet.C.

Referenced by deleteSet().

Here is the caller graph for this function:

◆ subtractSet() [2/2]

void subtractSet ( const topoSet & set )

virtual

Subtract given elements from the set.

Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.

Definition at line 632 of file topoSet.C.

References set(), and topoSet().

Here is the call graph for this function:

◆ sync()

void sync ( const polyMesh & mesh )

virtual

Sync set across coupled patches.

Reimplemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.

Definition at line 646 of file topoSet.C.

References NotImplemented.

◆ writeDebug() [4/5]

void writeDebug	(	Ostream &	os,
		const label	maxLen ) const

virtual

Write labels columnwise to os. Truncate to maxLen.

Definition at line 652 of file topoSet.C.

References HashSet< label, Hash< label > >::cbegin(), Foam::endl(), n, Foam::nl, os(), HashTable< T, Key, Hash >::size(), and writeDebug().

Here is the call graph for this function:

◆ writeDebug() [5/5]

virtual void writeDebug	(	Ostream &	os,
		const primitiveMesh &	,
		const label	maxLen ) const

pure virtual

Like above but also writes mesh related quantity (usually coordinate).

Implemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.

References os().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write contents.

Implements regIOobject.

Definition at line 681 of file topoSet.C.

References os().

Here is the call graph for this function:

◆ updateMesh() [1/2]

void updateMesh ( const mapPolyMesh & morphMap )

virtual

Update any stored data for new labels. Not implemented.

Reimplemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.

Definition at line 687 of file topoSet.C.

References NotImplemented.

◆ distribute()

virtual void distribute ( const mapDistributePolyMesh & )

pure virtual

Update any stored data for mesh redistribution.

Implemented in cellBitSet, cellSet, faceBitSet, faceBoolSet, faceSet, pointBitSet, and pointSet.

◆ maxSize()

virtual label maxSize ( const polyMesh & mesh ) const

pure virtual

Return max allowable index (+1). Not implemented.

Implemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.

References IOobject::instance(), mesh, and topoSet().

Referenced by topoBitSet::check(), topoBoolSet::check(), check(), checkLabels(), and checkLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMesh() [2/2]

template<class Container>

void updateMesh	(	const fileName &	instance,
		const mapPolyMesh &	map,
		Container &	items )

static

Helper: call updateMesh on all items in container (and updates instance).

Definition at line 38 of file topoSetTemplates.C.

References IOobject::instance().

Here is the call graph for this function:

◆ setInstance()

template<class Container>

void setInstance	(	const fileName &	instance,
		Container &	items )

static

Helper: set instance on all items in container.

Definition at line 24 of file topoSetTemplates.C.

References IOobject::instance().

Here is the call graph for this function:

◆ removeFiles()

void removeFiles ( const polyMesh & mesh )

static

Helper: remove all sets files from mesh instance.

Definition at line 693 of file topoSet.C.

References DebugVar, io, Foam::isDir(), mesh, polyMesh::meshSubDir, and Foam::rmDir().

Here is the call graph for this function:

◆ operator=()

void operator= ( const topoSet & rhs )

Copy labelHashSet part only.

Definition at line 715 of file topoSet.C.

References HashSet< label, Hash< label > >::operator=(), Foam::rhs(), and topoSet().

Here is the call graph for this function:

◆ deleteSet()

virtual void deleteSet ( const topoSet & set )

inlinevirtual

Deprecated(2018-10) subtract elements present in set.

Deprecated: (2018-10) - use subtractSet instead

Definition at line 565 of file topoSet.H.

References deleteSet(), set(), subtractSet(), and topoSet().

Referenced by deleteSet().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ disallowGenericSets

int disallowGenericSets

static

Debug switch to disallow the use of generic sets.

Definition at line 151 of file topoSet.H.

Referenced by columnFvMeshInfo::columnFvMeshInfo(), and findIOobject().

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

src/meshTools/topoSet/topoSets/topoSet.H
src/meshTools/topoSet/topoSets/topoSet.C
src/meshTools/topoSet/topoSets/topoSetTemplates.C

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ topoSet() [1/11]

◆ topoSet() [2/11]

◆ topoSet() [3/11]

◆ topoSet() [4/11]

◆ topoSet() [5/11]

◆ topoSet() [6/11]

◆ topoSet() [7/11]

◆ topoSet() [8/11]

◆ topoSet() [9/11]

◆ topoSet() [10/11]

◆ topoSet() [11/11]

◆ ~topoSet()

Member Function Documentation

◆ readIOcontents()

◆ checkLabels() [1/2]

◆ checkLabels() [2/2]

◆ updateLabels()

◆ check()

◆ writeDebug() [1/5]

◆ writeDebug() [2/5]

◆ writeDebug() [3/5]

◆ TypeName()

◆ localPath()

◆ findIOobject() [1/3]

◆ findIOobject() [2/3]

◆ findIOobject() [3/3]

◆ declareRunTimeSelectionTable() [1/3]

◆ declareRunTimeSelectionTable() [2/3]

◆ declareRunTimeSelectionTable() [3/3]

◆ clone()

◆ New() [1/3]

◆ New() [2/3]

◆ New() [3/3]

◆ contains()

◆ found()

◆ set() [1/2]

◆ unset() [1/2]

◆ set() [2/2]

◆ unset() [2/2]

◆ invert()

◆ subset() [1/2]

◆ subset() [2/2]

◆ addSet() [1/2]

◆ addSet() [2/2]

◆ subtractSet() [1/2]

◆ subtractSet() [2/2]

◆ sync()

◆ writeDebug() [4/5]

◆ writeDebug() [5/5]

◆ writeData()

◆ updateMesh() [1/2]

◆ distribute()

◆ maxSize()

◆ updateMesh() [2/2]

◆ setInstance()

◆ removeFiles()

◆ operator=()

◆ deleteSet()

Member Data Documentation

◆ disallowGenericSets