Basic cloud with spherical, variable density, particles, grouped into parcels. More...
Public Member Functions | |
| TypeName ("parcel") | |
| Run-time type information. More... | |
| parcel (const polyMesh &mesh, const word &name, const contextType context, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE) | |
| Construct from a mesh and a name. More... | |
| virtual | ~parcel () |
| Destructor. More... | |
| virtual void | solve () |
| Solve the cloud's evolution over the current time-step. More... | |
 Public Member Functions inherited from cloud | |
| TypeName ("cloud") | |
| Run-time type information. More... | |
| declareRunTimeSelectionTable (autoPtr, cloud, polyMesh,(const polyMesh &mesh, const word &name, const contextType context),(mesh, name, context)) | |
| Declare run-time constructor selection table. More... | |
| cloud (const polyMesh &mesh, const word &name, const contextType context, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE) | |
| Construct from a mesh and a name. More... | |
| cloud (const cloud &)=delete | |
| Disallow default bitwise copy construction. More... | |
| virtual | ~cloud () |
| Destructor. More... | |
| const LagrangianMesh & | mesh () const |
| Access the mesh. More... | |
| Foam::LagrangianModels & | LagrangianModels () const |
| Access the models. More... | |
| template<class Type , class ... Args> | |
| CloudStateField< Type > & | stateField (const Args &... args) const |
| Add/get a state field to/from the cache. More... | |
| template<class Type , class ... Args> | |
| const CloudDerivedField< Type > & | derivedField (const Args &... args) const |
| Add/get a derived field to/from the cache. More... | |
| template<class Type , class ... Args> | |
| const CloudAverageField< Type > & | averageField (const Args &... args) const |
| Add/get an average field to/from the cache. More... | |
| virtual void | storePosition () |
| Store the positions for use during mapping. More... | |
| virtual void | movePoints (const polyMesh &) |
| 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... | |
| void | operator= (const LagrangianMesh &)=delete |
| Disallow default bitwise assignment. More... | |
| template<class Type , class ... Args> | |
| Foam::CloudStateField< Type > & | stateField (const Args &... args) const |
| template<class Type , class ... Args> | |
| const Foam::CloudDerivedField< Type > & | derivedField (const Args &... args) const |
| template<class Type , class ... Args> | |
| const Foam::CloudAverageField< Type > & | averageField (const Args &... args) const |
| 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 (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 | dependenciesModified () const |
| Return true if the object's dependencies have been modified. 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 &)=delete |
| Assign to IOobject. More... | |
| void | operator= (const regIOobject &)=delete |
| Disallow default assignment. More... | |
| 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 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... | |
| void | updateTimeInstance () const |
| Update instance 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 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 grouped | |
| TypeName ("grouped") | |
| Run-time type information. More... | |
| grouped (const cloud &) | |
| Construct from a reference to the cloud. More... | |
| virtual | ~grouped () |
| Destructor. More... | |
| Public Member Functions inherited from spherical | |
| TypeName ("spherical") | |
| Run-time type information. More... | |
| spherical (const cloud &) | |
| Construct from a reference to the cloud. More... | |
| spherical (const cloud &, const grouped &) | |
| Construct from a reference to the cloud and its base classes. More... | |
| virtual | ~spherical () |
| Destructor. More... | |
| Public Member Functions inherited from shaped | |
| TypeName ("shaped") | |
| Run-time type information. More... | |
| shaped (const cloud &) | |
| Construct from a reference to the cloud. More... | |
| shaped (const cloud &, const grouped &) | |
| Construct from a reference to the cloud and its base classes. More... | |
| virtual | ~shaped () |
| Destructor. More... | |
| Public Member Functions inherited from massive | |
| TypeName ("massive") | |
| Run-time type information. More... | |
| massive (const cloud &, const shaped &) | |
| Construct from a reference to the cloud and its base classes. More... | |
| virtual | ~massive () |
| Destructor. More... | |
| Public Member Functions inherited from coupledToFluid | |
| TypeName ("coupledToFluid") | |
| Run-time type information. More... | |
| coupledToFluid (const cloud &) | |
| Construct from a reference to the cloud. More... | |
| virtual | ~coupledToFluid () |
| Destructor. More... | |
| Public Member Functions inherited from coupled | |
| TypeName ("coupled") | |
| Run-time type information. More... | |
| coupled (const cloud &c) | |
| Construct from a reference to the cloud. More... | |
| virtual | ~coupled () |
| Destructor. More... | |
| template<class Type > | |
| const CarrierField< Type > & | carrierField (const VolField< Type > &) const |
| Add/get a carrier field to/from the cache. More... | |
| template<class Type , class ... Args> | |
| const CarrierField< Type > & | carrierField (const Args &... args) const |
| Add/get a carrier field to/from the cache. More... | |
| template<class Type > | |
| CarrierEqn< Type > & | carrierEqn (const VolField< Type > &) |
| Add/get a carrier equation to/from the cache. More... | |
| template<class Type > | |
| const CarrierEqn< Type > & | carrierEqn (const VolField< Type > &) const |
| Add/get a carrier equation to/from the cache. More... | |
| template<class Type > | |
| CarrierEqn< Type > & | carrierEqn (const CarrierField< Type > &) |
| Add/get a carrier equation to/from the cache. More... | |
| template<class Type > | |
| const CarrierEqn< Type > & | carrierEqn (const CarrierField< Type > &) const |
| Add/get a carrier equation to/from the cache. More... | |
| template<class Type > | |
| const Foam::CarrierField< Type > & | carrierField (const VolField< Type > &psi) const |
| template<class Type , class ... Args> | |
| const Foam::CarrierField< Type > & | carrierField (const Args &... args) const |
| template<class Type > | |
| Foam::CarrierEqn< Type > & | carrierEqn (const VolField< Type > &psi) |
| template<class Type > | |
| const Foam::CarrierEqn< Type > & | carrierEqn (const VolField< Type > &psi) const |
| template<class Type > | |
| Foam::CarrierEqn< Type > & | carrierEqn (const CarrierField< Type > &psic) |
| template<class Type > | |
| const Foam::CarrierEqn< Type > & | carrierEqn (const CarrierField< Type > &psic) const |
| Public Member Functions inherited from sphericalCoupled | |
| TypeName ("sphericalCoupled") | |
| Run-time type information. More... | |
| sphericalCoupled (const cloud &, const spherical &, const coupled &) | |
| Construct from a reference to the cloud and its base classes. More... | |
| virtual | ~sphericalCoupled () |
| Destructor. More... | |
Protected Member Functions | |
| virtual void | initialise (const bool predict) |
| Initialisation hook. More... | |
| virtual void | partition () |
| Partition hook. More... | |
| virtual tmp< LagrangianSubVectorField > | dUdt (const LagrangianSubMesh &) const |
| Return the acceleration with which to do second-order tracking. More... | |
| virtual bool | reCalculateModified () |
| Do we need to re-calculate particles that are modified? More... | |
| virtual void | calculate (const LagrangianSubScalarField &deltaT, const bool final) |
| Update the cloud properties. 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 | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType) |
| Read header using typeGlobalFile to find file. More... | |
| Protected Member Functions inherited from spherical | |
| void | correct (const LagrangianSubScalarSubField &v) |
| Correct the shape to match the given volume. More... | |
| Protected Member Functions inherited from coupledToFluid | |
| void | updateRhoc () |
| Update the carrier density. More... | |
| Protected Member Functions inherited from coupled | |
| void | clearCarrierEqns () |
| Clear the carrier equations. More... | |
| void | initialise (const bool predict) |
| Initialisation hook. More... | |
| void | partition () |
| Partition hook. More... | |
Additional Inherited Members | |
| Public Types inherited from cloud | |
| enum | contextType { unknown , functionObject , fvModel } |
| Context in which this cloud is used. More... | |
| enum | trackingType { linear , parabolic } |
| Tracking method. More... | |
| Public Types inherited from IOobject | |
| enum | objectState { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ } |
| Enumeration defining the read options. More... | |
| enum | writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 } |
| Enumeration defining the write options. More... | |
| enum | fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster } |
| Enumeration defining the file checking options. More... | |
| Static Public Member Functions inherited from cloud | |
| static autoPtr< cloud > | New (const polyMesh &mesh, const word &name, const word &type) |
| Selector. More... | |
| static const Foam::cloud & | lookup (const LagrangianMesh &mesh) |
| Lookup the cloud associated with a mesh. 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 Member Functions inherited from coupled | |
| static word | carrierName (const word &name) |
| Modify a name to disambiguate it as relating to the carrier. More... | |
| Public Attributes inherited from cloud | |
| enum Foam::cloud::contextType | context |
| enum Foam::cloud::trackingType | tracking |
| CloudStateField< vector > & | U |
| Velocity. More... | |
| Public Attributes inherited from grouped | |
| CloudStateField< scalar > & | number |
| Number. More... | |
| Public Attributes inherited from spherical | |
| CloudStateField< scalar > & | d |
| Diameter. More... | |
| Public Attributes inherited from shaped | |
| const CloudDerivedField< scalar > & | v |
| Volume. More... | |
| const CloudDerivedField< scalar > & | a |
| Surface area. More... | |
| const CloudAverageField< scalar > & | alpha |
| Volume fraction. More... | |
| Public Attributes inherited from massive | |
| CloudStateField< scalar > & | rho |
| Density. More... | |
| const CloudDerivedField< scalar > & | m |
| Mass. More... | |
| Public Attributes inherited from coupledToFluid | |
| const CarrierField< scalar > & | rhoc |
| Carrier density. More... | |
| const CarrierField< scalar > & | muc |
| Carrier dynamic viscosity. More... | |
| Public Attributes inherited from coupled | |
| const CarrierField< vector > & | Uc |
| Carrier velocity. More... | |
| const CarrierField< vector > & | curlUc |
| Carrier velocity curl. More... | |
| const CarrierField< vector > & | DUDtc |
| Carrier advective derivative. More... | |
| const CloudDerivedField< scalar > & | nuc |
| Carrier kinematic viscosity. More... | |
| Public Attributes inherited from sphericalCoupled | |
| const CloudDerivedField< scalar > & | Re |
| Reynolds Number. 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 shaped | |
| static const word | vName |
| Name of volume fields. More... | |
| Static Public Attributes inherited from massive | |
| static const word | mName |
| Name of mass fields. More... | |
Basic cloud with spherical, variable density, particles, grouped into parcels.
This cloud's modelling is the same as for particle, except that an additional number field is used to represent multiple physical particles per Lagrangian parcel. This adds flexibility with regards to managing the expense of simulating large numbers of physical particles, and also provides the ability to specify the number, size (distribution) and volume or mass flow rate of particles at an injection.
| parcel | ( | const polyMesh & | mesh, |
| const word & | name, | ||
| const contextType | context, | ||
| const IOobject::readOption | readOption = IOobject::READ_IF_PRESENT, |
||
| const IOobject::writeOption | writeOption = IOobject::AUTO_WRITE |
||
| ) |
Construct from a mesh and a name.
Definition at line 203 of file parcel.C.
References parcel::reCalculateModified().
|
protectedvirtual |
Initialisation hook.
Reimplemented from cloud.
Definition at line 54 of file parcel.C.
References cloud::initialise(), and coupled::initialise().
|
protectedvirtual |
Partition hook.
Reimplemented from cloud.
Definition at line 61 of file parcel.C.
References cloud::partition(), and coupled::partition().
|
protectedvirtual |
Return the acceleration with which to do second-order tracking.
Implements cloud.
Definition at line 68 of file parcel.C.
References LagrangianModels::addsSupToField(), Foam::Lagrangianc::Ddt(), and U.
|
protectedvirtual |
Do we need to re-calculate particles that are modified?
Implements cloud.
Definition at line 83 of file parcel.C.
References Foam::dimless, Foam::dimVolume, Foam::Lagrangianm::initDdt(), mesh, word::null, and U.
Referenced by parcel::parcel().
|
protectedvirtual |
Update the cloud properties.
Reimplemented from cloud.
Definition at line 121 of file parcel.C.
References spherical::correct(), Foam::Lagrangianm::Ddt(), Foam::dimMass, Foam::dimVolume, DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), Foam::Lagrangianm::noDdt(), rho, LagrangianEqn< Type >::solve(), LagrangianSubMesh::sub(), Foam::toSubField(), U, and UEqn.
| TypeName | ( | "parcel" | ) |
Run-time type information.
|
virtual |
Solve the cloud's evolution over the current time-step.
Reimplemented from cloud.
Definition at line 231 of file parcel.C.
References coupled::clearCarrierEqns(), and cloud::solve().
1.9.1 
