A cloud is a collection of lagrangian particles. More...
Public Member Functions | |
| TypeName ("cloud") | |
| Runtime type information. More... | |
| cloud (const objectRegistry &, const word &cloudName=defaultName) | |
| Construct for the given objectRegistry and named cloud instance. More... | |
| cloud (const cloud &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~cloud () |
| Destructor. More... | |
| virtual void | autoMap (const polyTopoChangeMap &) |
| Remap the cells of particles corresponding to the. More... | |
| void | operator= (const cloud &)=delete |
| Disallow default bitwise assignment. More... | |
 Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. More... | |
| objectRegistry (const Time &db, const label nIoObjects=128) | |
| Construct the time objectRegistry given an initial estimate. More... | |
| objectRegistry (const IOobject &io, const label nIoObjects=128) | |
| Construct a sub-registry given an IObject to describe the registry. More... | |
| objectRegistry (const objectRegistry &) | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~objectRegistry () |
| Destructor. 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... | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. More... | |
| wordList | names () const |
| Return the list of names of the IOobjects. More... | |
| wordList | sortedNames () const |
| Return the sorted list of names of the IOobjects. More... | |
| wordList | names (const word &className) const |
| Return the list of names of IOobjects of given class name. More... | |
| wordList | sortedNames (const word &className) const |
| Return the sorted list of names of IOobjects of given class name. More... | |
| template<class Type > | |
| wordList | names () const |
| Return the list of names of the IOobjects of given type. More... | |
| template<class Type > | |
| wordList | names (const wordRe &name) const |
| Return the list of objects whose name matches the input regExp. More... | |
| template<class Type > | |
| wordList | names (const wordReList &name) const |
| Return the list of objects whose name matches the input regExp. More... | |
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false) const |
| Lookup and return a const sub-objectRegistry. Optionally create. More... | |
| template<class Type > | |
| HashTable< const Type * > | lookupClass (const bool strict=false) const |
| Lookup and return all objects of the given Type. More... | |
| template<class Type > | |
| HashTable< Type * > | lookupClass (const bool strict=false) |
| Lookup and return all objects of the given Type. More... | |
| template<class Type > | |
| bool | foundObject (const word &name) const |
| Is the named Type found? More... | |
| template<class Type > | |
| const Type & | lookupObject (const word &name) const |
| Lookup and return the object of the given Type. More... | |
| template<class Type > | |
| Type & | lookupObjectRef (const word &name) const |
| Lookup and return the object reference of the given Type. More... | |
| label | getEvent () const |
| Return new event number. More... | |
| const objectRegistry & | thisDb () const |
| Return the object registry. More... | |
| virtual void | rename (const word &newName) |
| Rename. More... | |
| bool | checkIn (regIOobject &) const |
| Add an regIOobject to registry. More... | |
| bool | checkOut (regIOobject &) const |
| Remove an regIOobject from registry. More... | |
| void | clear () |
| Remove all regIOobject owned by the registry. More... | |
| void | addTemporaryObject (const word &name) const |
| Add the given name to the set of temporary objects to cache. More... | |
| bool | cacheTemporaryObject (const word &name) const |
| Return true if given name is in the cacheTemporaryObjects set. More... | |
| template<class Object > | |
| bool | cacheTemporaryObject (Object &ob) const |
| Cache the given object. More... | |
| void | resetCacheTemporaryObject (const regIOobject &ob) const |
| Reset the cache state of the given object. More... | |
| bool | checkCacheTemporaryObjects () const |
| Check that all objects in the cacheTemporaryObjects set. 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 (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp, const bool write) const |
| Write the objects. More... | |
| void | operator= (const objectRegistry &)=delete |
| Disallow default bitwise assignment. More... | |
| template<class Type > | |
| Foam::wordList | names () const |
| template<class Type > | |
| Foam::wordList | names (const wordRe &name) const |
| template<class Type > | |
| Foam::wordList | names (const wordReList &patterns) 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 &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. More... | |
| regIOobject (const regIOobject &) | |
| Copy constructor. More... | |
| regIOobject (const regIOobject &&) | |
| Move constructor. More... | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Copy constructor, transferring registry registration to copy. More... | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy constructor with new name, transferring registry registration. More... | |
| regIOobject (const IOobject &, const regIOobject &) | |
| Copy constructor with new IO parameters. More... | |
| virtual | ~regIOobject () |
| Destructor. More... | |
| virtual bool | global () const |
| Return true if object is global, i.e. same for all processors. More... | |
| virtual bool | globalFile () const |
| Return true if object is global, i.e. same for all processors. More... | |
| const fileName & | caseName () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. More... | |
| bool | checkIn () |
| Add object to registry. More... | |
| bool | checkOut () |
| Remove object from registry. More... | |
| void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
| bool | registered () const |
| Is this object registered with the 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... | |
| 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... | |
| bool | headerOk () |
| Read and check header info. More... | |
| Istream & | readStream (const word &, const bool read=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... | |
| const labelList & | watchIndices () const |
| Return file-monitoring handles. More... | |
| labelList & | watchIndices () |
| Return file-monitoring handles. More... | |
| virtual bool | write (const bool write=true) 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 ®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) | |
| 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) | |
| 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... | |
| IOobject (const IOobject &io)=default | |
| Copy constructor. 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... | |
| 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... | |
| word | modelName (const char *name) const |
| Return the name of the object within this model. More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName (const bool global) const |
| fileName & | instance () const |
| Return the instance directory, constant, system, <time> etc. More... | |
| void | updateInstance () const |
| If the instance is a time directory update to the current time. More... | |
| const fileName & | local () const |
| fileName | path (const bool global) const |
| Return complete path including the processor sub-directory. More... | |
| fileName | objectPath (const bool global) const |
| Return complete path + object name including the processor. More... | |
| fileName | relativePath () const |
| Return the path relative to the case directory. More... | |
| fileName | relativeObjectPath () const |
| Return complete relativePath + object name. More... | |
| fileName | filePath (const word &typeName, const bool global) const |
| Return complete path + object name if the file exists. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| bool | headerOk () |
| Read header of local object without type-checking. 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) |
| template<class Name > | |
| Foam::word | modelName (Name name, const word &model) |
| Public Member Functions inherited from HashTable< regIOobject *> | |
| bool | set (const word &, const regIOobject * &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< regIOobject *, word, string::hash > &) | |
| Copy constructor. More... | |
| HashTable (HashTable< regIOobject *, word, string::hash > &&) | |
| Move constructor. More... | |
| HashTable (std::initializer_list< Tuple2< word, regIOobject * >>) | |
| Construct from an initialiser 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 word &) const |
| Return true if hashedEntry is found in table. More... | |
| iterator | find (const word &) |
| Find and return an iterator set at the hashedEntry. More... | |
| const_iterator | find (const word &) const |
| Find and return an const_iterator set at the hashedEntry. More... | |
| List< word > | toc () const |
| Return the table of contents. More... | |
| List< word > | sortedToc () const |
| Return the table of contents as a sorted list. More... | |
| Ostream & | printInfo (Ostream &) const |
| Print information. More... | |
| bool | insert (const word &, const regIOobject * &newElmt) |
| Insert a new hashedEntry. More... | |
| bool | erase (const iterator &) |
| Erase a hashedEntry specified by given iterator. More... | |
| bool | erase (const word &) |
| Erase a hashedEntry specified by the given key. More... | |
| label | erase (const UList< word > &) |
| Remove entries given by the listed keys from this HashTable. More... | |
| label | erase (const HashTable< AnyType, word, AnyHash > &) |
| Remove entries given by the given keys from this HashTable. More... | |
| Foam::label | erase (const HashTable< AnyType, word, 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< regIOobject *, word, string::hash > &) |
| Transfer the contents of the argument table into this table. More... | |
| regIOobject * & | operator[] (const word &) |
| Find and return a hashedEntry. More... | |
| const regIOobject * & | operator[] (const word &) const |
| Find and return a hashedEntry. More... | |
| regIOobject * & | operator() (const word &) |
| Find and return a hashedEntry, create it null if not present. More... | |
| void | operator= (const HashTable< regIOobject *, word, string::hash > &) |
| Assignment operator. More... | |
| void | operator= (HashTable< regIOobject *, word, string::hash > &&) |
| Move assignment operator. More... | |
| void | operator= (std::initializer_list< Tuple2< word, regIOobject * >>) |
| Assignment to an initialiser list. More... | |
| bool | operator== (const HashTable< regIOobject *, word, string::hash > &) const |
| Equality. Hash tables are equal if the keys and values are equal. More... | |
| bool | operator!= (const HashTable< regIOobject *, word, string::hash > &) 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 Attributes | |
| 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 Public Attributes inherited from IOobject | |
| static constexpr const char * | foamFile = "FoamFile" |
| Keyword for the FoamFile header sub-dictionary. More... | |
| 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... | |
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 HashTable< regIOobject *> | |
| typedef regIOobject * | value_type |
| Type of values the HashTable contains. More... | |
| typedef regIOobject * & | reference |
| Type that can be used for storing into HashTable::value_type. More... | |
| typedef const regIOobject * & | 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 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 Name > | |
| static word | modelName (Name name, const word &model) |
| Return the name of the object within the given model. 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 inherited from regIOobject | |
| bool | readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName) |
| Read header, check readOpt flags and read data if necessary. More... | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
A cloud is a collection of lagrangian particles.
| cloud | ( | const objectRegistry & | obr, |
| const word & | cloudName = defaultName |
||
| ) |
Construct for the given objectRegistry and named cloud instance.
| TypeName | ( | "cloud" | ) |
Runtime type information.
|
virtual |
Remap the cells of particles corresponding to the.
mesh topology change
Reimplemented in MomentumCloud< CloudType >, MomentumCloud< Foam::DSMCCloud >, DSMCCloud< ParcelType >, ThermoCloud< CloudType >, ThermoCloud< Foam::DSMCCloud >, ReactingCloud< CloudType >, ReactingCloud< Foam::DSMCCloud >, ReactingMultiphaseCloud< CloudType >, ReactingMultiphaseCloud< Foam::DSMCCloud >, Cloud< ParticleType >, Cloud< Foam::passiveParticle >, Cloud< indexedParticle >, Cloud< ParcelType >, Cloud< Foam::molecule >, Cloud< solidParticle >, Cloud< parcelType >, Cloud< molecule >, Cloud< sampledSetParticle >, Cloud< typename CloudType::parcelType >, Cloud< streamlinesParticle >, and Cloud< passiveParticle >.
Definition at line 67 of file cloud.C.
References NotImplemented.
|
static |
The prefix to local: lagrangian.
Definition at line 62 of file cloud.H.
Referenced by CloudFunctionObject< CloudType >::CloudFunctionObject(), Foam::MapLagrangianFields(), and molecule::writeFields().
|
static |
The default cloud name: defaultCloud.
Definition at line 65 of file cloud.H.
Referenced by nearWallFields::calcAddressing().
1.8.13 
