A collection of cell labels. More...
#include <cellSet.H>


Public Member Functions | |
| TypeNameNoDebug ("cellSet") | |
| Runtime type information. | |
| cellSet (const IOobject &io) | |
| Construct from IOobject. No checking. | |
| cellSet (const IOobject &io, const Foam::zero) | |
| Construct empty (no-read) with IOobject information. | |
| cellSet (const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Construct from polyMesh (registry) and name. Checks for valid cell ids. | |
| cellSet (const polyMesh &mesh, const word &name, IOobjectOption::registerOption reg, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Construct from polyMesh (registry), name and registration option. | |
| cellSet (const polyMesh &mesh, const word &name, const label initialCapacity, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Construct empty (no-read) with initial labelHashSet capacity. | |
| cellSet (const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Copy construct (no-read) from existing set. | |
| cellSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Copy construct (no-read) from labelHashSet, with search for IOobject instance. | |
| cellSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Move construct (no-read) from labelHashSet, with search for IOobject instance. | |
| cellSet (const polyMesh &mesh, const word &name, const labelUList &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Copy construct (no-read) from labels, with search for IOobject instance. | |
| cellSet (const Time &, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Construct from objectRegistry and name. Used for tetMesh cellSet only. | |
| cellSet (const Time &, const word &name, const label initialCapacity, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Construct empty (no-read) with initial labelHashSet capacity from objectRegistry. Used for tetMesh cellSet only. | |
| cellSet (const Time &, const word &name, const labelHashSet &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) | |
| Copy construct (no-read) from labelHashSet. Used for tetMesh cellSet only. | |
| virtual | ~cellSet ()=default |
| Destructor. | |
| virtual void | sync (const polyMesh &mesh) |
| Sync cellSet across coupled patches. | |
| virtual label | maxSize (const polyMesh &mesh) const |
| Return max index+1. | |
| virtual void | updateMesh (const mapPolyMesh &morphMap) |
| Update any stored data for new labels. | |
| virtual void | distribute (const mapDistributePolyMesh &map) |
| Update any stored data for mesh redistribution. | |
| virtual void | writeDebug (Ostream &os, const primitiveMesh &, const label maxLen) const |
| Write maxLen items with label and coordinates. | |
| Public Member Functions inherited from topoSet | |
| TypeName ("topoSet") | |
| Runtime type information. | |
| declareRunTimeSelectionTable (autoPtr, topoSet, word,(const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt),(mesh, name, rOpt, wOpt)) | |
| declareRunTimeSelectionTable (autoPtr, topoSet, size,(const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt),(mesh, name, size, wOpt)) | |
| declareRunTimeSelectionTable (autoPtr, topoSet, set,(const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt),(mesh, name, set, wOpt)) | |
| topoSet (const IOobject &io, const word &wantedType) | |
| Construct from IOobject as explicitly passed type. | |
| topoSet (const IOobject &io, const Foam::zero) | |
| Construct empty (no-read) with IOobject information. | |
| topoSet (const IOobject &io, const label initialCapacity) | |
| Construct empty (no-read) with initial labelHashSet capacity, with IOobject information. | |
| topoSet (const IOobject &io, const labelHashSet &labels) | |
| Copy construct (no-read) from labelHashSet, with IOobject information. | |
| topoSet (const IOobject &io, labelHashSet &&labels) | |
| Move construct (no-read) from labelHashSet, with IOobject information. | |
| topoSet (const polyMesh &mesh, const word &wantedType, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Construct from polyMesh and name. | |
| topoSet (const polyMesh &mesh, const word &name, const label initialCapacity, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Construct empty (no-read) with initial labelHashSet capacity. | |
| topoSet (const polyMesh &mesh, const word &name, const labelHashSet &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Copy construct (no-read) from labelHashSet. | |
| topoSet (const polyMesh &mesh, const word &name, labelHashSet &&labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Move construct (no-read) from labelHashSet. | |
| topoSet (const polyMesh &mesh, const word &name, const labelUList &labels, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) | |
| Copy construct (no-read) from list of labels. | |
| autoPtr< topoSet > | clone () const |
| Clone. | |
| virtual | ~topoSet ()=default |
| Destructor. | |
| virtual bool | contains (const label id) const |
| Has the given index? | |
| virtual bool | found (const label id) const |
| Has the given index? | |
| virtual bool | set (const label id) |
| Set an index. | |
| virtual bool | unset (const label id) |
| Unset an index. | |
| virtual void | set (const labelUList &labels) |
| Set multiple indices. | |
| virtual void | unset (const labelUList &labels) |
| Unset multiple indices. | |
| virtual void | invert (const label maxLen) |
| Invert contents. | |
| virtual void | subset (const labelUList &elems) |
| Subset contents. Only elements present in both sets remain. | |
| virtual void | subset (const topoSet &set) |
| Subset contents. Only elements present in both sets remain. | |
| virtual void | addSet (const labelUList &elems) |
| Add given elements to the set. | |
| virtual void | addSet (const topoSet &set) |
| Add given elements to the set. | |
| virtual void | subtractSet (const labelUList &elems) |
| Subtract given elements from the set. | |
| virtual void | subtractSet (const topoSet &set) |
| Subtract given elements from the set. | |
| virtual void | writeDebug (Ostream &os, const label maxLen) const |
| Write labels columnwise to os. Truncate to maxLen. | |
| virtual bool | writeData (Ostream &) const |
| Write contents. | |
| void | operator= (const topoSet &) |
| Copy labelHashSet part only. | |
| virtual void | deleteSet (const topoSet &set) |
| Deprecated(2018-10) subtract elements present in set. | |
| Public Member Functions inherited from regIOobject | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual bool | read () |
| Read object. | |
| virtual label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | modified () const |
| Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time). | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified). | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| 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. | |
| 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. | |
| 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. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| template<class Type> | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| template<class StringType> | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> | |
| Foam::fileName | typeFilePath (const bool search) const |
| Public Member Functions inherited from IOobjectOption | |
| constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
| Public Member Functions inherited from HashSet< label, Hash< label > > | |
| constexpr | HashSet () noexcept=default |
| Default construct: empty without allocation (capacity=0). | |
| constexpr | HashSet (Foam::zero) noexcept |
| Construct empty without allocation (capacity=0). | |
| HashSet (const label initialCapacity) | |
| Construct empty with initial table capacity. | |
| HashSet (const this_type &rhs) | |
| Copy construct. | |
| HashSet (this_type &&rhs) noexcept | |
| Move construct. | |
| HashSet (Istream &is) | |
| Construct from Istream with default initial table capacity. | |
| HashSet (const FixedList< label, N > &list) | |
| Construct from FixedList of Key. | |
| HashSet (const UList< label > &list) | |
| Construct from UList of Key. | |
| HashSet (const IndirectListBase< label, Addr > &list) | |
| Construct from an indirect list. | |
| HashSet (std::initializer_list< label > list) | |
| Construct from an initializer list of Key. | |
| HashSet (const HashTable< AnyType, label, AnyHash > &tbl) | |
| Construct from the keys of another HashTable, the type of values held is arbitrary. | |
| bool | test (const label &key) const |
| Same as contains() - return true if key exists in the set. | |
| bool | insert (const label &key) |
| Insert a new entry, not overwriting existing entries. | |
| bool | set (const label &key) |
| Same as insert (no value to overwrite). | |
| bool | unset (const label &key) |
| Unset the specified key - same as erase. | |
| void | merge (HashSet< label, Hash > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| void | merge (HashSet< label, Hash > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| label | insert (InputIter first, InputIter last) |
| Insert keys from the input iterator range. | |
| label | insert (std::initializer_list< label > list) |
| Insert keys from a initializer list of Key. | |
| label | insert (const FixedList< label, N > &list) |
| Insert keys from the list of Key. | |
| label | insert (const UList< label > &list) |
| Insert keys from the list of Key. | |
| label | insert (const IndirectListBase< label, Addr > &list) |
| Insert keys from the list of Key. | |
| label | set (InputIter first, InputIter last) |
| Same as insert (no value to overwrite). | |
| label | set (std::initializer_list< label > list) |
| Same as insert (no value to overwrite). | |
| label | set (const FixedList< label, N > &list) |
| Same as insert (no value to overwrite). | |
| label | set (const UList< label > &list) |
| Same as insert (no value to overwrite). | |
| label | set (const IndirectListBase< label, Addr > &list) |
| Same as insert (no value to overwrite). | |
| label | setMany (InputIter first, InputIter last) |
| Same as insert (no value to overwrite). | |
| label | unset (InputIter first, InputIter last) |
| Unset the keys listed in the input iterator range. | |
| label | unset (std::initializer_list< label > list) |
| Unset the listed keys - same as erase. | |
| label | unset (const FixedList< label, N > &list) |
| Unset the listed keys - same as erase. | |
| label | unset (const UList< label > &list) |
| Unset the listed keys - same as erase. | |
| label | unset (const IndirectListBase< label, Addr > &list) |
| Unset the listed keys - same as erase. | |
| iterator | begin () |
| const_iterator | begin () const |
| const_iterator | cbegin () const |
| iterator | end () noexcept |
| const_iterator | end () const noexcept |
| constexpr const_iterator | cend () const noexcept |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. | |
| bool | operator() (const label &key) const noexcept |
| Return true if the entry exists, same as contains(). | |
| bool | operator[] (const label &key) const noexcept |
| Return true if the entry exists, same as contains(). | |
| void | operator= (const this_type &rhs) |
| Copy assign. | |
| void | operator= (this_type &&rhs) |
| Move assign. | |
| bool | operator== (const this_type &rhs) const |
| Sets are equal if all keys are equal, independent of order or underlying storage size. | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. | |
| void | operator= (const UList< label > &rhs) |
| Assignment from a UList of keys. | |
| void | operator= (const FixedList< label, N > &rhs) |
| Assignment from a FixedList of keys. | |
| void | operator= (std::initializer_list< label > rhs) |
| Assignment from an initializer list of keys. | |
| this_type & | operator|= (const this_type &rhs) |
| Add entries to this HashSet. | |
| this_type & | operator&= (const this_type &rhs) |
| Only retain entries contained in both HashSets. | |
| this_type & | operator^= (const this_type &rhs) |
| Only retain unique entries (xor). | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries to this HashSet. Same as the '|=' operator. | |
| this_type & | operator-= (const this_type &rhs) |
| Remove entries from this HashSet. Uses erase(). | |
| List< label > | tocValues (const UnaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| List< label > | tocEntries (const BinaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| label | countValues (const UnaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| label | countEntries (const BinaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| label | filterValues (const UnaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| label | filterEntries (const BinaryPredicate &, const bool)=delete |
| Not applicable for HashSet. | |
| Foam::label | assignMany (const label nItems, InputIter first, InputIter last) |
| Foam::label | insert (InputIter first, InputIter last) |
| Foam::label | insert (const FixedList< label, N > &list) |
| Foam::label | insert (const IndirectListBase< label, Addr > &list) |
| Foam::label | unset (InputIter first, InputIter last) |
| Foam::label | unset (const FixedList< label, N > &list) |
| Foam::label | unset (const IndirectListBase< label, Addr > &list) |
| Public Member Functions inherited from HashTable< T, Key, Hash > | |
| constexpr | HashTable () noexcept |
| Default construct: empty without allocation (capacity=0). | |
| constexpr | HashTable (Foam::zero) noexcept |
| Construct empty without allocation (capacity=0). | |
| HashTable (const label initialCapacity) | |
| Construct empty with initial table capacity. | |
| HashTable (Istream &is) | |
| Construct from Istream. | |
| HashTable (const this_type &ht) | |
| Copy construct. | |
| HashTable (this_type &&rhs) noexcept | |
| Move construct. | |
| HashTable (std::initializer_list< std::pair< Key, T > > list, const bool overwrite=false) | |
| Construct from key/value pairs in initializer list. | |
| HashTable (const UList< Key > &keys, const UList< T > &values, const bool overwrite=false) | |
| Construct from key/value pairs. | |
| ~HashTable () | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the hash table is empty. | |
| label | size () const noexcept |
| The number of elements in table. | |
| label | capacity () const noexcept |
| The size of the underlying table (the number of buckets). | |
| T & | at (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| const T & | at (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. | |
| bool | contains (const Key &key) const |
| True if hashed key is contained (found) in table. | |
| iterator | find (const Key &key) |
| Find and return an iterator set at the hashed entry. | |
| const_iterator | find (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. | |
| const_iterator | cfind (const Key &key) const |
| Find and return an const_iterator set at the hashed entry. | |
| const T & | lookup (const Key &key, const T &deflt) const |
| Return hashed entry if it exists, or return the given default. | |
| List< Key > | toc () const |
| The table of contents (the keys) in unsorted order. | |
| List< Key > | sortedToc () const |
| The table of contents (the keys) in sorted order. | |
| template<class Compare> | |
| List< Key > | sortedToc (const Compare &comp) const |
| The table of contents (the keys) sorted according to the specified comparator. | |
| template<class UnaryPredicate> | |
| List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the keys. | |
| template<class UnaryPredicate> | |
| List< Key > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the unary predicate applied to the values. | |
| template<class BinaryPredicate> | |
| List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| The table of contents (the keys) selected according to the binary predicate applied to the keys and values. | |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). | |
| template<class UnaryPredicate> | |
| label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of keys that satisfy the unary predicate. | |
| template<class UnaryPredicate> | |
| label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of values that satisfy the unary predicate. | |
| template<class BinaryPredicate> | |
| label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
| Count the number of entries that satisfy the binary predicate. | |
| template<class... Args> | |
| bool | emplace (const Key &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. | |
| template<class... Args> | |
| bool | emplace_set (const Key &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. | |
| bool | insert (const Key &key, const T &obj) |
| Copy insert a new entry, not overwriting existing entries. | |
| bool | insert (const Key &key, T &&obj) |
| Move insert a new entry, not overwriting existing entries. | |
| bool | set (const Key &key, const T &obj) |
| Copy assign a new entry, overwriting existing entries. | |
| bool | set (const Key &key, T &&obj) |
| Move assign a new entry, overwriting existing entries. | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by given iterator. | |
| bool | erase (const Key &key) |
| Erase an entry specified by the given key. | |
| template<class AnyType, class AnyHash> | |
| label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| Remove table entries given by keys of the other hash-table. | |
| label | erase (std::initializer_list< Key > keys) |
| Remove table entries given by the listed keys. | |
| template<class InputIter> | |
| label | erase (InputIter first, InputIter last) |
| Remove multiple entries using an iterator range of keys. | |
| template<unsigned N> | |
| label | erase (const FixedList< Key, N > &keys) |
| Remove table entries given by the listed keys. | |
| label | erase (const UList< Key > &keys) |
| Remove table entries given by the listed keys. | |
| template<class AnyType, class AnyHash> | |
| label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
| Retain table entries given by keys of the other hash-table. | |
| template<class UnaryPredicate> | |
| label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their keys. | |
| template<class UnaryPredicate> | |
| label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their values. | |
| template<class BinaryPredicate> | |
| label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their key/value. | |
| void | clear () |
| Remove all entries from table. | |
| void | clearStorage () |
| Remove all entries from table and the table itself. | |
| void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). | |
| void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity(). | |
| void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. | |
| void | swap (HashTable< T, Key, Hash > &rhs) noexcept |
| Swap contents into this table. | |
| void | transfer (HashTable< T, Key, Hash > &rhs) |
| Transfer contents into this table. | |
| void | merge (HashTable< T, Key, Hash > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| void | merge (HashTable< T, Key, Hash > &&source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| T & | operator[] (const Key &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| const T & | operator[] (const Key &key) const |
| Find and return a hashed entry. FatalError if it does not exist. | |
| T & | operator() (const Key &key) |
| Return existing entry or create a new entry. | |
| T & | operator() (const Key &key, const T &deflt) |
| Return existing entry or insert a new entry. | |
| void | operator= (const this_type &rhs) |
| Copy assign. | |
| void | operator= (std::initializer_list< std::pair< Key, T > > rhs) |
| Copy assign from an initializer list. | |
| void | operator= (this_type &&rhs) |
| Move assign. | |
| bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. | |
| iterator | begin () |
| iterator set to the beginning of the HashTable | |
| const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) | |
| const_iterator | end () const noexcept |
| const_iterator to signal the end (for any HashTable) | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. | |
| bool | found (const Key &key) const |
| Same as contains(). | |
| UPtrList< const node_type > | sorted () const |
| Deprecated(2023-07) use csorted() method. | |
| template<class Compare> | |
| Foam::List< Key > | sortedToc (const Compare &comp) const |
| template<class UnaryPredicate> | |
| Foam::List< Key > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate> | |
| Foam::List< Key > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| template<class BinaryPredicate> | |
| Foam::List< Key > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate> | |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| template<class UnaryPredicate> | |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| template<class BinaryPredicate> | |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| template<class InputIter> | |
| Foam::label | erase (InputIter first, InputIter last) |
| template<unsigned N> | |
| Foam::label | erase (const FixedList< Key, N > &keys) |
| template<class AnyType, class AnyHash> | |
| Foam::label | erase (const HashTable< AnyType, Key, AnyHash > &other) |
| template<class AnyType, class AnyHash> | |
| Foam::label | retain (const HashTable< AnyType, Key, AnyHash > &other) |
| template<class UnaryPredicate> | |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| template<class UnaryPredicate> | |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| template<class BinaryPredicate> | |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch). | |
| constexpr | HashTableCore () noexcept=default |
| Default construct. | |
Static Public Member Functions | |
| static labelHashSet | readContents (const polyMesh &mesh, const word &name) |
| Read and return contents. Intermediate IOobject is not registered. | |
| Static Public Member Functions inherited from topoSet | |
| static fileName | localPath (const polyMesh &mesh, const word &name) |
| Name of file set will use. | |
| static IOobject | findIOobject (const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) |
| Find IOobject in the polyMesh/sets/ (used as constructor helper). | |
| static IOobject | findIOobject (const polyMesh &mesh, const word &name, IOobjectOption::registerOption reg, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) |
| Find IOobject in the polyMesh/sets/ (used as constructor helper). | |
| static IOobject | findIOobject (const Time &runTime, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption reg=IOobjectOption::LEGACY_REGISTER) |
| Find IOobject in the polyMesh/sets/ (used as constructor helper). | |
| static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, IOobjectOption::readOption rOpt=IOobjectOption::MUST_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) |
| Return a pointer to a toposet read from file. | |
| static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, const label size, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) |
| Return a pointer to a new toposet of given size. | |
| static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, const topoSet &set, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE) |
| Return a pointer to a new toposet as copy of another toposet. | |
| template<class Container> | |
| static void | updateMesh (const fileName &instance, const mapPolyMesh &, Container &items) |
| Helper: call updateMesh on all items in container (and updates instance). | |
| template<class Container> | |
| static void | setInstance (const fileName &instance, Container &items) |
| Helper: set instance on all items in container. | |
| static void | removeFiles (const polyMesh &) |
| Helper: remove all sets files from mesh instance. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label size) noexcept |
| Return a canonical (power-of-two) of the requested size. | |
Additional Inherited Members | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). More... | |
| Public Types inherited from IOobjectOption | |
| enum | readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 } |
| Enumeration defining read preferences. More... | |
| enum | writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
| Enumeration defining write preferences. More... | |
| enum | registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true). More... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from HashSet< label, Hash< label > > | |
| typedef HashSet< label, Hash > | this_type |
| The template instance used for this HashSet. | |
| typedef HashTable< Foam::zero, label, Hash > | parent_type |
| The template instance used for the parent HashTable. | |
| using | iterator |
| An iterator, returning reference to the key. | |
| using | const_iterator |
| A const_iterator, returning reference to the key. | |
| Public Types inherited from HashTable< T, Key, Hash > | |
| typedef HashTable< T, Key, Hash > | this_type |
| The template instance used for this HashTable. | |
| using | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. | |
| typedef Key | key_type |
| The second template parameter, type of keys used. | |
| typedef T | mapped_type |
| The first template parameter, type of objects contained. | |
| typedef T | value_type |
| Same as mapped_type for OpenFOAM HashTables. | |
| typedef Hash | hasher |
| The third template parameter, the hash index method. | |
| typedef T * | pointer |
| Pointer type for storing into value_type objects. | |
| typedef T & | reference |
| Reference to the stored value_type. | |
| typedef const T * | const_pointer |
| Const pointer type for the stored value_type. | |
| typedef const T & | const_reference |
| Const reference to the stored value_type. | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. | |
| using | key_iterator = key_iterator_base<iterator> |
| Forward iterator returning the key. | |
| using | const_key_iterator = key_iterator_base<const_iterator> |
| Forward const iterator returning the key. | |
| Static Public Attributes inherited from topoSet | |
| static int | disallowGenericSets |
| Debug switch to disallow the use of generic sets. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from HashTableCore | |
| static constexpr int32_t | maxTableSize = (1 << (32-3)) |
| Maximum allowable internal table size (must be a power of two!). | |
| Protected Member Functions inherited from topoSet | |
| bool | readIOcontents (const word &wantedType, labelHashSet &contents) |
| Read into labelHashSet if IOobject flags set. Return true if read. | |
| void | checkLabels (const labelUList &labels, const label maxSize) |
| Check limits on addressable range. | |
| void | checkLabels (const labelHashSet &labels, const label maxSize) |
| Check limits on addressable range. | |
| virtual void | updateLabels (const labelUList &map) |
| Update map from map. | |
| virtual void | check (const label maxSize) |
| Check limits on addressable range. | |
| label | writeDebug (Ostream &os, const label maxElem, labelHashSet::const_iterator &iter) const |
| Write part of contents nicely formatted. | |
| label | writeDebug (Ostream &os, const pointField &coords, const label maxElem, labelHashSet::const_iterator &iter) const |
| Write part of contents nicely formatted. | |
| void | writeDebug (Ostream &os, const pointField &coords, const label maxLen) const |
| Write labels and coordinates columnwise to os. Truncate to maxLen. | |
| topoSet (const topoSet &)=delete | |
| No copy construct. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| Helper: write content for FoamFile IOobject header with optional meta information. | |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Helper: write dictionary content for FoamFile header with optional meta information. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
A collection of cell labels.
|
explicit |
Construct from IOobject. No checking.
Definition at line 42 of file cellSet.C.
References Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, io, and topoSet::topoSet().

| cellSet | ( | const IOobject & | io, |
| const Foam::zero | ) |
Construct empty (no-read) with IOobject information.
Definition at line 48 of file cellSet.C.
References io, and topoSet::topoSet().

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| IOobjectOption::readOption | rOpt = IOobjectOption::MUST_READ, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE, | ||
| IOobjectOption::registerOption | reg = IOobjectOption::LEGACY_REGISTER ) |
Construct from polyMesh (registry) and name. Checks for valid cell ids.
Definition at line 54 of file cellSet.C.
References topoSet::check(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, mesh, Foam::name(), and topoSet::topoSet().

|
inline |
Construct from polyMesh (registry), name and registration option.
Definition at line 95 of file cellSet.H.
References mesh, IOobjectOption::MUST_READ, Foam::name(), and IOobjectOption::NO_WRITE.

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| const label | initialCapacity, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Construct empty (no-read) with initial labelHashSet capacity.
Definition at line 69 of file cellSet.C.
References mesh, Foam::name(), and topoSet::topoSet().

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| const topoSet & | set, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Copy construct (no-read) from existing set.
Definition at line 81 of file cellSet.C.
References mesh, Foam::name(), topoSet::set(), and topoSet::topoSet().

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| const labelHashSet & | labels, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Copy construct (no-read) from labelHashSet, with search for IOobject instance.
Definition at line 93 of file cellSet.C.
References mesh, Foam::name(), and topoSet::topoSet().

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| labelHashSet && | labels, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Move construct (no-read) from labelHashSet, with search for IOobject instance.
Definition at line 105 of file cellSet.C.
References mesh, Foam::name(), and topoSet::topoSet().

| cellSet | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| const labelUList & | labels, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Copy construct (no-read) from labels, with search for IOobject instance.
Definition at line 117 of file cellSet.C.
References mesh, Foam::name(), and topoSet::topoSet().

| cellSet | ( | const Time & | runTime, |
| const word & | name, | ||
| IOobjectOption::readOption | rOpt = IOobjectOption::MUST_READ, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Construct from objectRegistry and name. Used for tetMesh cellSet only.
Definition at line 130 of file cellSet.C.
References topoSet::findIOobject(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::name(), runTime, and topoSet::topoSet().

| cellSet | ( | const Time & | runTime, |
| const word & | name, | ||
| const label | initialCapacity, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Construct empty (no-read) with initial labelHashSet capacity from objectRegistry. Used for tetMesh cellSet only.
Definition at line 146 of file cellSet.C.
References topoSet::findIOobject(), Foam::name(), IOobjectOption::NO_READ, runTime, and topoSet::topoSet().

| cellSet | ( | const Time & | runTime, |
| const word & | name, | ||
| const labelHashSet & | labels, | ||
| IOobjectOption::writeOption | wOpt = IOobjectOption::NO_WRITE ) |
Copy construct (no-read) from labelHashSet. Used for tetMesh cellSet only.
Definition at line 162 of file cellSet.C.
References topoSet::findIOobject(), Foam::name(), IOobjectOption::NO_READ, runTime, and topoSet::topoSet().

|
virtualdefault |
Destructor.
| TypeNameNoDebug | ( | "cellSet" | ) |
Runtime type information.
References io, IOobjectOption::LEGACY_REGISTER, mesh, IOobjectOption::MUST_READ, Foam::name(), and IOobjectOption::NO_WRITE.

|
static |
Read and return contents. Intermediate IOobject is not registered.
Definition at line 180 of file cellSet.C.
References topoSet::findIOobject(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, mesh, Foam::name(), and IOobjectOption::NO_REGISTER.

|
inlinevirtual |
Sync cellSet across coupled patches.
Reimplemented from topoSet.
Reimplemented in cellZoneSet.
Definition at line 227 of file cellSet.H.
References mesh.
Referenced by cellZoneSet::sync().

|
virtual |
Return max index+1.
Implements topoSet.
Reimplemented in cellZoneSet.
Definition at line 202 of file cellSet.C.
References mesh.
|
virtual |
Update any stored data for new labels.
Reimplemented from topoSet.
Reimplemented in cellZoneSet.
Definition at line 208 of file cellSet.C.
References mapPolyMesh::reverseCellMap(), and topoSet::updateLabels().

|
virtual |
Update any stored data for mesh redistribution.
Implements topoSet.
Definition at line 214 of file cellSet.C.
References HashTable< T, Key, Hash >::clear(), mapDistributePolyMesh::distributeCellData(), n, mapDistributePolyMesh::nOldCells(), HashTable< T, Key, Hash >::reserve(), HashSet< Key, Hash >::set(), List< T >::set(), UList< T >::size(), and UList< T >::test().

|
virtual |
Write maxLen items with label and coordinates.
Implements topoSet.
Reimplemented in cellZoneSet.
Definition at line 255 of file cellSet.C.
References mesh, os(), and topoSet::writeDebug().
Referenced by cellZoneSet::writeDebug().

