List of parcel clouds, with the same interface as an individual parcel cloud. Is a mesh object, so mesh change hooks are provided and will be applied to the contained cloud. This is the object that should be constructed by a solver in order to support the coupled simulation of multiple clouds. An fvModel should *not* construct this object, as that would nest two mesh objects. An fvModel should construct the base parcelCloudList instead. More...
Public Member Functions | |
| parcelClouds (const parcelClouds &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~parcelClouds () |
| Destructor. More... | |
| virtual void | preUpdateMesh () |
| Prepare for mesh update. More... | |
| virtual bool | movePoints () |
| Update for mesh motion. More... | |
| virtual void | topoChange (const polyTopoChangeMap &) |
| Update topology using the given map. More... | |
| virtual void | mapMesh (const polyMeshMap &) |
| Update from another mesh using the given map. More... | |
| virtual void | distribute (const polyDistributionMap &) |
| Redistribute or update using the given distribution map. More... | |
 Public Member Functions inherited from DemandDrivenMeshObject< fvMesh, UpdateableMeshObject, parcelClouds > | |
| virtual | ~DemandDrivenMeshObject () |
| const fvMesh & | mesh () const |
| virtual bool | writeData (Foam::Ostream &) const |
| Pure virtual writaData function. 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 &) | |
| 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... | |
| virtual void | rename (const word &newName) |
| Rename. 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 | modified () const |
| Return true if the object's file (or files for objectRegistry) More... | |
| virtual bool | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const |
| Write using given format, version and compression. More... | |
| virtual bool | write (const bool write=true) const |
| Write using setting from DB. More... | |
| void | operator= (const IOobject &) |
| const fileName & | caseName (const bool global) 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 | filePath (const word &typeName, const bool global) const |
| Return complete path + object name if the file exists. More... | |
| 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... | |
| 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) |
| Public Member Functions inherited from UpdateableMeshObject< fvMesh > | |
| UpdateableMeshObject (regIOobject &io, const fvMesh &mesh) | |
| Public Member Functions inherited from DistributeableMeshObject< Mesh > | |
| DistributeableMeshObject (regIOobject &io, const Mesh &mesh) | |
| Public Member Functions inherited from MoveableMeshObject< Mesh > | |
| MoveableMeshObject (regIOobject &io, const Mesh &mesh) | |
| Public Member Functions inherited from GeometricMeshObject< Mesh > | |
| GeometricMeshObject (regIOobject &io, const Mesh &mesh) | |
| Public Member Functions inherited from TopologicalMeshObject< Mesh > | |
| TopologicalMeshObject (regIOobject &io, const Mesh &mesh) | |
| virtual | ~TopologicalMeshObject ()=default |
| Virtual destructor to make class polymorphic. More... | |
| Public Member Functions inherited from parcelCloudList | |
| parcelCloudList (const wordList &cloudNames, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g) | |
| Construct specified clouds with given carrier fields. More... | |
| parcelCloudList (const wordList &cloudNames, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo) | |
| Construct specified clouds with given carrier fields and thermo. More... | |
| parcelCloudList (const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g) | |
| Construct detected clouds with given carrier fields. More... | |
| parcelCloudList (const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo) | |
| Construct detected clouds with given carrier fields and thermo. More... | |
| parcelCloudList (const parcelCloudList &)=delete | |
| Disallow default bitwise copy construction. More... | |
| ~parcelCloudList () | |
| Destructor. More... | |
| const tmp< volScalarField > | theta () const |
| Return the particle volume fraction field. More... | |
| tmp< fvVectorMatrix > | SU (const volVectorField &U) const |
| Return momentum source term [kg m/s^2]. More... | |
| tmp< volVectorField::Internal > | UTrans () const |
| Momentum transfer [kg m/s]. More... | |
| tmp< volScalarField::Internal > | UCoeff () const |
| Momentum transfer coefficient [kg]. More... | |
| tmp< fvScalarMatrix > | Sh (const volScalarField &hs) const |
| Return sensible enthalpy source term [J/s]. More... | |
| tmp< volScalarField::Internal > | hsTrans () const |
| Sensible enthalpy transfer [J]. More... | |
| tmp< volScalarField::Internal > | hsCoeff () const |
| Sensible enthalpy transfer coefficient [J/K]. More... | |
| tmp< volScalarField > | Ep () const |
| Return equivalent particulate emission [kg/m/s^3]. More... | |
| tmp< volScalarField > | ap () const |
| Return equivalent particulate absorption [1/m]. More... | |
| tmp< volScalarField > | sigmap () const |
| Return equivalent particulate scattering factor [1/m]. More... | |
| tmp< fvScalarMatrix > | SYi (const label speciei, const volScalarField &Yi) const |
| Return mass source term for specie [kg/s]. More... | |
| tmp< fvScalarMatrix > | Srho (const volScalarField &rho) const |
| Return total mass source term [kg/s]. More... | |
| tmp< volScalarField::Internal > | Srho () const |
| Return total mass source [kg/m^3/s]. More... | |
| void | info () |
| Print cloud information. More... | |
| void | evolve () |
| Evolve the cloud. More... | |
| void | storeGlobalPositions () |
| Call this before a topology change. Stores the particles global. More... | |
| void | topoChange (const polyTopoChangeMap &) |
| Update topology using the given map. More... | |
| void | mapMesh (const polyMeshMap &) |
| Update from another mesh using the given map. More... | |
| void | distribute (const polyDistributionMap &) |
| Redistribute or update using the given distribution map. More... | |
| void | operator= (const parcelCloudList &)=delete |
| Disallow default bitwise assignment. More... | |
| Public Member Functions inherited from PtrList< parcelCloud > | |
| PtrList () | |
| Null Constructor. More... | |
| PtrList (const label) | |
| Construct with size specified. More... | |
| PtrList (const PtrList< parcelCloud > &) | |
| Copy constructor. More... | |
| PtrList (const PtrList< parcelCloud > &, const CloneArg &) | |
| Copy constructor with additional argument for clone. More... | |
| PtrList (PtrList< parcelCloud > &&) | |
| Move constructor. More... | |
| PtrList (PtrList< parcelCloud > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| PtrList (const SLPtrList< parcelCloud > &) | |
| Construct as copy of SLPtrList<T> More... | |
| PtrList (Istream &, const INew &) | |
| Construct from Istream using given Istream constructor class. More... | |
| PtrList (Istream &) | |
| Construct from Istream using default Istream constructor class. More... | |
| ~PtrList () | |
| Destructor. More... | |
| void | setSize (const label) |
| Reset size of PtrList. If extending the PtrList, new entries are. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | clear () |
| Clear the PtrList, i.e. set size to zero deleting all the. More... | |
| void | append (parcelCloud *) |
| Append an element at the end of the list. More... | |
| void | append (const autoPtr< parcelCloud > &) |
| void | append (const tmp< parcelCloud > &) |
| void | transfer (PtrList< parcelCloud > &) |
| Transfer the contents of the argument PtrList into this PtrList. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| autoPtr< parcelCloud > | set (const label, parcelCloud *) |
| Set element to given T* and return old element (can be nullptr) More... | |
| autoPtr< parcelCloud > | set (const label, const autoPtr< parcelCloud > &) |
| Set element to given autoPtr<T> and return old element. More... | |
| autoPtr< parcelCloud > | set (const label, const tmp< parcelCloud > &) |
| Set element to given tmp<T> and return old element. More... | |
| void | reorder (const labelUList &oldToNew) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | shuffle (const labelUList &newToOld) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | operator= (const PtrList< parcelCloud > &) |
| Assignment operator. More... | |
| void | operator= (PtrList< parcelCloud > &&) |
| Move assignment operator. More... | |
| Public Member Functions inherited from UPtrList< T > | |
| UPtrList () | |
| Null Constructor. More... | |
| UPtrList (const label) | |
| Construct with size specified. More... | |
| UPtrList (UPtrList< T > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| label | size () const |
| Return the number of elements in the UPtrList. More... | |
| bool | empty () const |
| Return true if the UPtrList is empty (ie, size() is zero) More... | |
| T & | first () |
| Return reference to the first element of the list. More... | |
| const T & | first () const |
| Return reference to first element of the list. More... | |
| T & | last () |
| Return reference to the last element of the list. More... | |
| const T & | last () const |
| Return reference to the last element of the list. More... | |
| void | setSize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | resize (const label) |
| Reset size of UPtrList. This can only be used to set the size. More... | |
| void | clear () |
| Clear the UPtrList, i.e. set size to zero. More... | |
| void | transfer (UPtrList< T > &) |
| Transfer the contents of the argument UPtrList into this. More... | |
| bool | set (const label) const |
| Is element set. More... | |
| T * | set (const label, T *) |
| Set element. Return old element (can be nullptr). More... | |
| void | reorder (const labelUList &oldToNew) |
| Reorders elements. Ordering does not have to be done in. More... | |
| void | shuffle (const labelUList &newToOld) |
| Reorders elements. Ordering does not have to be done in. More... | |
| template<class T2 > | |
| UPtrList< T2 > | convert () |
| Convert to list of different pointer type. More... | |
| template<class T2 > | |
| UPtrList< const T2 > | convert () const |
| Convert to list of different pointer type. More... | |
| const T & | operator[] (const label) const |
| Return element const reference. More... | |
| T & | operator[] (const label) |
| Return element reference. More... | |
| const T * | operator() (const label) const |
| Return element const pointer. More... | |
| T * | operator() (const label) |
| Return element const pointer. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UPtrList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UPtrList. More... | |
| const_iterator | cbegin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | cend () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| const_iterator | begin () const |
| Return an const_iterator to begin traversing the UPtrList. More... | |
| const_iterator | end () const |
| Return an const_iterator to end traversing the UPtrList. More... | |
| template<class T2 > | |
| Foam::UPtrList< T2 > | convert () |
| template<class T2 > | |
| Foam::UPtrList< const T2 > | convert () const |
Protected Member Functions | |
| parcelClouds (const fvMesh &mesh, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g) | |
| Construct with given mesh and carrier fields. More... | |
| parcelClouds (const fvMesh &mesh, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const fluidThermo &carrierThermo) | |
| Construct with given mesh and carrier fields and thermo. More... | |
| Protected Member Functions inherited from DemandDrivenMeshObject< fvMesh, UpdateableMeshObject, parcelClouds > | |
| DemandDrivenMeshObject (const fvMesh &mesh) | |
| Construct from mesh. More... | |
| DemandDrivenMeshObject (const fvMesh &mesh, const IOobject &io) | |
| Construct from mesh and IOobject. 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... | |
| Protected Member Functions inherited from PtrList< parcelCloud > | |
| void | read (Istream &, const INew &inewt) |
| Read from Istream using given Istream constructor class. More... | |
Friends | |
| class | DemandDrivenMeshObject< fvMesh, UpdateableMeshObject, parcelClouds > |
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 UPtrList< T > | |
| typedef T | value_type |
| Type of values the UPtrList contains. More... | |
| typedef T & | reference |
| Type that can be used for storing into UPtrList::value_type objects. More... | |
| typedef const T & | const_reference |
| Type that can be used for storing into constant UPtrList::value_type. More... | |
| Static Public Member Functions inherited from DemandDrivenMeshObject< fvMesh, UpdateableMeshObject, parcelClouds > | |
| static parcelClouds & | New (const fvMesh &mesh) |
| static parcelClouds & | New (const fvMesh &mesh, const Args &... args) |
| static bool | Delete (const fvMesh &mesh) |
| Lookup DemandDrivenMeshObject and delete. More... | |
| static bool | found (const fvMesh &mesh) |
| Return true if this DemandDrivenMeshObject is found. More... | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type > | |
| static Type & | store (Type *) |
| Transfer ownership of the given object pointer to its registry. More... | |
| template<class Type > | |
| static Type & | store (autoPtr< Type > &) |
| Transfer ownership of the given object pointer to its registry. More... | |
| Static Public Member Functions inherited from IOobject | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. More... | |
| template<class Name > | |
| static word | groupName (Name name, const word &group) |
| static word | group (const word &name) |
| Return group (extension part of name) More... | |
| static word | member (const word &name) |
| Return member (name without the extension) More... | |
| template<class Stream > | |
| static Stream & | writeBanner (Stream &os, bool noHint=false) |
| Write the standard OpenFOAM file/dictionary banner. More... | |
| template<class Stream > | |
| static Stream & | writeDivider (Stream &os) |
| Write the standard file section divider. More... | |
| template<class Stream > | |
| static Stream & | writeEndDivider (Stream &os) |
| Write the standard end file divider. More... | |
| Static Public 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 parcelCloudList | |
| static const word | defaultCloudName |
| The default cloud name. More... | |
| static const wordList | defaultCloudNames |
| The default cloud names (i.e., a list of length one with the. More... | |
| static const word | cloudNamesName |
| The name of the clouds file in which multiple cloud names are. More... | |
List of parcel clouds, with the same interface as an individual parcel cloud. Is a mesh object, so mesh change hooks are provided and will be applied to the contained cloud. This is the object that should be constructed by a solver in order to support the coupled simulation of multiple clouds. An fvModel should *not* construct this object, as that would nest two mesh objects. An fvModel should construct the base parcelCloudList instead.
Definition at line 56 of file parcelClouds.H.
|
protected |
Construct with given mesh and carrier fields.
Definition at line 30 of file parcelClouds.C.
|
protected |
Construct with given mesh and carrier fields and thermo.
Definition at line 44 of file parcelClouds.C.
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 60 of file parcelClouds.C.
|
virtual |
Prepare for mesh update.
Definition at line 66 of file parcelClouds.C.
References parcelCloudList::storeGlobalPositions().
|
virtual |
Update for mesh motion.
Implements MoveableMeshObject< Mesh >.
Definition at line 72 of file parcelClouds.C.
|
virtual |
Update topology using the given map.
Implements UpdateableMeshObject< fvMesh >.
Definition at line 78 of file parcelClouds.C.
References parcelCloudList::topoChange().
|
virtual |
Update from another mesh using the given map.
Implements UpdateableMeshObject< fvMesh >.
Definition at line 84 of file parcelClouds.C.
References parcelCloudList::mapMesh().
|
virtual |
Redistribute or update using the given distribution map.
Implements DistributeableMeshObject< Mesh >.
Definition at line 90 of file parcelClouds.C.
References parcelCloudList::distribute().
|
friend |
Definition at line 1 of file parcelClouds.H.
1.9.1 
