A cloud is a registry collection of lagrangian particles. More...
Public Types | |
| enum | geometryType { COORDINATES, POSITIONS } |
| Cloud geometry type (internal or IO representations) More... | |
 Public Types inherited from IOobject | |
| enum | objectState : char { GOOD, BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Public Types inherited from HashTable< regIOobject * > | |
| typedef HashTable< regIOobject *, word, string::hash > | this_type |
| The template instance used for this HashTable. More... | |
| typedef word | key_type |
| The second template parameter, type of keys used. More... | |
| typedef regIOobject * | mapped_type |
| The first template parameter, type of objects contained. More... | |
| typedef regIOobject * | value_type |
| Same as mapped_type for OpenFOAM HashTables. More... | |
| typedef string::hash | hasher |
| The third template parameter, the hash index method. More... | |
| typedef regIOobject * * | pointer |
| Pointer type for storing into value_type objects. More... | |
| typedef regIOobject * & | reference |
| Reference to the stored value_type. More... | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. More... | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. More... | |
| using | key_iterator = key_iterator_base< iterator > |
| Forward iterator returning the key. More... | |
| using | const_key_iterator = key_iterator_base< const_iterator > |
| Forward const iterator returning the key. More... | |
Public Member Functions | |
| TypeName ("cloud") | |
| Runtime type information. More... | |
| cloud (const objectRegistry &obr) | |
| Construct for given objectRegistry and default cloud name. More... | |
| cloud (const objectRegistry &obr, const word &cloudName) | |
| Construct for given objectRegistry and named cloud instance. More... | |
| virtual | ~cloud ()=default |
| Destructor. More... | |
| virtual label | nParcels () const |
| Number of parcels for the hosting cloud. More... | |
| virtual void | autoMap (const mapPolyMesh &) |
| virtual void | readObjects (const objectRegistry &obr) |
| Read particle fields from objects in the obr registry. More... | |
| virtual void | writeObjects (objectRegistry &obr) const |
| Write particle fields as objects into the obr registry. More... | |
| template<class Type > | |
| Foam::IOField< Type > & | createIOField (const word &fieldName, const label nParticle, objectRegistry &obr) |
| Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. More... | |
| objectRegistry (const Time &db, const label nObjects=128) | |
| objectRegistry (const IOobject &io, const label nObjects=128) | |
| virtual | ~objectRegistry () |
| Destructor, with checkOut() for all objects that are ownedByRegistry. More... | |
| const objectRegistry & | thisDb () const |
| Return the object registry. More... | |
| const Time & | time () const |
| Return time. More... | |
| const objectRegistry & | parent () const |
| Return the parent objectRegistry. More... | |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. More... | |
| HashTable< wordHashSet > | classes () const |
| A summary hash of classes used and their associated object names. More... | |
| template<class MatchPredicate > | |
| HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
| label | count (const char *clsName) const |
| The number of objects of the given class name. More... | |
| template<class MatchPredicate > | |
| label | count (const MatchPredicate &matchClass) const |
| The number of objects of the given class name. More... | |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The number of objects of the given class name. More... | |
| template<class Type > | |
| label | count (const bool strict=false) const |
The names of objects with a class satisfying isA<Type> More... | |
| template<class Type , class MatchPredicate > | |
| label | count (const MatchPredicate &matchName) const |
| wordList | names () const |
| The names of all objects. More... | |
| wordList | names (const char *clsName) const |
| The names of objects with the given class name. More... | |
| template<class MatchPredicate > | |
| wordList | names (const MatchPredicate &matchClass) const |
| The names of objects with a matching class name. More... | |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type > | |
| wordList | names () const |
The names of objects with a class satisfying isA<Type>. More... | |
| template<class Type , class MatchPredicate > | |
| wordList | names (const MatchPredicate &matchName) const |
| wordList | sortedNames () const |
| The sorted names of all objects. More... | |
| wordList | sortedNames (const char *clsName) const |
| The sorted names of objects with the given class name. More... | |
| template<class MatchPredicate > | |
| wordList | sortedNames (const MatchPredicate &matchClass) const |
| The sorted names objects with a matching class name. More... | |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type > | |
| wordList | sortedNames () const |
The sorted names of objects with a class satisfying isA<Type> More... | |
| template<class Type , class MatchPredicate > | |
| wordList | sortedNames (const MatchPredicate &matchName) const |
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
| Lookup and return a const sub-objectRegistry. More... | |
| template<class Type > | |
| HashTable< const Type * > | lookupClass (const bool strict=false) const |
Return all objects with a class satisfying isA<Type> More... | |
| template<class Type > | |
| HashTable< Type * > | lookupClass (const bool strict=false) |
Return all objects with a class satisfying isA<Type> More... | |
| bool | found (const word &name, const bool recursive=false) const |
| Can the regIOobject object be found (by name). More... | |
| template<class Type > | |
| bool | foundObject (const word &name, const bool recursive=false) const |
| Is the named Type found? More... | |
| template<class Type > | |
| const Type * | cfindObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. More... | |
| template<class Type > | |
| const Type * | findObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. More... | |
| template<class Type > | |
| Type * | findObject (const word &name, const bool recursive=false) |
| Return non-const pointer to the object of the given Type. More... | |
| template<class Type > | |
| Type * | getObjectPtr (const word &name, const bool recursive=false) const |
| template<class Type > | |
| const Type & | lookupObject (const word &name, const bool recursive=false) const |
| template<class Type > | |
| Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
| label | getEvent () const |
| Return new event number. More... | |
| bool | checkIn (regIOobject *io) const |
| Add a regIOobject to registry. A nullptr is ignored. More... | |
| bool | checkIn (regIOobject &io) const |
| Add a regIOobject to registry. More... | |
| bool | checkOut (regIOobject *io) const |
| bool | checkOut (regIOobject &io) const |
| bool | checkOut (const word &key) const |
| void | clear () |
| Clear all entries from the registry. More... | |
| void | clearStorage () |
| Clear all entries from the registry and the table itself. More... | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by the given iterator. More... | |
| bool | erase (const word &key) |
| Erase an entry specified by the given key. More... | |
| label | erase (std::initializer_list< word > keys) |
| Remove entries given by the listed keys. More... | |
| label | erase (const UList< word > &keys) |
| Remove entries given by the listed keys. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| virtual bool | modified () const |
| Return true if any of the object's files have been modified. More... | |
| void | readModifiedObjects () |
| Read the objects that have been modified. More... | |
| virtual bool | readIfModified () |
| Read object if modified. More... | |
| virtual bool | writeData (Ostream &) const |
| writeData function required by regIOobject but not used. More... | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool valid) const |
| Write the objects using stream options. More... | |
| template<class Type > | |
| const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) find object. More... | |
| template<class Type > | |
| Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) get object pointer, ignoring constness. More... | |
| template<class MatchPredicate > | |
| Foam::HashTable< Foam::wordHashSet > | classesImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| Foam::label | countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) |
| template<class Type , class MatchPredicate > | |
| Foam::label | countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| Foam::wordList | namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort) |
| template<class Type , class MatchPredicate > | |
| Foam::wordList | namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class MatchPredicate > | |
| Foam::HashTable< Foam::wordHashSet > | classes (const MatchPredicate &matchName) const |
| template<class MatchPredicate > | |
| Foam::label | count (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| Foam::label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type , class MatchPredicate > | |
| Foam::label | count (const MatchPredicate &matchName) const |
| template<class Type > | |
| Foam::label | count (const bool strict) const |
| template<class MatchPredicate > | |
| Foam::wordList | names (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| Foam::wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type > | |
| Foam::wordList | names () const |
| template<class Type , class MatchPredicate > | |
| Foam::wordList | names (const MatchPredicate &matchName) const |
| template<class MatchPredicate > | |
| Foam::wordList | sortedNames (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1 , class MatchPredicate2 > | |
| Foam::wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type > | |
| Foam::wordList | sortedNames () const |
| template<class Type , class MatchPredicate > | |
| Foam::wordList | sortedNames (const MatchPredicate &matchName) const |
| template<class Type > | |
| Foam::HashTable< const Type * > | lookupClass (const bool strict) const |
| template<class Type > | |
| Foam::HashTable< Type * > | lookupClass (const bool strict) |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. More... | |
| regIOobject (const IOobject &io, const bool isTime=false) | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. More... | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| bool | checkIn () |
| Add object to registry, if not already registered. More... | |
| bool | checkOut () |
| Remove all file watches and remove object from registry. More... | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? More... | |
| bool | store () |
| void | release (const bool unregister=false) |
| 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 as up-to-date. 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. More... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | write (const bool valid=true) const |
| Write using setting from DB. More... | |
| virtual bool | global () const |
| Is object global. More... | |
| void | operator= (const IOobject &io) |
| Copy assignment. More... | |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType comp, const bool valid) const |
| Write using given format, version and compression. More... | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch) More... | |
| IOobject (const IOobject &)=default | |
| Copy construct. More... | |
| virtual | ~IOobject ()=default |
| Destructor. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, readOption 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) | |
| Copy construct, resetting registry. More... | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. More... | |
| autoPtr< IOobject > | clone () const |
| Clone. More... | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. More... | |
| const objectRegistry & | db () const |
| Return the local objectRegistry. More... | |
| const Time & | time () const |
| Return time. 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 non-constant access to the class name read from header. More... | |
| const string & | note () const |
| Return the optional note. More... | |
| string & | note () |
| Return non-constant access to the optional note. More... | |
| bool | registerObject () const |
| Should object created with this IOobject be registered? More... | |
| bool & | registerObject () |
| Should object created with this IOobject be registered? More... | |
| bool | globalObject () const |
| Is object same for all processors? More... | |
| bool & | globalObject () |
| Is object same for all processors? More... | |
| unsigned | labelByteSize () const |
| The label byte-size, possibly read from the header. More... | |
| unsigned | scalarByteSize () const |
| The scalar byte-size, possibly read from the header. More... | |
| bool | isHeaderClassName (const word &clsName) const |
| Test if headerClassName() equals the given class name. More... | |
| template<class Type > | |
| bool | isHeaderClassName () const |
| Test if headerClassName() equals Type::typeName. More... | |
| readOption | readOpt () const |
| The read option. More... | |
| readOption & | readOpt () |
| Non-constant access to the read option. More... | |
| writeOption | writeOpt () const |
| The write option. More... | |
| writeOption & | writeOpt () |
| Non-constant access to the write option. More... | |
| word | group () const |
| Return group (extension part of name) More... | |
| word | member () const |
| Return member (name without the extension) More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| The complete path. More... | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. More... | |
| fileName | objectPath () const |
| The complete path + object name. More... | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &is) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
| Read header (uses typeFilePath to find file) and check its info. More... | |
| template<class Type > | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. More... | |
| bool | writeHeader (Ostream &os) const |
| Write header. More... | |
| bool | writeHeader (Ostream &os, 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 &io) |
| template<> | |
| bool | isHeaderClassName () const |
Specialization for void always returns true (no headerClassName check). More... | |
| template<class StringType > | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class StringType > | |
| Foam::word | scopedName (StringType scope, const word &name) |
| Public Member Functions inherited from HashTable< regIOobject * > | |
| HashTable () | |
| Default construct with default (128) table capacity. More... | |
| HashTable (const label size) | |
| Construct given initial table capacity. More... | |
| HashTable (Istream &is, const label size=128) | |
| Construct from Istream with default table capacity. More... | |
| HashTable (const this_type &ht) | |
| Copy construct. More... | |
| HashTable (this_type &&rhs) | |
| Move construct. More... | |
| HashTable (std::initializer_list< std::pair< word, regIOobject * >> list) | |
| Construct from an initializer list. More... | |
| ~HashTable () | |
| Destructor. More... | |
| label | capacity () const noexcept |
| The size of the underlying table. More... | |
| label | size () const noexcept |
| The number of elements in table. More... | |
| bool | empty () const noexcept |
| True if the hash table is empty. More... | |
| regIOobject * & | at (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const regIOobject * & | at (const word &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| bool | found (const word &key) const |
| Return true if hashed entry is found in table. More... | |
| iterator | find (const word &key) |
| Find and return an iterator set at the hashed entry. More... | |
| const_iterator | find (const word &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const_iterator | cfind (const word &key) const |
| Find and return an const_iterator set at the hashed entry. More... | |
| const regIOobject * & | lookup (const word &key, const regIOobject * &deflt) const |
| Return hashed entry if it exists, or return the given default. More... | |
| List< word > | toc () const |
| The table of contents (the keys) in unsorted order. More... | |
| List< word > | sortedToc () const |
| The table of contents (the keys) in sorted order. More... | |
| List< word > | sortedToc (const Compare &comp) const |
| Foam::List< word > | sortedToc (const Compare &comp) const |
| List< word > | tocKeys (const UnaryPredicate &pred, const bool invert=false) const |
| Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| List< word > | tocValues (const UnaryPredicate &pred, const bool invert=false) const |
| Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| List< word > | tocEntries (const BinaryPredicate &pred, const bool invert=false) const |
| Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| label | countKeys (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of keys that satisfy the unary predicate. More... | |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| label | countValues (const UnaryPredicate &pred, const bool invert=false) const |
| Count the number of values that satisfy the unary predicate. More... | |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| label | countEntries (const BinaryPredicate &pred, const bool invert=false) const |
| Count the number of entries that satisfy the binary predicate. More... | |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| bool | emplace (const word &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const word &key, const regIOobject * &obj) |
| Copy insert a new entry, not overwriting existing entries. More... | |
| bool | insert (const word &key, regIOobject * &&obj) |
| Move insert a new entry, not overwriting existing entries. More... | |
| bool | set (const word &key, const regIOobject * &obj) |
| Copy assign a new entry, overwriting existing entries. More... | |
| bool | set (const word &key, regIOobject * &&obj) |
| Move assign a new entry, overwriting existing entries. More... | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by given iterator. More... | |
| bool | erase (const word &key) |
| Erase an entry specified by the given key. More... | |
| label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| Remove table entries given by keys of the other hash-table. More... | |
| label | erase (std::initializer_list< word > keys) |
| Remove table entries given by the listed keys. More... | |
| label | erase (InputIter first, InputIter last) |
| Remove multiple entries using an iterator range of keys. More... | |
| label | erase (const FixedList< word, N > &keys) |
| Remove table entries given by the listed keys. More... | |
| label | erase (const UList< word > &keys) |
| Remove table entries given by the listed keys. More... | |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< word, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| Retain table entries given by keys of the other hash-table. More... | |
| Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| label | filterKeys (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their keys. More... | |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| label | filterValues (const UnaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their values. More... | |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| label | filterEntries (const BinaryPredicate &pred, const bool pruning=false) |
| Generalized means to filter table entries based on their key/value. More... | |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| void | resize (const label sz) |
| Resize the hash table for efficiency. More... | |
| void | clear () |
| Clear all entries from table. More... | |
| void | clearStorage () |
| Clear the table entries and the table itself. More... | |
| void | swap (HashTable< regIOobject *, word, string::hash > &rhs) |
| Swap contents into this table. More... | |
| void | transfer (HashTable< regIOobject *, word, string::hash > &rhs) |
| Transfer contents into this table. More... | |
| regIOobject * & | operator[] (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| const regIOobject * & | operator[] (const word &key) const |
| Find and return a hashed entry. FatalError if it does not exist. More... | |
| regIOobject * & | operator() (const word &key) |
| Return existing entry or create a new entry. More... | |
| regIOobject * & | operator() (const word &key, const regIOobject * &deflt) |
| Return existing entry or insert a new entry. More... | |
| void | operator= (const this_type &rhs) |
| Copy assign. More... | |
| void | operator= (std::initializer_list< std::pair< word, regIOobject * >> rhs) |
| Copy assign from an initializer list. More... | |
| void | operator= (this_type &&rhs) |
| Move assign. More... | |
| bool | operator== (const this_type &rhs) const |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. More... | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. More... | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. More... | |
| iterator | begin () |
| iterator set to the beginning of the HashTable More... | |
| const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable More... | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable More... | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) More... | |
| const_iterator | end () const noexcept |
| const_iterator to signal the end (for any HashTable) More... | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) More... | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. More... | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
Static Public Member Functions | |
| template<class Type > | |
| static IOField< Type > & | createIOField (const word &fieldName, const label nParticle, objectRegistry &obr) |
| Helper to construct IOField on a supplied object registry. More... | |
| template<class Type > | |
| static const IOField< Type > * | findIOField (const word &fieldName, const objectRegistry &obr) |
| Locate an IOField within object registry. More... | |
| static const IOField< point > * | findIOPosition (const objectRegistry &obr) |
| Locate the "position" IOField within object registry. More... | |
| template<class Type > | |
| static const IOField< Type > & | lookupIOField (const word &fieldName, const objectRegistry &obr) |
| Lookup an IOField within object registry. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *p) |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &aptr) |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &&aptr) |
| template<class Type > | |
| static Type & | store (tmp< Type > &tptr) |
| template<class Type > | |
| static Type & | store (tmp< Type > &&tptr) |
| 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 StringType > | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. More... | |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| template<class StringType > | |
| static word | scopedName (StringType scope, const word &name) |
| Create scope:name or scope_name string. More... | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. More... | |
| static Ostream & | writeBanner (Ostream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. More... | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. More... | |
Static Public Attributes | |
| static const Enum< geometryType > | geometryTypeNames |
| static const word | prefix |
| The prefix to local: lagrangian. More... | |
| static word | defaultName |
| The default cloud name: defaultCloud. More... | |
| Static Public Attributes inherited from regIOobject | |
| static float | fileModificationSkew |
| static int | maxFileModificationPolls |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. More... | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_') More... | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. More... | |
Additional Inherited Members | |
| Public Attributes inherited from HashTable< regIOobject * > | |
| const typedef regIOobject * * | const_pointer |
| Const pointer type for the stored value_type. More... | |
| const typedef regIOobject * & | const_reference |
| Const reference to the stored value_type. 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... | |
| Istream * | objectStream () |
| Construct and return an IFstream for the object. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from HashTable< regIOobject * > | |
| bool | iterator_erase (node_type *&entry, label &index) |
| Low-level entry erasure using iterator internals. More... | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. More... | |
A cloud is a registry collection of lagrangian particles.
|
strong |
|
explicit |
Construct for given objectRegistry and default cloud name.
| cloud | ( | const objectRegistry & | obr, |
| const word & | cloudName | ||
| ) |
Construct for given objectRegistry and named cloud instance.
|
virtualdefault |
Destructor.
| TypeName | ( | "cloud" | ) |
Runtime type information.
|
virtual |
Number of parcels for the hosting cloud.
Definition at line 77 of file cloud.C.
References NotImplemented.
Referenced by cloudInfo::write().
|
virtual |
Remap the cells of particles corresponding to the mesh topology change
Definition at line 84 of file cloud.C.
References NotImplemented.
|
virtual |
Read particle fields from objects in the obr registry.
Definition at line 90 of file cloud.C.
References NotImplemented.
|
virtual |
Write particle fields as objects into the obr registry.
Definition at line 96 of file cloud.C.
References NotImplemented.
|
static |
Helper to construct IOField on a supplied object registry.
|
inlinestatic |
Locate an IOField within object registry.
Definition at line 142 of file cloud.H.
References objectRegistry::cfindObject().
|
inlinestatic |
Locate the "position" IOField within object registry.
Definition at line 153 of file cloud.H.
References objectRegistry::cfindObject().
Referenced by parcelSelection::calculateFilter(), and particle< Type >::readObjects().
|
inlinestatic |
Lookup an IOField within object registry.
Fatal if not found or wrong type
Definition at line 164 of file cloud.H.
References objectRegistry::lookupObject().
| Foam::IOField<Type>& createIOField | ( | const word & | fieldName, |
| const label | nParticle, | ||
| objectRegistry & | obr | ||
| ) |
Definition at line 34 of file cloudTemplates.C.
References objectRegistry::time(), and Time::timeName().
|
static |
|
static |
The prefix to local: lagrangian.
Definition at line 87 of file cloud.H.
Referenced by CloudSubModelBase< CloudType >::localPath(), Foam::MapLagrangianFields(), ensightCase::newCloud(), particleDistribution::write(), ensightCase::write(), and molecule::writeFields().
|
static |
The default cloud name: defaultCloud.
Definition at line 90 of file cloud.H.
Referenced by nearWallFields::calcAddressing(), dataCloud::read(), and vtkCloud::read().
1.8.17 