Base for a special purpose topoSet using labels stored as a boolList. More...
Public Member Functions | |
virtual | ~topoBoolSet ()=default |
Destructor. More... | |
const boolList & | addressing () const noexcept |
Return the boolList. More... | |
boolList & | addressing () noexcept |
Access the boolList. 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, 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. More... | |
topoSet (const polyMesh &mesh, const word &wantedType, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
Construct from polyMesh and name. More... | |
topoSet (const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
Construct empty from additional size of labelHashSet. More... | |
topoSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
Construct (no-read) with copy of labelHashSet. More... | |
topoSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
Construct (no-read) with moving labelHashSet. More... | |
topoSet (const polyMesh &mesh, const word &name, const labelUList &labels, IOobjectOption::writeOption wOpt=IOobjectOption::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 |
Like above but also writes mesh related quantity (usually coordinate). More... | |
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) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
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 |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
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 readOnProc=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 |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
virtual bool | write (const bool writeOnProc=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 cmp, const bool writeOnProc) 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, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. 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 noexcept |
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... | |
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... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. 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... | |
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 |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. 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 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 |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) 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 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. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required(ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. 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... | |
Public Member Functions inherited from HashSet< Key, Hash > | |
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... | |
template<unsigned N> | |
HashSet (const FixedList< Key, N > &list) | |
Construct from FixedList of Key. More... | |
HashSet (const UList< Key > &list) | |
Construct from UList of Key. More... | |
template<class Addr > | |
HashSet (const IndirectListBase< Key, Addr > &list) | |
Construct from an indirect list. More... | |
HashSet (std::initializer_list< Key > list) | |
Construct from an initializer list of Key. More... | |
template<class AnyType , class AnyHash > | |
HashSet (const HashTable< AnyType, Key, AnyHash > &tbl) | |
Construct from the keys of another HashTable, the type of values held is arbitrary. More... | |
bool | test (const Key &key) const |
Same as contains() - return true if key exists in the set. More... | |
bool | insert (const Key &key) |
Insert a new entry, not overwriting existing entries. More... | |
bool | set (const Key &key) |
Same as insert (no value to overwrite) More... | |
bool | unset (const Key &key) |
Unset the specified key - same as erase. More... | |
void | merge (HashSet< 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. More... | |
void | merge (HashSet< 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. More... | |
template<class InputIter > | |
label | insert (InputIter first, InputIter last) |
Insert keys from the input iterator range. More... | |
label | insert (std::initializer_list< Key > list) |
Insert keys from a initializer list of Key. More... | |
template<unsigned N> | |
label | insert (const FixedList< Key, N > &list) |
Insert keys from the list of Key. More... | |
label | insert (const UList< Key > &list) |
Insert keys from the list of Key. More... | |
template<class Addr > | |
label | insert (const IndirectListBase< Key, Addr > &list) |
Insert keys from the list of Key. More... | |
template<class InputIter > | |
label | set (InputIter first, InputIter last) |
Same as insert (no value to overwrite) More... | |
label | set (std::initializer_list< Key > list) |
Same as insert (no value to overwrite) More... | |
template<unsigned N> | |
label | set (const FixedList< Key, N > &list) |
Same as insert (no value to overwrite) More... | |
label | set (const UList< Key > &list) |
Same as insert (no value to overwrite) More... | |
template<class Addr > | |
label | set (const IndirectListBase< Key, Addr > &list) |
Same as insert (no value to overwrite) More... | |
template<class InputIter > | |
label | setMany (InputIter first, InputIter last) |
Same as insert (no value to overwrite) More... | |
template<class InputIter > | |
label | unset (InputIter first, InputIter last) |
Unset the keys listed in the input iterator range. More... | |
label | unset (std::initializer_list< Key > list) |
Unset the listed keys - same as erase. More... | |
template<unsigned N> | |
label | unset (const FixedList< Key, N > &list) |
Unset the listed keys - same as erase. More... | |
label | unset (const UList< Key > &list) |
Unset the listed keys - same as erase. More... | |
template<class Addr > | |
label | unset (const IndirectListBase< Key, Addr > &list) |
Unset the listed keys - same as erase. 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 |
Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
bool | operator() (const Key &key) const noexcept |
Return true if the entry exists, same as contains() More... | |
bool | operator[] (const Key &key) const noexcept |
Return true if the entry exists, same as contains(). More... | |
void | operator= (const this_type &rhs) |
Copy assign. More... | |
void | operator= (this_type &&rhs) |
Move assign. More... | |
bool | operator== (const this_type &rhs) const |
Sets are equal if all keys are equal, independent of order or underlying storage size. More... | |
bool | operator!= (const this_type &rhs) const |
The opposite of the equality operation. More... | |
void | operator= (const UList< Key > &rhs) |
Assignment from a UList of keys. More... | |
template<unsigned N> | |
void | operator= (const FixedList< Key, N > &rhs) |
Assignment from a FixedList of keys. More... | |
void | operator= (std::initializer_list< Key > rhs) |
Assignment from an initializer list of keys. More... | |
this_type & | operator|= (const this_type &rhs) |
Add entries to this HashSet. More... | |
this_type & | operator &= (const this_type &rhs) |
Only retain entries contained 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... | |
template<class UnaryPredicate > | |
List< Key > | tocValues (const UnaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class BinaryPredicate > | |
List< Key > | tocEntries (const BinaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class UnaryPredicate > | |
label | countValues (const UnaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class BinaryPredicate > | |
label | countEntries (const BinaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class UnaryPredicate > | |
label | filterValues (const UnaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class BinaryPredicate > | |
label | filterEntries (const BinaryPredicate &, const bool)=delete |
Not applicable for HashSet. More... | |
template<class InputIter > | |
Foam::label | assignMany (const label nItems, InputIter first, InputIter last) |
template<class InputIter> | |
Foam::label | insert (InputIter first, InputIter last) |
template<unsigned N> | |
Foam::label | insert (const FixedList< Key, N > &list) |
template<class Addr> | |
Foam::label | insert (const IndirectListBase< Key, Addr > &list) |
template<class InputIter> | |
Foam::label | unset (InputIter first, InputIter last) |
template<unsigned N> | |
Foam::label | unset (const FixedList< Key, N > &list) |
template<class Addr> | |
Foam::label | unset (const IndirectListBase< Key, Addr > &list) |
Public Member Functions inherited from HashTable< Foam::zero, 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, Foam::zero >> list) | |
Construct from an initializer list. More... | |
~HashTable () | |
Destructor. More... | |
bool | empty () const noexcept |
True if the hash table is empty. More... | |
label | size () const noexcept |
The number of elements in table. More... | |
label | capacity () const noexcept |
The size of the underlying table. More... | |
Foam::zero & | at (const Key &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const Foam::zero & | at (const Key &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
bool | contains (const Key &key) const |
True if hashed key is contained (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 Foam::zero & | lookup (const Key &key, const Foam::zero &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... | |
List< Key > | sortedToc (const Compare &comp) const |
The table of contents (the keys) sorted according to the specified comparator. More... | |
Foam::List< Key > | sortedToc (const Compare &comp) const |
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. More... | |
Foam::List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
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. More... | |
Foam::List< Key > | tocValues (const UnaryPredicate &pred, const bool invert) const |
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. More... | |
Foam::List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
UPtrList< const node_type > | csorted () const |
Const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< const node_type > | sorted () const |
Const access to the hash-table contents in sorted order (sorted by keys). More... | |
UPtrList< node_type > | sorted () |
Non-const access to the hash-table contents in sorted order (sorted by keys). More... | |
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 Key &key, Args &&... args) |
Emplace insert a new entry, not overwriting existing entries. More... | |
bool | emplace_set (const Key &key, Args &&... args) |
Emplace set an entry, overwriting any existing entries. More... | |
bool | insert (const Key &key, const Foam::zero &obj) |
Copy insert a new entry, not overwriting existing entries. More... | |
bool | insert (const Key &key, Foam::zero &&obj) |
Move insert a new entry, not overwriting existing entries. More... | |
bool | set (const Key &key, const Foam::zero &obj) |
Copy assign a new entry, overwriting existing entries. More... | |
bool | set (const Key &key, Foam::zero &&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... | |
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... | |
label | erase (InputIter first, InputIter last) |
Remove multiple entries using an iterator range of keys. More... | |
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... | |
Foam::label | erase (InputIter first, InputIter last) |
Foam::label | erase (const FixedList< Key, N > &keys) |
Foam::label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
Retain table entries given by keys of the other hash-table. More... | |
Foam::label | retain (const HashTable< AnyType, Key, 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< Foam::zero, Key, Hash > &rhs) |
Swap contents into this table. More... | |
void | transfer (HashTable< Foam::zero, Key, Hash > &rhs) |
Transfer contents into this table. More... | |
void | merge (HashTable< Foam::zero, 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. More... | |
void | merge (HashTable< Foam::zero, 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. More... | |
Foam::zero & | operator[] (const Key &key) |
Find and return a hashed entry. FatalError if it does not exist. More... | |
const Foam::zero & | operator[] (const Key &key) const |
Find and return a hashed entry. FatalError if it does not exist. More... | |
Foam::zero & | operator() (const Key &key) |
Return existing entry or create a new entry. More... | |
Foam::zero & | operator() (const Key &key, const Foam::zero &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, Foam::zero >> rhs) |
Copy assign from an initializer list. More... | |
void | operator= (this_type &&rhs) |
Move assign. More... | |
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. More... | |
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 |
Write unordered keys (list), with line-breaks when length exceeds shortLen. More... | |
bool | found (const Key &key) const |
Same as contains() More... | |
Public Member Functions inherited from HashTableCore | |
ClassName ("HashTable") | |
Declare type-name (with debug switch) More... | |
HashTableCore () noexcept=default | |
Default construct. 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... | |
topoBoolSet (const polyMesh &mesh, const word &setName) | |
Construct with empty selection. More... | |
topoBoolSet (const polyMesh &mesh, const word &setName, const label size, const bool val) | |
Construct with size elements. More... | |
topoBoolSet (const polyMesh &mesh, const word &setName, const label size, const boolList &bools) | |
Copy construct with list values, size elements. More... | |
topoBoolSet (const polyMesh &mesh, const word &setName, const label size, boolList &&bools) | |
Move construct with list 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 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 Attributes | |
boolList | selected_ |
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, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. 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 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Public Types inherited from HashSet< Key, Hash > | |
typedef HashSet< Key, Hash > | this_type |
The template instance used for this HashSet. More... | |
typedef HashTable< Foam::zero, Key, Hash > | 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< Foam::zero, Key, Hash > | |
typedef HashTable< Foam::zero, Key, Hash > | this_type |
The template instance used for this HashTable. More... | |
typedef std::conditional< std::is_same< Foam::zero, typename std::remove_cv< Foam::zero >::type >::value, Detail::HashTableSingle< Key >, Detail::HashTablePair< Key, Foam::zero > >::type | node_type |
A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. More... | |
typedef Key | key_type |
The second template parameter, type of keys used. More... | |
typedef Foam::zero | mapped_type |
The first template parameter, type of objects contained. More... | |
typedef Foam::zero | value_type |
Same as mapped_type for OpenFOAM HashTables. More... | |
typedef Hash | hasher |
The third template parameter, the hash index method. More... | |
typedef Foam::zero * | pointer |
Pointer type for storing into value_type objects. More... | |
typedef Foam::zero & | reference |
Reference to the stored value_type. More... | |
typedef const Foam::zero * | const_pointer |
Const pointer type for the stored value_type. More... | |
typedef const Foam::zero & | 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 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, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) |
Find IOobject in the polyMesh/sets (used as constructor helper) More... | |
static IOobject | findIOobject (const Time &runTime, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::writeOption wOpt=IOobjectOption::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, IOobjectOption::writeOption wOpt=IOobjectOption::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 IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. 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 inherited from topoSet | |
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... | |
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. More... | |
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. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Base for a special purpose topoSet using labels stored as a boolList.
Definition at line 47 of file topoBoolSet.H.
|
protected |
Construct with empty selection.
Definition at line 115 of file topoBoolSet.C.
|
protected |
Construct with size elements.
Definition at line 138 of file topoBoolSet.C.
References HashTable< T, Key, Hash >::resize().
|
protected |
Copy construct with list values, size elements.
Definition at line 152 of file topoBoolSet.C.
References Foam::HashSetOps::bools(), and List< T >::resize().
|
protected |
Move construct with list values, size elements.
Definition at line 167 of file topoBoolSet.C.
References Foam::HashSetOps::bools().
|
virtualdefault |
Destructor.
|
protectedvirtual |
Update map from map.
Used to update cell/face labels after morphing
Reimplemented from topoSet.
Definition at line 29 of file topoBoolSet.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::name(), Foam::nl, topoBoolSet::selected_, List< T >::set(), UList< T >::size(), UList< T >::test(), List< T >::transfer(), and Foam::type().
|
protectedvirtual |
Check limits on addressable range.
Reimplemented from topoSet.
Definition at line 94 of file topoBoolSet.C.
References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, UList< T >::rfind(), and Foam::type().
|
inlinenoexcept |
Return the boolList.
Definition at line 125 of file topoBoolSet.H.
References topoBoolSet::selected_.
Referenced by geometric::add().
|
inlinenoexcept |
Access the boolList.
Definition at line 133 of file topoBoolSet.H.
References topoBoolSet::selected_.
|
inline |
Set values to false, leaving the size untouched.
Definition at line 141 of file topoBoolSet.H.
References topoBoolSet::selected_.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Invert contents.
Insert all members [0,maxLen) which were not in set.
Reimplemented from topoSet.
Definition at line 219 of file topoBoolSet.C.
References Foam::constant::physicoChemical::b.
|
virtual |
Subset contents. Only elements present in both sets remain.
Reimplemented from topoSet.
Definition at line 229 of file topoBoolSet.C.
References forAll.
|
virtual |
Add elements present in set.
Reimplemented from topoSet.
Definition at line 246 of file topoBoolSet.C.
|
virtual |
Subtract elements present in set.
Reimplemented from topoSet.
Definition at line 256 of file topoBoolSet.C.
|
protected |
Definition at line 55 of file topoBoolSet.H.
Referenced by topoBoolSet::addressing(), topoBoolSet::reset(), and topoBoolSet::updateLabels().
Copyright © 2011-2018 OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.