Cloud that follows the carrier flow. The elements have no size or mass and they have no physical modelling associated with them. More...
Public Member Functions | |
| TypeName ("tracer") | |
| Run-time type information. More... | |
| tracer (LagrangianMesh &mesh, const contextType context, const dictionary &dict) | |
| Construct from a mesh and context. More... | |
| virtual | ~tracer () |
| Destructor. More... | |
| virtual void | solve (const bool initial, const bool final) |
| 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, LagrangianMesh,(LagrangianMesh &mesh, const contextType context, const dictionary &dict),(mesh, context, dict)) | |
| Declare run-time constructor selection table. More... | |
| cloud (LagrangianMesh &mesh, const contextType context) | |
| Construct from a mesh and context. Reads the velocity field. More... | |
| cloud (LagrangianMesh &mesh, const contextType context, const tmp< LagrangianVectorDynamicField > &tU) | |
| Construct from a mesh, context and a specified velocity field. 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> | |
| 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 > | |
| Foam::autoPtr< Type > | New (const polyMesh &pMesh, const word &name, const contextType context, const dictionary &dict, const IOobject::readOption readOption, const IOobject::writeOption writeOption) |
| 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 word &newName, const IOobject &, bool registerObject) | |
| Construct from IOobject with new name, and overriding 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... | |
| 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... | |
| uint64_t | eventNo () const |
| Event number at last update. More... | |
| uint64_t & | 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 carried | |
| TypeName ("carried") | |
| Run-time type information. More... | |
| carried (const cloud &c, const dictionary &dict) | |
| Construct from a reference to the cloud. More... | |
| virtual | ~carried () |
| Destructor. More... | |
| const word & | carrierPhaseName () const |
| Return the name of the carrier phase. More... | |
| const word & | phaseName (const bool strict=true) const |
| Return the name of the corresponding Eulerian phase. More... | |
| bool | hasPhase () const |
| Return whether this cloud has a corresponding Eulerian phase. More... | |
| const word | carrierPhaseFieldName (const word &name) |
| Construct the name of a field associated with the carrier. I.e.,. More... | |
| const word | phaseFieldName (const word &name) |
| Construct the name of a field associated with the carrier. I.e.,. 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 > | |
| const CarrierField< Type > & | noCarrierField (const word &symbolicName, const word &descriptiveName, const bool isPhase) const |
| Generate a carrier field reference using a functor that raises. 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 > | |
| const Foam::CarrierField< Type > & | noCarrierField (const word &symbolicName, const word &descriptiveName, const bool isPhase) const |
Protected Member Functions | |
| 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... | |
| virtual void | partition () |
| Partition hook. 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 carried | |
| void | clearCarrierFields () |
| Clear the carrier fields. More... | |
| void | resetCarrierFields (const bool initial) |
| Reset the carrier fields. 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 contextType context, const dictionary &dict, const word &type, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE) |
| Selectors. More... | |
| template<class Type > | |
| static autoPtr< Type > | New (const polyMesh &pMesh, const word &name, const contextType context, const dictionary &dict, const IOobject::readOption readOption=IOobject::READ_IF_PRESENT, const IOobject::writeOption writeOption=IOobject::AUTO_WRITE) |
| Select given the type class. 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 bool | writeHeader (Ostream &os, const IOstream::versionNumber version, const IOstream::streamFormat format, const word &type, const string ¬e, const fileName &location, const word &name) |
| Write header. More... | |
| static bool | writeHeader (Ostream &, const dictionary &foamFileDict) |
| Write header. More... | |
| Static Public Member Functions inherited from carried | |
| static word | nameToCarrierName (const word &name) |
| Convert a name to its disambiguated carrier equivalent name. I.e.,. More... | |
| static word | nameToCarrierName (const word &name, const word &group) |
| Convert a name to its disambiguated carrier equivalent name. I.e.,. More... | |
| static word | carrierNameToName (const word &namec) |
| Convert a disambiguated carrier name to its equivalent name. I.e.,. 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 carried | |
| const CarrierField< vector > & | Uc |
| Carrier velocity. More... | |
| const CarrierField< vector > & | curlUc |
| Carrier velocity curl. More... | |
| const CarrierField< vector > & | DUDtc |
| Carrier advective derivative. More... | |
| const CarrierField< vector > & | UcPhase |
| Corresponding Eulerian phase velocity. 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... | |
Cloud that follows the carrier flow. The elements have no size or mass and they have no physical modelling associated with them.
| tracer | ( | LagrangianMesh & | mesh, |
| const contextType | context, | ||
| const dictionary & | dict | ||
| ) |
Construct from a mesh and context.
Definition at line 91 of file tracer.C.
References cloud::LagrangianModels(), and cloud::U.
|
protectedvirtual |
Return the acceleration with which to do second-order tracking.
Implements cloud.
Definition at line 51 of file tracer.C.
References cloud::U, and carried::Uc.
|
protectedvirtual |
|
protectedvirtual |
Update the cloud properties.
Implements cloud.
Definition at line 66 of file tracer.C.
References DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and U.
|
protectedvirtual |
Partition hook.
Reimplemented from cloud.
Definition at line 82 of file tracer.C.
References carried::clearCarrierFields(), and cloud::partition().
| TypeName | ( | "tracer" | ) |
Run-time type information.
|
virtual |
Solve the cloud's evolution over the current time-step.
Reimplemented from cloud.
Definition at line 141 of file tracer.C.
References carried::resetCarrierFields(), and cloud::solve().
1.9.1 
