Base for a special purpose topoSet using labels stored as a bitSet. More...

Inheritance diagram for topoBitSet:

Collaboration diagram for topoBitSet:

Public Member Functions
virtual	~topoBitSet ()=default
	Destructor. More...

const bitSet &	addressing () const
	Return the bitSet. More...

bitSet &	addressing ()
	Access the bitSet. More...

void	reset ()
	Set values to false, leaving the size untouched. More...

virtual bool	found (const label id) const
	Has the given index? More...

virtual bool	set (const label id)
	Set an index. More...

virtual bool	unset (const label id)
	Unset an index. More...

virtual void	set (const labelUList &labels)
	Set multiple indices. More...

virtual void	unset (const labelUList &labels)
	Unset multiple indices. More...

virtual void	invert (const label maxLen)
	Invert contents. More...

virtual void	subset (const topoSet &set)
	Subset contents. Only elements present in both sets remain. More...

virtual void	addSet (const topoSet &set)
	Add elements present in set. More...

virtual void	subtractSet (const topoSet &set)
	Subtract elements present in set. More...

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

	declareRunTimeSelectionTable (autoPtr, topoSet, word,(const polyMesh &mesh, const word &name, readOption r, writeOption w),(mesh, name, r, w))

	declareRunTimeSelectionTable (autoPtr, topoSet, size,(const polyMesh &mesh, const word &name, const label size, writeOption w),(mesh, name, size, w))

	declareRunTimeSelectionTable (autoPtr, topoSet, set,(const polyMesh &mesh, const word &name, const topoSet &set, writeOption w),(mesh, name, set, w))

	topoSet (const IOobject &obj, const word &wantedType)
	Construct from IOobject as explicitly passed type. More...

	topoSet (const polyMesh &mesh, const word &wantedType, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Construct from polyMesh and name. More...

	topoSet (const polyMesh &mesh, const word &name, const label size, writeOption w=NO_WRITE)
	Construct empty from additional size of labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, writeOption w=NO_WRITE)
	Construct (no-read) with copy of labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, writeOption w=NO_WRITE)
	Construct (no-read) with moving labelHashSet. More...

	topoSet (const polyMesh &mesh, const word &name, const labelUList &labels, writeOption w=NO_WRITE)
	Construct (no-read) with copy of labels. More...

	topoSet (const IOobject &io, const label size)
	Construct empty from IOobject and HashSet size. More...

	topoSet (const IOobject &io, const labelHashSet &labels)
	Construct from IOobject and copy of labelHashSet. More...

	topoSet (const IOobject &io, labelHashSet &&labels)
	Construct from IOobject and move labelHashSet. More...

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

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

virtual void	sync (const polyMesh &mesh)
	Sync set across coupled patches. More...

virtual void	writeDebug (Ostream &os, const label maxLen) const
	Write labels columnwise to os. Truncate to maxLen. More...

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

virtual bool	writeData (Ostream &) const
	Write contents. More...

virtual void	updateMesh (const mapPolyMesh &morphMap)
	Update any stored data for new labels. Not implemented. More...

virtual void	distribute (const mapDistributePolyMesh &)=0
	Update any stored data for mesh redistribution. More...

virtual label	maxSize (const polyMesh &mesh) const =0
	Return max allowable index (+1). Not implemented. More...

void	operator= (const topoSet &)
	Copy labelHashSet part only. More...

virtual void	deleteSet (const topoSet &set)
	Deprecated(2018-10) subtract elements present in set. More...

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

	regIOobject (const IOobject &io, const bool isTime=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	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

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

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

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

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

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

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

void	setUpToDate ()
	Set as up-to-date. More...

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

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

bool	headerOk ()
	Read and check header info. 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
	Return file-monitoring handles. More...

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

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) 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 (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::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 r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

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

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, 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...

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

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

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

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

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

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

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

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

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

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

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

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

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

unsigned	labelByteSize () const
	The label byte-size, possibly read from the header. More...

unsigned	scalarByteSize () const
	The scalar byte-size, possibly read from the header. More...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

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

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

readOption &	readOpt ()
	Non-constant access to the read option. More...

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

writeOption &	writeOpt ()
	Non-constant access to the write option. 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

const fileName &	caseName () const

const fileName &	instance () const

fileName &	instance ()

const fileName &	local () const

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

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

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

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

bool	good () const

bool	bad () const

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

void	operator= (const IOobject &io)

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

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

template<class StringType >
Foam::word	scopedName (StringType scope, const word &name)

Public Member Functions inherited from HashSet< label, Hash< label > >
Foam::label	assignMany (const label nItems, InputIter first, InputIter last)

	HashSet ()
	Default construct with default (128) table capacity. More...

	HashSet (const this_type &rhs)
	Copy construct. More...

	HashSet (this_type &&rhs)
	Move construct. More...

	HashSet (const label size)
	Construct given initial table capacity. More...

	HashSet (Istream &is)
	Construct from Istream with default table capacity. More...

	HashSet (const FixedList< label, N > &list)
	Construct from FixedList of Key. More...

	HashSet (const UList< label > &list)
	Construct from UList of Key. More...

	HashSet (const IndirectListBase< label, Addr > &list)
	Construct from an indirect list. More...

	HashSet (std::initializer_list< label > list)
	Construct from an initializer list of Key. More...

	HashSet (const HashTable< AnyType, label, AnyHash > &tbl)

bool	test (const label &key) const noexcept
	Same as found() - return true if key exists in the set. More...

bool	insert (const label &key)
	Insert a new entry, not overwriting existing entries. More...

label	insert (InputIter first, InputIter last)
	Insert keys from the input iterator range. More...

label	insert (std::initializer_list< label > list)
	Insert keys from a initializer list of Key. More...

label	insert (const FixedList< label, N > &list)
	Insert keys from the list of Key. More...

label	insert (const UList< label > &list)
	Insert keys from the list of Key. More...

label	insert (const IndirectListBase< label, Addr > &list)
	Insert keys from the list of Key. More...

Foam::label	insert (InputIter first, InputIter last)

Foam::label	insert (const FixedList< label, N > &list)

Foam::label	insert (const IndirectListBase< label, Addr > &list)

bool	set (const label &key)
	Same as insert (no value to overwrite) More...

label	set (InputIter first, InputIter last)
	Same as insert (no value to overwrite) More...

label	set (std::initializer_list< label > list)
	Same as insert (no value to overwrite) More...

label	set (const FixedList< label, N > &list)
	Same as insert (no value to overwrite) More...

label	set (const UList< label > &list)
	Same as insert (no value to overwrite) More...

label	set (const IndirectListBase< label, Addr > &list)
	Same as insert (no value to overwrite) More...

bool	unset (const label &key)
	Unset the specified key - same as erase. More...

label	unset (InputIter first, InputIter last)
	Unset the keys listed in the input iterator range. More...

label	unset (std::initializer_list< label > list)
	Unset the listed keys - same as erase. More...

label	unset (const FixedList< label, N > &list)
	Unset the listed keys - same as erase. More...

label	unset (const UList< label > &list)
	Unset the listed keys - same as erase. More...

label	unset (const IndirectListBase< label, Addr > &list)
	Unset the listed keys - same as erase. More...

Foam::label	unset (InputIter first, InputIter last)

Foam::label	unset (const FixedList< label, N > &list)

Foam::label	unset (const IndirectListBase< label, Addr > &list)

label	setMany (InputIter first, InputIter last)
	Same as insert (no value to overwrite) More...

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

bool	operator() (const label &key) const noexcept
	Return true if the entry exists, same as found() More...

bool	operator[] (const label &key) const noexcept
	Return true if the entry exists, same as found(). More...

void	operator= (const this_type &rhs)
	Copy assignment. More...

void	operator= (this_type &&rhs)
	Move assignment. More...

void	operator= (const UList< label > &rhs)
	Assignment from a UList of keys. More...

void	operator= (const FixedList< label, N > &rhs)
	Assignment from a FixedList of keys. More...

void	operator= (std::initializer_list< label > rhs)
	Assignment from an initializer list of keys. More...

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

this_type &	operator\|= (const this_type &rhs)
	Add entries to this HashSet. More...

this_type &	operator&= (const this_type &rhs)
	Only retain entries found in both HashSets. More...

this_type &	operator^= (const this_type &rhs)
	Only retain unique entries (xor) More...

this_type &	operator+= (const this_type &rhs)
	Add entries to this HashSet. Same as the '\|=' operator. More...

this_type &	operator-= (const this_type &rhs)
	Remove entries from this HashSet. Uses erase() More...

List< label >	tocValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

List< label >	tocEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

label	countValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

label	countEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

label	filterValues (const UnaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

label	filterEntries (const BinaryPredicate &, const bool)=delete
	Not applicable for HashSet. More...

Public Member Functions inherited from HashTable< zero::null, label, Hash< label > >
	HashTable ()
	Default construct with default (128) table capacity. More...

	HashTable (const label size)
	Construct given initial table capacity. More...

	HashTable (Istream &is, const label size=128)
	Construct from Istream with default table capacity. More...

	HashTable (const this_type &ht)
	Copy construct. More...

	HashTable (this_type &&rhs)
	Move construct. More...

	HashTable (std::initializer_list< std::pair< label, zero::null >> list)
	Construct from an initializer list. More...

	~HashTable ()
	Destructor. More...

label	capacity () const noexcept
	The size of the underlying table. More...

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

bool	empty () const noexcept
	True if the hash table is empty. More...

zero::null &	at (const label &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const zero::null &	at (const label &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

bool	found (const label &key) const
	Return true if hashed entry is found in table. More...

iterator	find (const label &key)
	Find and return an iterator set at the hashed entry. More...

const_iterator	find (const label &key) const
	Find and return an const_iterator set at the hashed entry. More...

const_iterator	cfind (const label &key) const
	Find and return an const_iterator set at the hashed entry. More...

const zero::null &	lookup (const label &key, const zero::null &deflt) const
	Return hashed entry if it exists, or return the given default. More...

List< label >	toc () const
	The table of contents (the keys) in unsorted order. More...

List< label >	sortedToc () const
	The table of contents (the keys) in sorted order. More...

List< label >	sortedToc (const Compare &comp) const

Foam::List< label >	sortedToc (const Compare &comp) const

List< label >	tocKeys (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< label >	tocKeys (const UnaryPredicate &pred, const bool invert) const

List< label >	tocValues (const UnaryPredicate &pred, const bool invert=false) const

Foam::List< label >	tocValues (const UnaryPredicate &pred, const bool invert) const

List< label >	tocEntries (const BinaryPredicate &pred, const bool invert=false) const

Foam::List< label >	tocEntries (const BinaryPredicate &pred, const bool invert) const

label	countKeys (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of keys that satisfy the unary predicate. More...

Foam::label	countKeys (const UnaryPredicate &pred, const bool invert) const

label	countValues (const UnaryPredicate &pred, const bool invert=false) const
	Count the number of values that satisfy the unary predicate. More...

Foam::label	countValues (const UnaryPredicate &pred, const bool invert) const

label	countEntries (const BinaryPredicate &pred, const bool invert=false) const
	Count the number of entries that satisfy the binary predicate. More...

Foam::label	countEntries (const BinaryPredicate &pred, const bool invert) const

bool	emplace (const label &key, Args &&... args)
	Emplace insert a new entry, not overwriting existing entries. More...

bool	insert (const label &key, const zero::null &obj)
	Copy insert a new entry, not overwriting existing entries. More...

bool	insert (const label &key, zero::null &&obj)
	Move insert a new entry, not overwriting existing entries. More...

bool	set (const label &key, const zero::null &obj)
	Copy assign a new entry, overwriting existing entries. More...

bool	set (const label &key, zero::null &&obj)
	Move assign a new entry, overwriting existing entries. More...

bool	erase (const iterator &iter)
	Erase an entry specified by given iterator. More...

bool	erase (const label &key)
	Erase an entry specified by the given key. More...

label	erase (const HashTable< AnyType, label, AnyHash > &other)
	Remove table entries given by keys of the other hash-table. More...

label	erase (std::initializer_list< label > keys)
	Remove table entries given by the listed keys. More...

label	erase (InputIter first, InputIter last)
	Remove multiple entries using an iterator range of keys. More...

label	erase (const FixedList< label, N > &keys)
	Remove table entries given by the listed keys. More...

label	erase (const UList< label > &keys)
	Remove table entries given by the listed keys. More...

Foam::label	erase (InputIter first, InputIter last)

Foam::label	erase (const FixedList< label, N > &keys)

Foam::label	erase (const HashTable< AnyType, label, AnyHash > &other)

label	retain (const HashTable< AnyType, label, AnyHash > &other)
	Retain table entries given by keys of the other hash-table. More...

Foam::label	retain (const HashTable< AnyType, label, AnyHash > &other)

label	filterKeys (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their keys. More...

Foam::label	filterKeys (const UnaryPredicate &pred, const bool pruning)

label	filterValues (const UnaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their values. More...

Foam::label	filterValues (const UnaryPredicate &pred, const bool pruning)

label	filterEntries (const BinaryPredicate &pred, const bool pruning=false)
	Generalized means to filter table entries based on their key/value. More...

Foam::label	filterEntries (const BinaryPredicate &pred, const bool pruning)

void	resize (const label sz)
	Resize the hash table for efficiency. More...

void	clear ()
	Clear all entries from table. More...

void	clearStorage ()
	Clear the table entries and the table itself. More...

void	swap (HashTable< zero::null, label, Hash< label > > &rhs)
	Swap contents into this table. More...

void	transfer (HashTable< zero::null, label, Hash< label > > &rhs)
	Transfer contents into this table. More...

zero::null &	operator[] (const label &key)
	Find and return a hashed entry. FatalError if it does not exist. More...

const zero::null &	operator[] (const label &key) const
	Find and return a hashed entry. FatalError if it does not exist. More...

zero::null &	operator() (const label &key)
	Return existing entry or create a new entry. More...

zero::null &	operator() (const label &key, const zero::null &deflt)
	Return existing entry or insert a new entry. More...

void	operator= (const this_type &rhs)
	Copy assign. More...

void	operator= (std::initializer_list< std::pair< label, zero::null >> rhs)
	Copy assign from an initializer list. More...

void	operator= (this_type &&rhs)
	Move assign. More...

bool	operator== (const this_type &rhs) const

bool	operator!= (const this_type &rhs) const
	The opposite of the equality operation. More...

this_type &	operator+= (const this_type &rhs)
	Add entries into this HashTable. More...

const_iterator_pair< const_key_iterator, this_type >	keys () const
	A const iterator begin/end pair for iterating over keys. More...

iterator	begin ()
	iterator set to the beginning of the HashTable More...

const_iterator	begin () const
	const_iterator set to the beginning of the HashTable More...

const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable More...

iterator	end () noexcept
	iterator to signal the end (for any HashTable) More...

const_iterator	end () const noexcept
	const_iterator to signal the end (for any HashTable) More...

constexpr const_iterator	cend () const noexcept
	const_iterator to signal the end (for any HashTable) More...

Ostream &	printInfo (Ostream &os) const
	Print information. More...

Ostream &	writeKeys (Ostream &os, const label shortLen=0) const

Protected Member Functions
virtual void	updateLabels (const labelUList &map)
	Update map from map. More...

virtual void	check (const label maxSize)
	Check limits on addressable range. More...

	topoBitSet (const polyMesh &mesh, const word &setName)
	Construct with empty selection. More...

	topoBitSet (const polyMesh &mesh, const word &setName, const label size, const bool val)
	Construct with size elements. More...

	topoBitSet (const polyMesh &mesh, const word &setName, const label size, const bitSet &bits)
	Copy construct with bitset values, size elements. More...

	topoBitSet (const polyMesh &mesh, const word &setName, const label size, bitSet &&bits)
	Move construct with bitset values, size elements. More...

Protected Member Functions inherited from topoSet
void	writeDebug (Ostream &os, const label maxElem, topoSet::const_iterator &iter, label &elemI) const
	Write part of contents nicely formatted. Prints labels only. More...

void	writeDebug (Ostream &os, const pointField &coords, const label maxElem, topoSet::const_iterator &iter, label &elemI) const
	Write part of contents nicely formatted. Prints label. More...

void	writeDebug (Ostream &os, const pointField &coords, const label maxLen) const
	Write labels and coordinates columnwise to os. Truncate to maxLen. More...

	topoSet (const topoSet &)=delete
	No copy construct. More...

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

Istream *	objectStream ()
	Construct and return an IFstream for the object. More...

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

Protected Member Functions inherited from HashTable< zero::null, label, Hash< label > >
bool	iterator_erase (node_type *&entry, label &index)
	Low-level entry erasure using iterator internals. More...

Protected Attributes
bitSet	selected_

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

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

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

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

Public Types inherited from HashSet< label, Hash< label > >
typedef HashSet< label, Hash< label > >	this_type
	The template instance used for this HashSet. More...

typedef HashTable< zero::null, label, Hash< label > >	parent_type
	The template instance used for the parent HashTable. More...

using	iterator = typename parent_type::key_iterator
	An iterator, returning reference to the key. More...

using	const_iterator = typename parent_type::const_key_iterator
	A const_iterator, returning reference to the key. More...

Public Types inherited from HashTable< zero::null, label, Hash< label > >
typedef HashTable< zero::null, label, Hash< label > >	this_type
	The template instance used for this HashTable. More...

typedef label	key_type
	The second template parameter, type of keys used. More...

typedef zero::null	mapped_type
	The first template parameter, type of objects contained. More...

typedef zero::null	value_type
	Same as mapped_type for OpenFOAM HashTables. More...

typedef Hash< label >	hasher
	The third template parameter, the hash index method. More...

typedef zero::null *	pointer
	Pointer type for storing into value_type objects. More...

typedef zero::null &	reference
	Reference to the stored value_type. More...

typedef label	difference_type
	The type to represent the difference between two iterators. More...

typedef label	size_type
	The type that can represent the size of a HashTable. More...

using	key_iterator = key_iterator_base< iterator >
	Forward iterator returning the key. More...

using	const_key_iterator = key_iterator_base< const_iterator >
	Forward const iterator returning the key. More...

Static Public Member Functions inherited from topoSet
static fileName	localPath (const polyMesh &mesh, const word &name)
	Name of file set will use. More...

static IOobject	findIOobject (const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Find IOobject in the polyMesh/sets (used as constructor helper) More...

static IOobject	findIOobject (const Time &runTime, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Find IOobject in the polyMesh/sets (used as constructor helper) More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
	Return a pointer to a toposet read from file. More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const label size, writeOption w=NO_WRITE)
	Return a pointer to a new toposet of given size. More...

static autoPtr< topoSet >	New (const word &setType, const polyMesh &mesh, const word &name, const topoSet &set, writeOption w=NO_WRITE)
	Return a pointer to a new toposet as copy of another toposet. More...

template<class Container >
static void	updateMesh (const fileName &instance, const mapPolyMesh &, Container &)
	Helper: call updateMesh on all sets in container (and. More...

template<class Container >
static void	setInstance (const fileName &instance, Container &)
	Helper: set instance on all sets in container. More...

static void	removeFiles (const polyMesh &)
	Helper: remove all sets files from mesh instance. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)

template<class Type >
static Type &	store (autoPtr< Type > &aptr)

template<class Type >
static Type &	store (autoPtr< Type > &&aptr)

template<class Type >
static Type &	store (tmp< Type > &tptr)

template<class Type >
static Type &	store (tmp< Type > &&tptr)

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

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

template<class StringType >
static word	scopedName (StringType 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, bool noHint=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...

Public Attributes inherited from HashTable< zero::null, label, Hash< label > >
const typedef zero::null *	const_pointer
	Const pointer type for the stored value_type. More...

const typedef zero::null &	const_reference
	Const reference to the stored value_type. More...

Static Public Attributes inherited from topoSet
static int	disallowGenericSets
	Debug switch to disallow the use of generic sets. More...

Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

static int	maxFileModificationPolls

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 Protected Attributes inherited from regIOobject
static bool	masterOnlyReading = false
	To flag master-only reading of objects. More...

Detailed Description

Base for a special purpose topoSet using labels stored as a bitSet.

Source files

Definition at line 51 of file topoBitSet.H.

Constructor & Destructor Documentation

◆ topoBitSet() [1/4]

topoBitSet	(	const polyMesh &	mesh,
		const word &	setName
	)

protected

Construct with empty selection.

Definition at line 113 of file topoBitSet.C.

◆ topoBitSet() [2/4]

topoBitSet	(	const polyMesh &	mesh,
		const word &	setName,
		const label	size,
		const bool	val
	)

protected

Construct with size elements.

Definition at line 136 of file topoBitSet.C.

References HashTable< T, Key, Hash >::resize().

Here is the call graph for this function:

◆ topoBitSet() [3/4]

topoBitSet	(	const polyMesh &	mesh,
		const word &	setName,
		const label	size,
		const bitSet &	bits
	)

protected

Copy construct with bitset values, size elements.

Definition at line 150 of file topoBitSet.C.

References PackedList< Width >::resize().

Here is the call graph for this function:

◆ topoBitSet() [4/4]

topoBitSet	(	const polyMesh &	mesh,
		const word &	setName,
		const label	size,
		bitSet &&	bits
	)

protected

Move construct with bitset values, size elements.

Definition at line 165 of file topoBitSet.C.

◆ ~topoBitSet()

virtual ~topoBitSet ( )

virtualdefault

Destructor.

Member Function Documentation

◆ updateLabels()

void updateLabels ( const labelUList & map )

protectedvirtual

Update map from map.

Used to update cell/face labels after morphing

Reimplemented from topoSet.

Definition at line 36 of file topoBitSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, bitSet::find_last(), IOobject::name(), Foam::nl, topoBitSet::selected_, bitSet::set(), UList< T >::size(), and Foam::type().

Here is the call graph for this function:

◆ check()

void check ( const label maxSize )

protectedvirtual

Check limits on addressable range.

Reimplemented from topoSet.

Definition at line 92 of file topoBitSet.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, bitSet::find_last(), Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ addressing() [1/2]

const bitSet& addressing ( ) const

inline

Return the bitSet.

Definition at line 112 of file topoBitSet.H.

References topoBitSet::selected_.

◆ addressing() [2/2]

bitSet& addressing ( )

inline

Access the bitSet.

Definition at line 118 of file topoBitSet.H.

References topoBitSet::selected_.

◆ reset()

void reset ( )

inline

Set values to false, leaving the size untouched.

Definition at line 124 of file topoBitSet.H.

References PackedList< Width >::reset(), and topoBitSet::selected_.

Here is the call graph for this function:

◆ found()

bool found ( const label id ) const

virtual

Has the given index?

Reimplemented from topoSet.

Definition at line 181 of file topoBitSet.C.

◆ set() [1/2]

bool set ( const label id )

virtual

Set an index.

Reimplemented from topoSet.

Definition at line 187 of file topoBitSet.C.

◆ unset() [1/2]

bool unset ( const label id )

virtual

Unset an index.

Reimplemented from topoSet.

Definition at line 193 of file topoBitSet.C.

◆ set() [2/2]

void set ( const labelUList & labels )

virtual

Set multiple indices.

Reimplemented from topoSet.

Definition at line 199 of file topoBitSet.C.

◆ unset() [2/2]

void unset ( const labelUList & labels )

virtual

Unset multiple indices.

Reimplemented from topoSet.

Definition at line 205 of file topoBitSet.C.

◆ invert()

void invert ( const label maxLen )

virtual

Invert contents.

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

Reimplemented from topoSet.

Definition at line 211 of file topoBitSet.C.

◆ subset()

void subset ( const topoSet & set )

virtual

Subset contents. Only elements present in both sets remain.

Reimplemented from topoSet.

Definition at line 218 of file topoBitSet.C.

References HashTable< T, Key, Hash >::empty(), and topoSet::found().

Here is the call graph for this function:

◆ addSet()

void addSet ( const topoSet & set )

virtual

Add elements present in set.

Reimplemented from topoSet.

Definition at line 242 of file topoBitSet.C.

◆ subtractSet()

void subtractSet ( const topoSet & set )

virtual

Subtract elements present in set.

Reimplemented from topoSet.

Definition at line 259 of file topoBitSet.C.

Member Data Documentation

◆ selected_

bitSet selected_

protected

Definition at line 59 of file topoBitSet.H.

Referenced by topoBitSet::addressing(), topoBitSet::reset(), and topoBitSet::updateLabels().

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

src/meshTools/sets/topoSets/topoBitSet.H
src/meshTools/sets/topoSets/topoBitSet.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ topoBitSet() [1/4]

◆ topoBitSet() [2/4]

◆ topoBitSet() [3/4]

◆ topoBitSet() [4/4]

◆ ~topoBitSet()

Member Function Documentation

◆ updateLabels()

◆ check()

◆ addressing() [1/2]

◆ addressing() [2/2]

◆ reset()

◆ found()

◆ set() [1/2]

◆ unset() [1/2]

◆ set() [2/2]

◆ unset() [2/2]

◆ invert()

◆ subset()

◆ addSet()

◆ subtractSet()

Member Data Documentation

◆ selected_