Public Member Functions | List of all members
cellSet Class Reference

A collection of cell labels. More...

Inheritance diagram for cellSet:
Inheritance graph
[legend]
Collaboration diagram for cellSet:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("cellSet")
 Runtime type information. More...
 
 cellSet (const IOobject &obj)
 Construct from IOobject. No checking. More...
 
 cellSet (const polyMesh &mesh, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
 Construct from polyMesh and name. Checks for valid cell ids. More...
 
 cellSet (const polyMesh &mesh, const word &name, const label sizes, writeOption w=NO_WRITE)
 Construct empty from size of labelHashSet. More...
 
 cellSet (const polyMesh &mesh, const word &name, const topoSet &, writeOption w=NO_WRITE)
 Construct from existing set. More...
 
 cellSet (const polyMesh &mesh, const word &name, const labelHashSet &, writeOption w=NO_WRITE)
 Construct from labelHashSet. More...
 
 cellSet (const Time &, const word &name, readOption r=MUST_READ, writeOption w=NO_WRITE)
 Construct from objectRegistry and name. More...
 
 cellSet (const Time &, const word &name, const label size, writeOption w=NO_WRITE)
 Construct empty from objectRegistry. More...
 
 cellSet (const Time &, const word &name, const labelHashSet &, writeOption w=NO_WRITE)
 Construct from labelHashSet. More...
 
virtual ~cellSet ()
 Destructor. More...
 
virtual void sync (const polyMesh &mesh)
 Sync cellSet across coupled patches. More...
 
virtual label maxSize (const polyMesh &mesh) const
 Return max index+1. More...
 
virtual void updateMesh (const mapPolyMesh &morphMap)
 Update any stored data for new labels. More...
 
virtual void writeDebug (Ostream &os, const primitiveMesh &, const label maxLen) const
 Write maxLen items with label and coordinates. More...
 
- Public Member Functions inherited from topoSet
 TypeName ("topoSet")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, topoSet, word,( const polyMesh &mesh, const word &name, readOption r, writeOption w ),(mesh, name, r, w))
 
 declareRunTimeSelectionTable (autoPtr, topoSet, size,( const polyMesh &mesh, const word &name, const label size, writeOption w ),(mesh, name, size, w))
 
 declareRunTimeSelectionTable (autoPtr, topoSet, set,( const polyMesh &mesh, const word &name, const topoSet &set, writeOption w ),(mesh, name, set, w))
 
 topoSet (const IOobject &, 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< topoSetclone () 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 writeDebug (Ostream &os, const label maxLen) const
 Write labels columnwise to os. Truncate to maxLen. More...
 
virtual bool writeData (Ostream &) const
 Write contents. 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, transfering 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...
 
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...
 
labeleventNo ()
 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...
 
IstreamreadStream (const word &)
 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...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. 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
 Write using given format, version and compression. More...
 
virtual bool write () const
 Write using setting from DB. 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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, registry, io options. More...
 
 IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
 Construct from path, registry, io options. More...
 
Foam::autoPtr< IOobjectclone () const
 Clone. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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...
 
readOption readOpt () const
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName () const
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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 filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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< IOobjectinfo () 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 ()
 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< labeltoc () const
 Return the table of contents. More...
 
List< labelsortedToc () const
 Return the table of contents as a sorted list. More...
 
OstreamprintInfo (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...
 
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...
 
niloperator[] (const label &)
 Find and return a hashedEntry. More...
 
const niloperator[] (const label &) const
 Find and return a hashedEntry. More...
 
niloperator() (const label &)
 Find and return a hashedEntry, create it null if not present. More...
 
void operator= (const HashTable< nil, label, Hash< label > > &)
 Assignment. 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...
 

Additional Inherited Members

- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. More...
 
- 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...
 
- 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 nilreference
 Type that can be used for storing into HashTable::value_type. More...
 
typedef const nilconst_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 Member Functions inherited from topoSet
static fileName localPath (const polyMesh &mesh, const word &name)
 Name of file set will use. More...
 
static autoPtr< topoSetNew (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< topoSetNew (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< topoSetNew (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)
 
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...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from HashTableCore
static const label maxTableSize
 Maximum allowable table size. More...
 
- Protected Member Functions inherited from topoSet
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 IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

A collection of cell labels.

Source files

Definition at line 48 of file cellSet.H.

Constructor & Destructor Documentation

cellSet ( const IOobject obj)

Construct from IOobject. No checking.

Definition at line 48 of file cellSet.C.

cellSet ( const polyMesh mesh,
const word name,
readOption  r = MUST_READ,
writeOption  w = NO_WRITE 
)

Construct from polyMesh and name. Checks for valid cell ids.

Definition at line 55 of file cellSet.C.

References topoSet::check(), and primitiveMesh::nCells().

Here is the call graph for this function:

cellSet ( const polyMesh mesh,
const word name,
const label  sizes,
writeOption  w = NO_WRITE 
)

Construct empty from size of labelHashSet.

Definition at line 70 of file cellSet.C.

cellSet ( const polyMesh mesh,
const word name,
const topoSet set,
writeOption  w = NO_WRITE 
)

Construct from existing set.

Definition at line 82 of file cellSet.C.

cellSet ( const polyMesh mesh,
const word name,
const labelHashSet set,
writeOption  w = NO_WRITE 
)

Construct from labelHashSet.

Definition at line 94 of file cellSet.C.

cellSet ( const Time runTime,
const word name,
readOption  r = MUST_READ,
writeOption  w = NO_WRITE 
)

Construct from objectRegistry and name.

Definition at line 107 of file cellSet.C.

cellSet ( const Time runTime,
const word name,
const label  size,
writeOption  w = NO_WRITE 
)

Construct empty from objectRegistry.

Definition at line 142 of file cellSet.C.

cellSet ( const Time runTime,
const word name,
const labelHashSet set,
writeOption  w = NO_WRITE 
)

Construct from labelHashSet.

Definition at line 177 of file cellSet.C.

~cellSet ( )
virtual

Destructor.

Definition at line 213 of file cellSet.C.

Member Function Documentation

TypeName ( "cellSet"  )

Runtime type information.

virtual void sync ( const polyMesh mesh)
inlinevirtual

Sync cellSet across coupled patches.

Reimplemented from topoSet.

Reimplemented in cellZoneSet.

Definition at line 143 of file cellSet.H.

References cellSet::maxSize(), cellSet::updateMesh(), and cellSet::writeDebug().

Here is the call graph for this function:

label maxSize ( const polyMesh mesh) const
virtual

Return max index+1.

Implements topoSet.

Reimplemented in cellZoneSet.

Definition at line 219 of file cellSet.C.

References primitiveMesh::nCells().

Referenced by cellSet::sync().

Here is the call graph for this function:

Here is the caller graph for this function:

void updateMesh ( const mapPolyMesh morphMap)
virtual

Update any stored data for new labels.

Reimplemented from topoSet.

Reimplemented in cellZoneSet.

Definition at line 225 of file cellSet.C.

References mapPolyMesh::reverseCellMap(), topoSet::updateLabels(), and cellSet::writeDebug().

Referenced by cellSet::sync().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeDebug ( Ostream os,
const primitiveMesh mesh,
const label  maxLen 
) const
virtual

Write maxLen items with label and coordinates.

Implements topoSet.

Reimplemented in cellZoneSet.

Definition at line 232 of file cellSet.C.

References primitiveMesh::cellCentres(), and topoSet::writeDebug().

Referenced by cellSet::sync(), cellSet::updateMesh(), and cellZoneSet::writeDebug().

Here is the call graph for this function:

Here is the caller graph for this function:


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