A Cloud of passive particles. More...
#include <lagrangian/passiveParticleCloud.H>
Inheritance diagram for passiveParticleCloud: Collaboration diagram for passiveParticleCloud:Public Types | |
| typedef passiveParticle | parcelType |
| Type of parcel the cloud was instantiated for. | |
| Public Types inherited from Cloud< passiveParticle > | |
| typedef passiveParticle | particleType |
| typedef IDLList < passiveParticle >::iterator | iterator |
| typedef IDLList < passiveParticle > ::const_iterator | const_iterator |
Public Member Functions | |
| passiveParticleCloud (const polyMesh &, const word &cloudName="defaultCloud", bool readFields=true) | |
| Construct given mesh. | |
| passiveParticleCloud (const polyMesh &mesh, const word &cloudName, const IDLList< passiveParticle > &particles) | |
| Construct from mesh, cloud name, and a list of particles. | |
| Public Member Functions inherited from Cloud< passiveParticle > | |
| TypeName ("Cloud") | |
| Runtime type information. | |
| Cloud (const polyMesh &mesh, const IDLList< passiveParticle > &particles) | |
| Construct from mesh and a list of particles. | |
| Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< passiveParticle > &particles) | |
| Construct from mesh, cloud name, and a list of particles. | |
| Cloud (const polyMesh &mesh, const bool checkClass=true) | |
| Construct from mesh by reading from file. | |
| Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true) | |
| Construct from mesh by reading from file with given cloud instance. | |
| const polyMesh & | pMesh () const |
| Return the polyMesh reference. | |
| bool | internalFace (const label facei) const |
| Is this global face an internal face? | |
| bool | boundaryFace (const label facei) const |
| Is this global face a boundary face? | |
| label | facePatch (const label facei) const |
| Which patch is this global face on. | |
| label | patchFace (const label patchi, const label facei) const |
| Which face of this patch is this global face. | |
| label | size () const |
| Return number of elements in table. | |
| const const_iterator | begin () const |
| const_iterator set to the beginning of the HashTable | |
| iterator | begin () |
| iterator set to the begining of the HashTable | |
| const const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable | |
| const const_iterator | end () const |
| const_iterator set to beyond the end of the HashTable | |
| iterator | end () |
| iterator set to beyond the end of the HashTable | |
| const const_iterator | cend () const |
| const_iterator set to beyond the end of the HashTable | |
| void | clear () |
| Clear the contents of the list. | |
| label | getNewParticleID () const |
| Get unique particle creation id. | |
| void | addParticle (passiveParticle *pPtr) |
| Transfer particle to cloud. | |
| void | deleteParticle (passiveParticle &) |
| Remove particle from cloud and delete. | |
| void | move (TrackingData &td) |
| Move the particles. | |
| virtual void | autoMap (const mapPolyMesh &) |
| Remap the cells of particles corresponding to the. | |
| IOobject | fieldIOobject (const word &fieldName, const IOobject::readOption r) const |
| Helper to construct IOobject for field and current time. | |
| void | checkFieldIOobject (const Cloud< passiveParticle > &c, const IOField< DataType > &data) const |
| Check lagrangian data field. | |
| virtual void | readFields () |
| Read the field data for the cloud of particles. Dummy at. | |
| virtual void | writeFields () const |
| Write the field data for the cloud of particles Dummy at. | |
| virtual bool | writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const |
| Write using given format, version and compression. | |
| void | writePositions () const |
| Write positions to <cloudName>_positions.obj file. | |
| Public Member Functions inherited from cloud | |
| TypeName ("cloud") | |
| Runtime type information. | |
| cloud (const objectRegistry &, const word &cloudName="") | |
| Construct for the given objectRegistry and named cloud instance. | |
| virtual | ~cloud () |
| Destructor. | |
| Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. | |
| objectRegistry (const Time &db, const label nIoObjects=128) | |
| Construct the time objectRegistry given an initial estimate. | |
| objectRegistry (const IOobject &io, const label nIoObjects=128) | |
| Construct a sub-registry given an IObject to describe the registry. | |
| virtual | ~objectRegistry () |
| const Time & | time () const |
| Return time. | |
| const objectRegistry & | parent () const |
| Return the parent objectRegistry. | |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. | |
| wordList | names () const |
| Return the list of names of the IOobjects. | |
| wordList | names (const word &className) const |
| Return the list of names of the IOobjects of given class name. | |
| template<class Type > | |
| wordList | names () const |
| Return the list of names of the IOobjects of given type. | |
| const objectRegistry & | subRegistry (const word &name) const |
| Lookup and return a const sub-objectRegistry. | |
| template<class Type > | |
| HashTable< const Type * > | lookupClass () const |
| Lookup and return all the object of the given Type. | |
| template<class Type > | |
| bool | foundObject (const word &name) const |
| Is the named Type. | |
| template<class Type > | |
| const Type & | lookupObject (const word &name) const |
| Lookup and return the object of the given Type. | |
| label | getEvent () const |
| Return new event number. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| bool | checkIn (regIOobject &) const |
| Add an regIOobject to registry. | |
| bool | checkOut (regIOobject &) const |
| Remove an regIOobject from registry. | |
| virtual bool | modified () const |
| Return true if any of the object's files have been modified. | |
| void | readModifiedObjects () |
| Read the objects that have been modified. | |
| virtual bool | readIfModified () |
| Read object if modified. | |
| virtual bool | writeData (Ostream &) const |
| writeData function required by regIOobject but not used | |
| Public Member Functions inherited from regIOobject | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &, const bool isTime=false) | |
| Construct from IOobject. Optional flag for if IOobject is the. | |
| regIOobject (const regIOobject &) | |
| Construct as copy. | |
| regIOobject (const regIOobject &, bool registerCopy) | |
| Construct as copy, and transferring registry registration to copy. | |
| virtual | ~regIOobject () |
| bool | checkIn () |
| Add object to registry. | |
| bool | checkOut () |
| Remove object from registry. | |
| bool | ownedByRegistry () const |
| Is this object owned by the registry? | |
| void | store () |
| Transfer ownership of this object to its registry. | |
| void | release () |
| Release ownership of this object from its registry. | |
| label | eventNo () const |
| Event number at last update. | |
| label & | eventNo () |
| Event number at last update. | |
| bool | upToDate (const word &) const |
| Am I uptodate with respect to other regIOobjects. | |
| bool | upToDate (const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &) const |
| bool | upToDate (const word &, const word &, const word &, const word &) const |
| void | setUpToDate () |
| Flag me as up to date. | |
| Istream & | readStream (const word &) |
| Return Istream and check object type against that given. | |
| void | close () |
| Close Istream. | |
| virtual bool | readData (Istream &) |
| Virtual readData function. | |
| virtual bool | read () |
| Read object. | |
| virtual bool | write () const |
| Write using setting from DB. | |
| void | operator= (const IOobject &) |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. | |
| 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. | |
| 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. | |
| IOobject (const fileName &path, const objectRegistry ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. | |
| Foam::autoPtr< IOobject > | clone () const |
| Clone. | |
| virtual | ~IOobject () |
| const objectRegistry & | db () const |
| Return the local objectRegistry. | |
| const word & | name () const |
| Return name. | |
| const word & | headerClassName () const |
| Return name of the class name read from header. | |
| string & | note () |
| Return non-constant access to the optional note. | |
| const string & | note () const |
| Return the optional note. | |
| bool | registerObject () const |
| Register object created from this IOobject with registry if true. | |
| readOption | readOpt () const |
| readOption & | readOpt () |
| writeOption | writeOpt () const |
| writeOption & | writeOpt () |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. | |
| fileName | objectPath () const |
| Return complete path + object name. | |
| fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | readHeader (Istream &) |
| Read header. | |
| bool | headerOk () |
| Read and check header info. | |
| bool | writeHeader (Ostream &) const |
| Write header. | |
| bool | good () const |
| bool | bad () const |
| InfoProxy< IOobject > | info () const |
| Return info proxy. | |
| Public Member Functions inherited from HashTable< regIOobject * > | |
| bool | set (const word &, const regIOobject *&newElmt) |
| Assign a new hashedEntry, overwriting existing entries. | |
| HashTable (const label size=128) | |
| Construct given initial table size. | |
| HashTable (Istream &, const label size=128) | |
| Construct from Istream. | |
| HashTable (const HashTable< regIOobject *, word, string::hash > &) | |
| Construct as copy. | |
| HashTable (const Xfer< HashTable< regIOobject *, word, string::hash > > &) | |
| Construct by transferring the parameter contents. | |
| ~HashTable () | |
| bool | empty () const |
| Return true if the hash table is empty. | |
| bool | found (const word &) const |
| Return true if hashedEntry is found in table. | |
| iterator | find (const word &) |
| Find and return an iterator set at the hashedEntry. | |
| const_iterator | find (const word &) const |
| Find and return an const_iterator set at the hashedEntry. | |
| List< word > | toc () const |
| Return the table of contents. | |
| List< word > | sortedToc () const |
| Return the table of contents as a sorted list. | |
| Ostream & | printInfo (Ostream &) const |
| Print information. | |
| bool | insert (const word &, const regIOobject *&newElmt) |
| Insert a new hashedEntry. | |
| bool | erase (const iterator &) |
| Erase an hashedEntry specified by given iterator. | |
| bool | erase (const word &) |
| Erase an hashedEntry specified by given key if in table. | |
| label | erase (const UList< word > &) |
| Remove entries given by the listed keys from this HashTable. | |
| label | erase (const HashTable< AnyType, word, AnyHash > &) |
| Remove entries given by the given keys from this HashTable. | |
| void | resize (const label newSize) |
| Resize the hash table for efficiency. | |
| void | clearStorage () |
| Clear the table entries and the table itself. | |
| void | transfer (HashTable< regIOobject *, word, string::hash > &) |
| Transfer the contents of the argument table into this table. | |
| Xfer< HashTable< regIOobject *, word, string::hash > > | xfer () |
| Transfer contents to the Xfer container. | |
| regIOobject *& | operator[] (const word &) |
| Find and return an hashedEntry. | |
| const regIOobject *& | operator[] (const word &) const |
| Find and return an hashedEntry. | |
| regIOobject *& | operator() (const word &) |
| Find and return an hashedEntry, create it null if not present. | |
| void | operator= (const HashTable< regIOobject *, word, string::hash > &) |
| Assignment. | |
| bool | operator== (const HashTable< regIOobject *, word, string::hash > &) const |
| Equality. Two hash tables are equal if all contents of first are. | |
| bool | operator!= (const HashTable< regIOobject *, word, string::hash > &) const |
| The opposite of the equality operation. Takes linear time. | |
| Public Member Functions inherited from IDLList< passiveParticle > | |
| IDLList () | |
| Null construct. | |
| IDLList (const passiveParticle &a) | |
| Construct given initial T. | |
| IDLList (Istream &is, const INew &inewt) | |
| Construct from Istream using given Istream constructor class. | |
| IDLList (Istream &is) | |
| Construct from Istream. | |
| IDLList (const IDLList< passiveParticle > &idll, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone. | |
| Public Member Functions inherited from ILList< DLListBase, passiveParticle > | |
| ILList () | |
| Null construct. | |
| ILList (passiveParticle *a) | |
| Construct given initial T. | |
| ILList (Istream &) | |
| Construct from Istream. | |
| ILList (const ILList< DLListBase, passiveParticle > &) | |
| Construct as copy. | |
| ILList (const ILList< DLListBase, passiveParticle > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone. | |
| ILList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. | |
| ~ILList () | |
| bool | eraseHead () |
| Remove the head element specified from the list and delete it. | |
| bool | erase (passiveParticle *p) |
| Remove the specified element from the list and delete it. | |
| void | transfer (ILList< DLListBase, passiveParticle > &) |
| Transfer the contents of the argument into this List. | |
| void | operator= (const ILList< DLListBase, passiveParticle > &) |
| Public Member Functions inherited from UILList< DLListBase, passiveParticle > | |
| UILList () | |
| Null construct. | |
| UILList (passiveParticle *a) | |
| Construct given initial T. | |
| UILList (const UILList< DLListBase, passiveParticle > &) | |
| Construct as copy. | |
| passiveParticle * | first () |
| Return the first entry. | |
| const passiveParticle * | first () const |
| Return the first entry. | |
| passiveParticle * | last () |
| Return the last entry. | |
| const passiveParticle * | last () const |
| Return the last entry. | |
| passiveParticle * | removeHead () |
| Remove and return head. | |
| passiveParticle * | remove (passiveParticle *p) |
| Remove and return element. | |
| passiveParticle * | remove (iterator &it) |
| Remove and return specified by iterator. | |
| void | operator= (const UILList< DLListBase, passiveParticle > &) |
| bool | operator== (const UILList< DLListBase, passiveParticle > &) const |
| Equality operation on ULists of the same type. | |
| bool | operator!= (const UILList< DLListBase, passiveParticle > &) const |
| The opposite of the equality operation. Takes linear time. | |
| Public Member Functions inherited from DLListBase | |
| DLListBase () | |
| Null construct. | |
| DLListBase (link *) | |
| Construct given initial entry. | |
| ~DLListBase () | |
| bool | empty () const |
| Return true if the list is empty. | |
| void | insert (link *) |
| Add at head of list. | |
| void | append (link *) |
| Add at tail of list. | |
| bool | swapUp (link *) |
| Swap this element with the one above unless it is at the top. | |
| bool | swapDown (link *) |
| Swap this element with the one below unless it is at the bottom. | |
| link * | remove (link *) |
| Remove and return element. | |
| link * | replace (link *oldLink, link *newLink) |
| Replace oldLink with newLink and return element. | |
| link * | replace (iterator &oldIter, link *newLink) |
| Replace oldIter with newLink and return element. | |
| void | transfer (DLListBase &) |
| Transfer the contents of the argument into this List. | |
Additional Inherited Members | |
| Static Public Attributes inherited from Cloud< passiveParticle > | |
| static word | cloudPropertiesName |
| Name of cloud properties dictionary. | |
| Static Public Attributes inherited from cloud | |
| static const word | prefix |
| The prefix to local: lagrangian. | |
| static word | defaultName |
| The default cloud name: defaultCloud. | |
| typedef passiveParticle parcelType |
Type of parcel the cloud was instantiated for.
Definition at line 66 of file passiveParticleCloud.H.
| passiveParticleCloud | ( | const polyMesh & | mesh, |
| const word & | cloudName = "defaultCloud", |
||
| bool | readFields = true |
||
| ) |
Construct given mesh.
Definition at line 43 of file passiveParticleCloud.C.
References Foam::readFields().
| passiveParticleCloud | ( | const polyMesh & | mesh, |
| const word & | cloudName, | ||
| const IDLList< passiveParticle > & | particles | ||
| ) |
Construct from mesh, cloud name, and a list of particles.
Definition at line 59 of file passiveParticleCloud.C.
