General set of labels of mesh quantity (points, cells, faces). More...
Public Member Functions | |
TypeName ("topoSet") | |
Runtime type information. More... | |
declareRunTimeSelectionTable (autoPtr, topoSet, word,(const polyMesh &mesh, const word &name, readOption r, writeOption w),(mesh, name, r, w)) | |
declareRunTimeSelectionTable (autoPtr, topoSet, size,(const polyMesh &mesh, const word &name, const label size, writeOption w),(mesh, name, size, w)) | |
declareRunTimeSelectionTable (autoPtr, topoSet, set,(const polyMesh &mesh, const word &name, const topoSet &set, writeOption w),(mesh, name, set, w)) | |
topoSet (const IOobject &, const word &wantedType) | |
Construct from IOobject as explicitly passed type. More... | |
topoSet (const polyMesh &mesh, const word &wantedType, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE) | |
Construct from polyMesh and name. Searches for a polyMesh/sets. More... | |
topoSet (const polyMesh &mesh, const word &name, const label, writeOption w=NO_WRITE) | |
Construct empty from additional size of labelHashSet. More... | |
topoSet (const polyMesh &mesh, const word &name, const labelHashSet &, writeOption w=NO_WRITE) | |
Construct empty from additional labelHashSet. More... | |
topoSet (const IOobject &, const label size) | |
Construct empty from IOobject and size. More... | |
topoSet (const IOobject &, const labelHashSet &) | |
Construct from IOobject and labelHashSet. More... | |
autoPtr< topoSet > | clone () const |
Clone. More... | |
virtual | ~topoSet () |
Destructor. More... | |
virtual void | invert (const label maxLen) |
Invert contents. (insert all members 0..maxLen-1 which were not in. 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 | deleteSet (const topoSet &set) |
Delete elements present in set. More... | |
virtual void | sync (const polyMesh &mesh) |
Sync set across coupled patches. More... | |
virtual void | writeDebug (Ostream &os, const label maxLen) const |
Write labels columnwise to os. Truncate to maxLen. More... | |
virtual void | writeDebug (Ostream &os, const primitiveMesh &, const label maxLen) const =0 |
Like above but also writes mesh related quantity. 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 label | maxSize (const polyMesh &mesh) const =0 |
Return max allowable index (+1). Not implemented. More... | |
void | operator= (const topoSet &) |
Copy labelHashSet part only. More... | |
Public Member Functions inherited from regIOobject | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &, const bool isTime=false) | |
Construct from IOobject. Optional flag for if IOobject is the. More... | |
regIOobject (const regIOobject &) | |
Construct as copy. More... | |
regIOobject (const regIOobject &, bool registerCopy) | |
Construct as copy, transferring registry registration to copy. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Construct as copy with new name, transferring registry registration. More... | |
regIOobject (const IOobject &, const regIOobject &) | |
Construct as copy with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry. More... | |
bool | checkOut () |
Remove object from registry. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | ownedByRegistry () const |
Is this object owned by the registry? More... | |
void | store () |
Transfer ownership of this object to its registry. More... | |
void | release () |
Release ownership of this object from its registry. More... | |
label | eventNo () const |
Event number at last update. More... | |
label & | eventNo () |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set up to date (obviously) More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. More... | |
Istream & | readStream (const word &, const bool valid=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. Return. More... | |
const labelList & | watchIndices () const |
Return file-monitoring handles. More... | |
labelList & | watchIndices () |
Return file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool valid) const |
Write using given format, version and compression. More... | |
virtual bool | write (const bool valid=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &) |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Runtime type information. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Construct from copy resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Construct from copy resetting name. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
virtual | ~IOobject () |
Destructor. More... | |
const Time & | time () const |
Return time. More... | |
const objectRegistry & | db () const |
Return the local objectRegistry. More... | |
const word & | name () const |
Return name. More... | |
const word & | headerClassName () const |
Return name of the class name read from header. More... | |
word & | headerClassName () |
Return name of the class name read from header. More... | |
string & | note () |
Return non-constant access to the optional note. More... | |
const string & | note () const |
Return the optional note. More... | |
bool & | registerObject () |
Register object created from this IOobject with registry if true. More... | |
bool | registerObject () const |
Register object created from this IOobject with registry if true. More... | |
bool & | globalObject () |
Is object same for all processors. More... | |
bool | globalObject () const |
Is object same for all processors. More... | |
readOption | readOpt () const |
readOption & | readOpt () |
writeOption | writeOpt () const |
writeOption & | writeOpt () |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const |
const fileName & | caseName () const |
const fileName & | instance () const |
fileName & | instance () |
const fileName & | local () const |
fileName | path () const |
Return complete path. More... | |
fileName | path (const word &instance, const fileName &local="") const |
Return complete path with alternative instance and local. More... | |
fileName | objectPath () const |
Return complete path + object name. More... | |
fileName | localFilePath (const word &typeName) const |
Helper for filePath that searches locally. More... | |
fileName | globalFilePath (const word &typeName) const |
Helper for filePath that searches up if in parallel. More... | |
bool | readHeader (Istream &) |
Read header. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true) |
Read header (uses typeFilePath to find file) and check header. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &) const |
Write header. More... | |
bool | writeHeader (Ostream &, const word &objectType) const |
Write header. Allow override of type. More... | |
bool | good () const |
bool | bad () const |
InfoProxy< IOobject > | info () const |
Return info proxy. More... | |
void | operator= (const IOobject &) |
template<class Name > | |
Foam::word | groupName (Name name, const word &group) |
Public Member Functions inherited from HashSet< label, Hash< label > > | |
HashSet (const label size=128) | |
Construct given initial size. More... | |
HashSet (Istream &is) | |
Construct from Istream. More... | |
HashSet (const UList< label > &) | |
Construct from UList of Key. More... | |
HashSet (const HashSet< label, Hash< label > > &hs) | |
Construct as copy. More... | |
HashSet (const Xfer< HashSet< label, Hash< label > >> &hs) | |
Construct by transferring the parameter contents. More... | |
HashSet (const Xfer< HashTable< nil, label, Hash< label > >> &hs) | |
Construct by transferring the parameter contents. More... | |
HashSet (const HashTable< AnyType, label, AnyHash > &) | |
Construct from the keys of another HashTable,. More... | |
bool | insert (const label &key) |
Insert a new entry. More... | |
label | insert (const UList< label > &) |
Insert keys from a UList of Key. More... | |
bool | set (const label &key) |
Same as insert (cannot overwrite nil content) More... | |
label | set (const UList< label > &lst) |
Same as insert (cannot overwrite nil content) More... | |
bool | unset (const label &key) |
Unset the specified key - same as erase. More... | |
bool | operator[] (const label &) const |
Return true if the entry exists, same as found() More... | |
bool | operator== (const HashSet< label, Hash< label > > &) const |
Equality. Two hashtables are equal when their contents are equal. More... | |
bool | operator!= (const HashSet< label, Hash< label > > &) const |
The opposite of the equality operation. More... | |
void | operator|= (const HashSet< label, Hash< label > > &) |
Combine entries from HashSets. More... | |
void | operator&= (const HashSet< label, Hash< label > > &) |
Only retain entries found in both HashSets. More... | |
void | operator^= (const HashSet< label, Hash< label > > &) |
Only retain unique entries (xor) More... | |
void | operator+= (const HashSet< label, Hash< label > > &rhs) |
Add entries listed in the given HashSet to this HashSet. More... | |
void | operator-= (const HashSet< label, Hash< label > > &) |
Remove entries listed in the given HashSet from this HashSet. More... | |
Public Member Functions inherited from HashTable< nil, label, Hash< label > > | |
bool | set (const label &, const nil &newElmt) |
Assign a new hashedEntry, overwriting existing entries. More... | |
HashTable (const label size=128) | |
Construct given initial table size. More... | |
HashTable (Istream &, const label size=128) | |
Construct from Istream. More... | |
HashTable (const HashTable< nil, label, Hash< label > > &) | |
Construct as copy. More... | |
HashTable (const Xfer< HashTable< nil, label, Hash< label > >> &) | |
Construct by transferring the parameter contents. More... | |
HashTable (std::initializer_list< Tuple2< label, nil >>) | |
Construct from an initializer list. More... | |
~HashTable () | |
Destructor. More... | |
label | capacity () const |
The size of the underlying table. More... | |
label | size () const |
Return number of elements in table. More... | |
bool | empty () const |
Return true if the hash table is empty. More... | |
bool | found (const label &) const |
Return true if hashedEntry is found in table. More... | |
iterator | find (const label &) |
Find and return an iterator set at the hashedEntry. More... | |
const_iterator | find (const label &) const |
Find and return an const_iterator set at the hashedEntry. More... | |
List< label > | toc () const |
Return the table of contents. More... | |
List< label > | sortedToc () const |
Return the table of contents as a sorted list. More... | |
Ostream & | printInfo (Ostream &) const |
Print information. More... | |
bool | insert (const label &, const nil &newElmt) |
Insert a new hashedEntry. More... | |
bool | erase (const iterator &) |
Erase a hashedEntry specified by given iterator. More... | |
bool | erase (const label &) |
Erase a hashedEntry specified by the given key. More... | |
label | erase (const UList< label > &) |
Remove entries given by the listed keys from this HashTable. More... | |
label | erase (const HashTable< AnyType, label, AnyHash > &) |
Remove entries given by the given keys from this HashTable. More... | |
Foam::label | erase (const HashTable< AnyType, label, AnyHash > &rhs) |
void | resize (const label newSize) |
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 | shrink () |
Shrink the allocated table to approx. twice number of elements. More... | |
void | transfer (HashTable< nil, label, Hash< label > > &) |
Transfer the contents of the argument table into this table. More... | |
Xfer< HashTable< nil, label, Hash< label > > > | xfer () |
Transfer contents to the Xfer container. More... | |
nil & | operator[] (const label &) |
Find and return a hashedEntry. More... | |
const nil & | operator[] (const label &) const |
Find and return a hashedEntry. More... | |
nil & | operator() (const label &) |
Find and return a hashedEntry, create it null if not present. More... | |
void | operator= (const HashTable< nil, label, Hash< label > > &) |
Assignment. More... | |
void | operator= (std::initializer_list< Tuple2< label, nil >>) |
Assignment to an initializer list. More... | |
bool | operator== (const HashTable< nil, label, Hash< label > > &) const |
Equality. Hash tables are equal if the keys and values are equal. More... | |
bool | operator!= (const HashTable< nil, label, Hash< label > > &) const |
The opposite of the equality operation. Takes linear time. 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... | |
Public Member Functions inherited from HashTableCore | |
HashTableCore () | |
Construct null. More... | |
ClassName ("HashTable") | |
Define template name and debug. More... | |
Static Public Member Functions | |
static fileName | localPath (const polyMesh &mesh, const word &name) |
Name of file set will use. More... | |
static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE) |
Return a pointer to a toposet read from file. More... | |
static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, const label size, writeOption w=NO_WRITE) |
Return a pointer to a new toposet of given size. More... | |
static autoPtr< topoSet > | New (const word &setType, const polyMesh &mesh, const word &name, const topoSet &set, writeOption w=NO_WRITE) |
Return a pointer to a new toposet as copy of another toposet. More... | |
Static Public Member Functions inherited from regIOobject | |
template<class Type > | |
static Type & | store (Type *) |
Transfer ownership of the given object pointer to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &) |
Transfer ownership of the given object pointer to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class Name > | |
static word | groupName (Name name, const word &group) |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
template<class Stream > | |
static Stream & | writeBanner (Stream &os, bool noHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
template<class Stream > | |
static Stream & | writeDivider (Stream &os) |
Write the standard file section divider. More... | |
template<class Stream > | |
static Stream & | writeEndDivider (Stream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from HashTableCore | |
static label | canonicalSize (const label) |
Return a canonical (power-of-two) size. More... | |
static iteratorEnd | cend () |
iteratorEnd set to beyond the end of any HashTable More... | |
static iteratorEnd | end () |
iteratorEnd set to beyond the end of any HashTable More... | |
Protected Member Functions | |
void | updateLabels (const labelList &map) |
Update map from map. Used to update cell/face labels. More... | |
void | check (const label maxLabel) |
Check validity of contents. More... | |
void | writeDebug (Ostream &os, const label maxElem, topoSet::const_iterator &iter, label &elemI) const |
Write part of contents nicely formatted. Prints labels only. More... | |
void | writeDebug (Ostream &os, const pointField &coords, const label maxElem, topoSet::const_iterator &iter, label &elemI) const |
Write part of contents nicely formatted. Prints label. More... | |
void | writeDebug (Ostream &os, const pointField &coords, const label maxLen) const |
Write labels and coordinates columnwise to os. Truncate to maxLen. More... | |
topoSet (const topoSet &) | |
Disallow default bitwise copy construct. More... | |
Protected Member Functions inherited from regIOobject | |
bool | readHeaderOk (const IOstream::streamFormat PstreamFormat, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &) |
Set the object state to bad. More... | |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | readOption { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
Enumeration defining the read options. More... | |
enum | writeOption { AUTO_WRITE = 0, NO_WRITE = 1 } |
Enumeration defining the write options. More... | |
enum | fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from HashSet< label, Hash< label > > | |
typedef HashTable< nil, label, Hash< label > >::iterator | iterator |
typedef HashTable< nil, label, Hash< label > >::const_iterator | const_iterator |
Public Types inherited from HashTable< nil, label, Hash< label > > | |
typedef nil | value_type |
Type of values the HashTable contains. More... | |
typedef nil & | reference |
Type that can be used for storing into HashTable::value_type. More... | |
typedef const nil & | const_reference |
Type that can be used for storing into constant. More... | |
typedef label | size_type |
The type that can represent the size of a HashTable. More... | |
Static Public Attributes inherited from regIOobject | |
static float | fileModificationSkew |
Static Public Attributes inherited from IOobject | |
static const NamedEnum< fileCheckTypes, 4 > | fileCheckTypesNames |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
Static Public Attributes inherited from HashTableCore | |
static const label | maxTableSize |
Maximum allowable table size. More... | |
Static Protected Attributes inherited from regIOobject | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
General set of labels of mesh quantity (points, cells, faces).
Contains various 'notImplemented' functions, but I do not want to make this class abstract since it is quite handy to work on topoSets.
Construct from IOobject as explicitly passed type.
Can't use typeName info here since subclasses not yet instantiated
topoSet | ( | const polyMesh & | mesh, |
const word & | wantedType, | ||
const word & | name, | ||
readOption | r = MUST_READ , |
||
writeOption | w = NO_WRITE |
||
) |
Construct from polyMesh and name. Searches for a polyMesh/sets.
directory but not beyond mesh.facesInstance.
Construct empty from additional size of labelHashSet.
Searches for a polyMesh/sets directory but not beyond mesh.facesInstance.
topoSet | ( | const polyMesh & | mesh, |
const word & | name, | ||
const labelHashSet & | , | ||
writeOption | w = NO_WRITE |
||
) |
Construct empty from additional labelHashSet.
Searches for a polyMesh/sets directory but not beyond mesh.facesInstance.
topoSet | ( | const IOobject & | , |
const labelHashSet & | |||
) |
Construct from IOobject and labelHashSet.
|
virtual |
|
protected |
Update map from map. Used to update cell/face labels.
after morphing
Referenced by faceSet::updateMesh(), pointSet::updateMesh(), and cellSet::updateMesh().
|
protected |
Check validity of contents.
Referenced by cellSet::cellSet(), cellZoneSet::cellZoneSet(), faceSet::faceSet(), faceZoneSet::faceZoneSet(), pointSet::pointSet(), and pointZoneSet::pointZoneSet().
|
protected |
Write part of contents nicely formatted. Prints labels only.
Referenced by topoSet::clone(), faceSet::writeDebug(), pointSet::writeDebug(), and cellSet::writeDebug().
|
protected |
Write part of contents nicely formatted. Prints label.
and corresponding coordinate.
|
protected |
Write labels and coordinates columnwise to os. Truncate to maxLen.
TypeName | ( | "topoSet" | ) |
Runtime type information.
Name of file set will use.
Referenced by NamedEnum< directionType, 3 >::names().
declareRunTimeSelectionTable | ( | autoPtr | , |
topoSet | , | ||
word | , | ||
(const polyMesh &mesh, const word &name, readOption r, writeOption w) | , | ||
(mesh, name, r, w) | |||
) |
declareRunTimeSelectionTable | ( | autoPtr | , |
topoSet | , | ||
size | , | ||
(const polyMesh &mesh, const word &name, const label size, writeOption w) | , | ||
(mesh, name, size, w) | |||
) |
declareRunTimeSelectionTable | ( | autoPtr | , |
topoSet | , | ||
set | , | ||
(const polyMesh &mesh, const word &name, const topoSet &set, writeOption w) | , | ||
(mesh, name, set, w) | |||
) |
Clone.
Definition at line 219 of file topoSet.H.
References topoSet::addSet(), topoSet::deleteSet(), topoSet::invert(), topoSet::maxSize(), IOobject::MUST_READ, topoSet::New(), IOobject::NO_WRITE, NotImplemented, topoSet::operator=(), topoSet::subset(), topoSet::sync(), topoSet::updateMesh(), topoSet::writeData(), topoSet::writeDebug(), and topoSet::~topoSet().
|
static |
Return a pointer to a toposet read from file.
Referenced by topoSet::clone().
|
static |
Return a pointer to a new toposet of given size.
|
static |
Return a pointer to a new toposet as copy of another toposet.
|
virtual |
Invert contents. (insert all members 0..maxLen-1 which were not in.
set)
Reimplemented in faceZoneSet, pointZoneSet, and cellZoneSet.
Referenced by topoSet::clone().
|
virtual |
Subset contents. Only elements present in both sets remain.
Reimplemented in faceZoneSet, pointZoneSet, and cellZoneSet.
Referenced by topoSet::clone().
|
virtual |
Add elements present in set.
Reimplemented in faceZoneSet, pointZoneSet, and cellZoneSet.
Referenced by topoSet::clone().
|
virtual |
Delete elements present in set.
Reimplemented in faceZoneSet, pointZoneSet, and cellZoneSet.
Referenced by topoSet::clone().
|
virtual |
Sync set across coupled patches.
Reimplemented in faceZoneSet, cellSet, pointZoneSet, cellZoneSet, faceSet, and pointSet.
Referenced by topoSet::clone().
Write labels columnwise to os. Truncate to maxLen.
|
pure virtual |
Like above but also writes mesh related quantity.
(usually coordinate).
Implemented in cellSet, faceZoneSet, pointZoneSet, cellZoneSet, pointSet, and faceSet.
|
virtual |
Write contents.
Implements regIOobject.
Referenced by topoSet::clone().
|
virtual |
Update any stored data for new labels. Not implemented.
Reimplemented in faceZoneSet, pointZoneSet, cellSet, cellZoneSet, faceSet, and pointSet.
Referenced by topoSet::clone().
Return max allowable index (+1). Not implemented.
Implemented in faceZoneSet, pointZoneSet, cellZoneSet, cellSet, faceSet, and pointSet.
Referenced by topoSet::clone().
Copy labelHashSet part only.
Referenced by topoSet::clone().