General set of labels of mesh quantity (points, cells, faces). More...
Public Member Functions | |
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 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... | |
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 isTimeObject=false) | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove all file watches and remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool valid=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
Write using stream options. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType comp, const bool valid) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, readOption rOpt, writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
virtual void | rename (const word &newName) |
Rename the object. More... | |
bool | registerObject () const noexcept |
Should object created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference, return previous value. More... | |
bool | globalObject () const noexcept |
Is object same for all processors? More... | |
bool | globalObject (bool on) noexcept |
Change global-object status, return previous value. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
virtual const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data (if any) or nullptr. More... | |
readOption | readOpt () const noexcept |
The read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Change the read option, return previous value. More... | |
writeOption | writeOpt () const noexcept |
The write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Change the write option, return previous value. More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
Return the Time::rootPath() More... | |
const fileName & | caseName () const |
Return the Time::caseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path. More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Helper for filePath that searches up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
bool | readHeader (Istream &is) |
bool | readHeader (dictionary &headerDict, Istream &is) |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (uses typeFilePath to find file) and check its info. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
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 assign. More... | |
void | operator= (this_type &&rhs) |
Move assign. 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< T, Key, Hash > | |
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< Key, T > > 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... | |
T & | at (const Key &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const T & | at (const Key &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
bool | found (const Key &key) const |
Return true if hashed entry is found in table. More... | |
iterator | find (const Key &key) |
Find and return an iterator set at the hashed entry. More... | |
const_iterator | find (const Key &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const_iterator | cfind (const Key &key) const |
Find and return an const_iterator set at the hashed entry. More... | |
const T & | lookup (const Key &key, const T &deflt) const |
Return hashed entry if it exists, or return the given default. More... | |
List< Key > | toc () const |
The table of contents (the keys) in unsorted order. More... | |
List< Key > | sortedToc () const |
The table of contents (the keys) in sorted order. More... | |
template<class Compare > | |
List< Key > | sortedToc (const Compare &comp) const |
template<class UnaryPredicate > | |
List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
template<class UnaryPredicate > | |
List< Key > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
template<class BinaryPredicate > | |
List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
UPtrList< const node_type > | csorted () const |
UPtrList< const node_type > | sorted () const |
UPtrList< node_type > | sorted () |
template<class UnaryPredicate > | |
label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of keys that satisfy the unary predicate. More... | |
template<class UnaryPredicate > | |
label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
Count the number of values that satisfy the unary predicate. More... | |
template<class BinaryPredicate > | |
label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
Count the number of entries that satisfy the binary predicate. More... | |
template<class... Args> | |
bool | emplace (const Key &key, Args &&... args) |
Emplace insert a new entry, not overwriting existing entries. More... | |
template<class... Args> | |
bool | emplace_set (const Key &key, Args &&... args) |
Emplace set an entry, overwriting any existing entries. More... | |
bool | insert (const Key &key, const T &obj) |
Copy insert a new entry, not overwriting existing entries. More... | |
bool | insert (const Key &key, T &&obj) |
Move insert a new entry, not overwriting existing entries. More... | |
bool | set (const Key &key, const T &obj) |
Copy assign a new entry, overwriting existing entries. More... | |
bool | set (const Key &key, T &&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 Key &key) |
Erase an entry specified by the given key. More... | |
template<class AnyType , class AnyHash > | |
label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
Remove table entries given by keys of the other hash-table. More... | |
label | erase (std::initializer_list< Key > keys) |
Remove table entries given by the listed keys. More... | |
template<class InputIter > | |
label | erase (InputIter first, InputIter last) |
Remove multiple entries using an iterator range of keys. More... | |
template<unsigned N> | |
label | erase (const FixedList< Key, N > &keys) |
Remove table entries given by the listed keys. More... | |
label | erase (const UList< Key > &keys) |
Remove table entries given by the listed keys. More... | |
template<class AnyType , class AnyHash > | |
label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
Retain table entries given by keys of the other hash-table. More... | |
template<class UnaryPredicate > | |
label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their keys. More... | |
template<class UnaryPredicate > | |
label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their values. More... | |
template<class BinaryPredicate > | |
label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
Generalized means to filter table entries based on their key/value. More... | |
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< T, Key, Hash > &rhs) |
Swap contents into this table. More... | |
void | transfer (HashTable< T, Key, Hash > &rhs) |
Transfer contents into this table. More... | |
T & | operator[] (const Key &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const T & | operator[] (const Key &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
T & | operator() (const Key &key) |
Return existing entry or create a new entry. More... | |
T & | operator() (const Key &key, const T &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< Key, T > > 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 |
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) More... | |
HashTableCore ()=default | |
Default construct. More... | |
Static Public Member Functions | |
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) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from HashTableCore | |
static label | canonicalSize (const label requested_size) |
Return a canonical (power-of-two) of the requested size. More... | |
Static Public Attributes | |
static int | disallowGenericSets |
Debug switch to disallow the use of generic sets. More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable internal table size. Approximately labelMax/4. More... | |
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... | |
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 IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Protected Member Functions inherited from HashTable< T, Key, Hash > | |
bool | iterator_erase (node_type *&entry, label &index) |
Low-level entry erasure using iterator internals. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 } |
Enumeration defining the read options. More... | |
enum | writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
Enumeration defining the write options. More... | |
enum | objectState : char { GOOD , BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp , timeStampMaster , inotify , inotifyMaster } |
Enumeration defining the file checking options. More... | |
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< T, Key, Hash > | |
typedef HashTable< T, Key, Hash > | this_type |
The template instance used for this HashTable. More... | |
typedef std::conditional< std::is_same< zero::null, typenamestd::remove_cv< T >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, T > >::type | node_type |
typedef Key | key_type |
The second template parameter, type of keys used. More... | |
typedef T | mapped_type |
The first template parameter, type of objects contained. More... | |
typedef T | value_type |
Same as mapped_type for OpenFOAM HashTables. More... | |
typedef Hash | hasher |
The third template parameter, the hash index method. More... | |
typedef T * | pointer |
Pointer type for storing into value_type objects. More... | |
typedef T & | reference |
Reference to the stored value_type. More... | |
typedef const T * | const_pointer |
Const pointer type for the stored value_type. More... | |
typedef const T & | const_reference |
Const 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 Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
General set of labels of mesh quantity (points, cells, faces).
Construct from IOobject as explicitly passed type.
Can't use typeName info here since subclasses not yet instantiated
Definition at line 384 of file topoSet.C.
References regIOobject::close(), IOobject::good(), regIOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
topoSet | ( | const polyMesh & | mesh, |
const word & | wantedType, | ||
const word & | name, | ||
readOption | r = MUST_READ , |
||
writeOption | w = NO_WRITE |
||
) |
Construct from polyMesh and name.
Searches for a polyMesh/sets directory but not beyond the mesh.facesInstance().
Definition at line 405 of file topoSet.C.
References regIOobject::close(), IOobject::good(), regIOobject::headerOk(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::READ_IF_PRESENT, IOobject::readOpt(), and regIOobject::readStream().
topoSet | ( | const polyMesh & | mesh, |
const word & | name, | ||
const label | size, | ||
writeOption | w = NO_WRITE |
||
) |
topoSet | ( | const polyMesh & | mesh, |
const word & | name, | ||
const labelHashSet & | labels, | ||
writeOption | w = NO_WRITE |
||
) |
topoSet | ( | const polyMesh & | mesh, |
const word & | name, | ||
labelHashSet && | labels, | ||
writeOption | w = NO_WRITE |
||
) |
topoSet | ( | const polyMesh & | mesh, |
const word & | name, | ||
const labelUList & | labels, | ||
writeOption | w = NO_WRITE |
||
) |
topoSet | ( | const IOobject & | io, |
const labelHashSet & | labels | ||
) |
topoSet | ( | const IOobject & | io, |
labelHashSet && | labels | ||
) |
|
virtualdefault |
Destructor.
|
protectedvirtual |
Update map from map.
Used to update cell/face labels after morphing
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 147 of file topoSet.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, HashSet< Key, Hash >::set(), HashTable< T, Key, Hash >::size(), UList< T >::size(), HashTable< T, Key, Hash >::transfer(), and Foam::type().
|
protectedvirtual |
Check limits on addressable range.
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 203 of file topoSet.C.
References Foam::abort(), topoSet::check(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, and Foam::type().
Referenced by cellSet::cellSet(), cellZoneSet::cellZoneSet(), topoSet::check(), faceSet::faceSet(), faceZoneSet::faceZoneSet(), pointSet::pointSet(), and pointZoneSet::pointZoneSet().
|
protected |
|
protected |
|
protected |
Write labels and coordinates columnwise to os. Truncate to maxLen.
Definition at line 273 of file topoSet.C.
References Foam::endl(), boundBox::max(), boundBox::min(), n, Foam::nl, and os().
TypeName | ( | "topoSet" | ) |
Runtime type information.
|
static |
Name of file set will use.
Definition at line 133 of file topoSet.C.
References polyMesh::dbDir(), polyMesh::facesInstance(), mesh, polyMesh::meshSubDir, and Foam::name().
|
static |
Find IOobject in the polyMesh/sets (used as constructor helper)
Definition at line 317 of file topoSet.C.
References polyMesh::dbDir(), DebugInfo, Foam::endl(), polyMesh::facesInstance(), Time::findInstance(), io(), mesh, polyMesh::meshSubDir, Foam::name(), IOobject::NO_READ, IOobject::READ_IF_PRESENT, IOobject::readOpt(), fvMesh::time(), and IOobject::typeHeaderOk().
Referenced by fvExprDriver::getTopoSetLabels(), and fvExprDriver::topoSetType().
|
static |
Find IOobject in the polyMesh/sets (used as constructor helper)
Definition at line 351 of file topoSet.C.
References Time::findInstance(), polyMesh::meshSubDir, IOobject::MUST_READ, Foam::name(), IOobject::READ_IF_PRESENT, and runTime.
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) | |||
) |
|
static |
Return a pointer to a toposet read from file.
Definition at line 54 of file topoSet.C.
References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and IOobject::name().
|
static |
Return a pointer to a new toposet of given size.
Definition at line 80 of file topoSet.C.
References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and Foam::name().
|
static |
Return a pointer to a new toposet as copy of another toposet.
Definition at line 106 of file topoSet.C.
References Foam::exit(), Foam::FatalError, FatalErrorInLookup, mesh, and Foam::name().
|
virtual |
Has the given index?
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 508 of file topoSet.C.
References HashTable< T, Key, Hash >::found().
Referenced by setToCellZone::applyToSet(), faceZoneToFaceZone::applyToSet(), searchableSurfaceToFaceZone::applyToSet(), setAndNormalToFaceZone::applyToSet(), setsToFaceZone::applyToSet(), setToFaceZone::applyToSet(), setToPointZone::applyToSet(), polyMeshFilter::filter(), meshRefinement::mergePatchFacesUndo(), meshRefinement::splitFacesUndo(), cellZoneSet::subtractSet(), and pointZoneSet::subtractSet().
|
virtual |
Set an index.
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 514 of file topoSet.C.
References HashSet< Key, Hash >::set().
|
virtual |
Unset an index.
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 520 of file topoSet.C.
References HashSet< Key, Hash >::unset().
|
virtual |
Set multiple indices.
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 526 of file topoSet.C.
References HashSet< Key, Hash >::set().
|
virtual |
Unset multiple indices.
Reimplemented in topoBitSet, and topoBoolSet.
Definition at line 532 of file topoSet.C.
References HashSet< Key, Hash >::unset().
|
virtual |
Invert contents.
Insert all members [0,maxLen) which were not in set.
Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.
Definition at line 538 of file topoSet.C.
References clear(), HashTable< T, Key, Hash >::found(), Foam::max(), resize(), and HashTable< T, Key, Hash >::size().
|
virtual |
Subset contents. Only elements present in both sets remain.
Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.
|
virtual |
Add elements present in set.
Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.
|
virtual |
Subtract elements present in set.
Reimplemented in cellZoneSet, faceZoneSet, pointZoneSet, topoBitSet, and topoBoolSet.
|
virtual |
Sync set across coupled patches.
Reimplemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.
Definition at line 586 of file topoSet.C.
References NotImplemented.
|
virtual |
|
pure virtual |
Like above but also writes mesh related quantity (usually coordinate).
Implemented in cellSet, cellZoneSet, faceSet, faceZoneSet, pointSet, pointZoneSet, cellBitSet, faceBitSet, faceBoolSet, and pointBitSet.
Write contents.
Implements regIOobject.
Definition at line 623 of file topoSet.C.
References os(), and topoSet::writeData().
Referenced by topoSet::writeData().
|
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 629 of file topoSet.C.
References NotImplemented.
|
pure virtual |
Update any stored data for mesh redistribution.
Implemented in pointSet, cellBitSet, cellSet, faceBitSet, faceBoolSet, faceSet, and pointBitSet.
|
pure virtual |
Return max allowable index (+1). Not implemented.
Implemented in cellBitSet, cellSet, cellZoneSet, faceBitSet, faceBoolSet, faceSet, faceZoneSet, pointBitSet, pointSet, and pointZoneSet.
|
static |
Helper: call updateMesh on all sets in container (and.
updates instance)
Definition at line 46 of file topoSetTemplates.C.
References forAll.
|
static |
Helper: set instance on all sets in container.
Definition at line 32 of file topoSetTemplates.C.
References forAll, and IOobject::instance().
|
static |
Helper: remove all sets files from mesh instance.
Definition at line 635 of file topoSet.C.
References DebugVar, polyMesh::facesInstance(), io(), Foam::isDir(), mesh, polyMesh::meshSubDir, IOobject::path(), and Foam::rmDir().
Copy labelHashSet part only.
Definition at line 657 of file topoSet.C.
References HashSet< label, Hash< label > >::operator=().
|
virtual |
Deprecated(2018-10) subtract elements present in set.
|
static |
Debug switch to disallow the use of generic sets.
Definition at line 120 of file topoSet.H.
Referenced by columnFvMeshInfo::columnFvMeshInfo().