Templated base class for kinematic cloud. More...
#include <KinematicCloud.H>
Public Types | |
| typedef CloudType | cloudType |
| Type of cloud this cloud was instantiated for. | |
| typedef CloudType::particleType | parcelType |
| Type of parcel the cloud was instantiated for. | |
| typedef KinematicCloud< CloudType > | kinematicCloudType |
| Convenience typedef for this cloud type. | |
| typedef ParticleForceList< KinematicCloud< CloudType > > | forceType |
| Force models type. | |
| typedef CloudFunctionObjectList< KinematicCloud< CloudType > > | functionType |
| Function object type. | |
| Public Types inherited from DSMCCloud< dsmcParcel > | |
| typedef dsmcParcel | parcelType |
| Type of parcel the cloud was instantiated for. | |
| Public Types inherited from Cloud< ParticleType > | |
| typedef ParticleType | particleType |
| typedef ParticleType | parcelType |
| Parcels are just particles. | |
| Public Types inherited from cloud | |
| enum class | geometryType { COORDINATES , POSITIONS } |
| Cloud geometry type (internal or IO representations). More... | |
| Public Types inherited from IOobject | |
| enum | objectState : char { GOOD , BAD } |
| Enumeration defining the valid states of an IOobject. More... | |
| enum | fileCheckTypes : char { timeStamp = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 } |
| Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). More... | |
| Public Types inherited from IOobjectOption | |
| enum | readOption : unsigned char { NO_READ = 0 , MUST_READ = 0x1 , READ_MODIFIED = 0x3 , MUST_READ_IF_MODIFIED = 0x3 , LAZY_READ = 0x4 , READ_IF_PRESENT = 0x4 } |
| Enumeration defining read preferences. More... | |
| enum | writeOption : unsigned char { NO_WRITE = 0 , AUTO_WRITE = 0x10 } |
| Enumeration defining write preferences. More... | |
| enum | registerOption : unsigned char { NO_REGISTER = 0 , REGISTER = 1 , LEGACY_REGISTER = 2 } |
| Enumeration for use with registerObject(). Values map to bool (false/true). More... | |
| enum class | Layout : unsigned char { regular , global } |
| The layout of the case structure. More... | |
| Public Types inherited from HashTable< regIOobject * > | |
| typedef HashTable< regIOobject *, word, Foam::Hash< word > > | this_type |
| The template instance used for this HashTable. | |
| using | node_type |
| A table entry (node) that encapsulates the key/val tuple with an additional linked-list entry for hash collisions. | |
| typedef word | key_type |
| The second template parameter, type of keys used. | |
| typedef regIOobject * | mapped_type |
| The first template parameter, type of objects contained. | |
| typedef regIOobject * | value_type |
| Same as mapped_type for OpenFOAM HashTables. | |
| typedef Foam::Hash< word > | hasher |
| The third template parameter, the hash index method. | |
| typedef regIOobject ** | pointer |
| Pointer type for storing into value_type objects. | |
| typedef regIOobject *& | reference |
| Reference to the stored value_type. | |
| typedef const regIOobject ** | const_pointer |
| Const pointer type for the stored value_type. | |
| typedef const regIOobject *& | const_reference |
| Const reference to the stored value_type. | |
| typedef label | difference_type |
| The type to represent the difference between two iterators. | |
| typedef label | size_type |
| The type that can represent the size of a HashTable. | |
| using | key_iterator |
| Forward iterator returning the key. | |
| using | const_key_iterator |
| Forward const iterator returning the key. | |
| Public Types inherited from UILList< DLListBase, T > | |
| typedef T | value_type |
| Type of values stored. | |
| typedef T * | pointer |
| Pointer for value_type. | |
| typedef const T * | const_pointer |
| Const pointer for value_type. | |
| typedef T & | reference |
| Reference for value_type. | |
| typedef const T & | const_reference |
| Const reference for value_type. | |
| typedef label | size_type |
| The type that can represent the container size. | |
| typedef label | difference_type |
| The difference between iterator objects. | |
| using | base_iterator |
| using | const_base_iterator |
Public Member Functions | |
| KinematicCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const volScalarField &mu, const dimensionedVector &g, bool readFields=true) | |
| Construct given carrier gas fields. | |
| KinematicCloud (KinematicCloud< CloudType > &c, const word &name) | |
| Copy constructor with new name. | |
| KinematicCloud (const fvMesh &mesh, const word &name, const KinematicCloud< CloudType > &c) | |
| Copy constructor with new name - creates bare cloud. | |
| virtual autoPtr< Cloud< parcelType > > | clone (const word &name) |
| Construct and return clone based on (this) with new name. | |
| virtual autoPtr< Cloud< parcelType > > | cloneBare (const word &name) const |
| Construct and return bare clone based on (this) with new name. | |
| virtual | ~KinematicCloud ()=default |
| Destructor. | |
| const KinematicCloud & | cloudCopy () const |
| Return a reference to the cloud copy. | |
| const fvMesh & | mesh () const |
| Return reference to the mesh. | |
| const IOdictionary & | particleProperties () const |
| Return particle properties dictionary. | |
| const IOdictionary & | outputProperties () const |
| Return output properties dictionary. | |
| IOdictionary & | outputProperties () |
| Return non-const access to the output properties dictionary. | |
| const cloudSolution & | solution () const |
| Return const access to the solution properties. | |
| cloudSolution & | solution () |
| Return access to the solution properties. | |
| const parcelType::constantProperties & | constProps () const |
| Return the constant properties. | |
| parcelType::constantProperties & | constProps () |
| Return access to the constant properties. | |
| const dictionary & | subModelProperties () const |
| Return reference to the sub-models dictionary. | |
| Random & | rndGen () const |
| Return reference to the random object. | |
| List< DynamicList< parcelType * > > & | cellOccupancy () |
| Return the cell occupancy information for each. | |
| const scalarField & | cellLengthScale () const |
| Return the cell length scale. | |
| const volVectorField & | U () const |
| Return carrier gas velocity. | |
| const volScalarField & | rho () const |
| Return carrier gas density. | |
| const volScalarField & | mu () const |
| Return carrier gas dynamic viscosity. | |
| const dimensionedVector & | g () const |
| Gravity. | |
| scalar | pAmbient () const |
| Return const-access to the ambient pressure. | |
| scalar & | pAmbient () |
| Return reference to the ambient pressure. | |
| const forceType & | forces () const |
| Optional particle forces. | |
| forceType & | forces () |
| Return the optional particle forces. | |
| functionType & | functions () |
| Optional cloud function objects. | |
| const InjectionModelList< KinematicCloud< CloudType > > & | injectors () const |
| Return const access to the injection model. | |
| InjectionModelList< KinematicCloud< CloudType > > & | injectors () |
| Return reference to the injection model. | |
| const DispersionModel< KinematicCloud< CloudType > > & | dispersion () const |
| Return const-access to the dispersion model. | |
| DispersionModel< KinematicCloud< CloudType > > & | dispersion () |
| Return reference to the dispersion model. | |
| const PatchInteractionModel< KinematicCloud< CloudType > > & | patchInteraction () const |
| Return const-access to the patch interaction model. | |
| PatchInteractionModel< KinematicCloud< CloudType > > & | patchInteraction () |
| Return reference to the patch interaction model. | |
| const StochasticCollisionModel< KinematicCloud< CloudType > > & | stochasticCollision () const |
| Return const-access to the stochastic collision model. | |
| StochasticCollisionModel< KinematicCloud< CloudType > > & | stochasticCollision () |
| Return reference to the stochastic collision model. | |
| const SurfaceFilmModel< KinematicCloud< CloudType > > & | surfaceFilm () const |
| Return const-access to the surface film model. | |
| SurfaceFilmModel< KinematicCloud< CloudType > > & | surfaceFilm () |
| Return reference to the surface film model. | |
| const PackingModel< KinematicCloud< CloudType > > & | packingModel () const |
| Return const access to the packing model. | |
| PackingModel< KinematicCloud< CloudType > > & | packingModel () |
| Return a reference to the packing model. | |
| const DampingModel< KinematicCloud< CloudType > > & | dampingModel () const |
| Return const access to the damping model. | |
| DampingModel< KinematicCloud< CloudType > > & | dampingModel () |
| Return a reference to the damping model. | |
| const IsotropyModel< KinematicCloud< CloudType > > & | isotropyModel () const |
| Return const access to the isotropy model. | |
| IsotropyModel< KinematicCloud< CloudType > > & | isotropyModel () |
| Return a reference to the isotropy model. | |
| const integrationScheme & | UIntegrator () const |
| Return reference to velocity integration. | |
| void | transferToCarrier (const parcelType &p, const typename parcelType::trackingData &td) |
| Transfer the effect of parcel to the carrier phase. | |
| volScalarField::Internal & | rhokTrans () |
| Return reference to mass for kinematic source. | |
| const volScalarField::Internal & | rhokTrans () const |
| Return const reference to mass for kinematic source. | |
| volVectorField::Internal & | UTrans () |
| Return reference to momentum source. | |
| const volVectorField::Internal & | UTrans () const |
| Return const reference to momentum source. | |
| volScalarField::Internal & | UCoeff () |
| Return coefficient for carrier phase U equation. | |
| const volScalarField::Internal & | UCoeff () const |
| Return const coefficient for carrier phase U equation. | |
| tmp< volScalarField::Internal > | Srhok () const |
| Return tmp mass source for kinematic. | |
| tmp< fvVectorMatrix > | SU (volVectorField &U, bool incompressible=false) const |
| Return tmp momentum source term (compressible). | |
| virtual label | nParcels () const |
| Total number of parcels. | |
| scalar | massInSystem () const |
| Total mass in system. | |
| vector | linearMomentumOfSystem () const |
| Total linear momentum of the system. | |
| scalar | totalParticlePerParcel () const |
| Average particle per parcel. | |
| scalar | linearKineticEnergyOfSystem () const |
| Total linear kinetic energy in the system. | |
| scalar | rotationalKineticEnergyOfSystem () const |
| Total rotational kinetic energy in the system. | |
| scalar | Dij (const label i, const label j) const |
| Mean diameter Dij. | |
| scalar | Dmax () const |
| Max diameter. | |
| const tmp< volScalarField > | vDotSweep () const |
| Volume swept rate of parcels per cell. | |
| const tmp< volScalarField > | theta () const |
| Return the particle volume fraction field. | |
| const tmp< volScalarField > | alpha () const |
| Return the particle mass fraction field. | |
| const tmp< volScalarField > | rhoEff () const |
| Return the particle effective density field. | |
| void | setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt) |
| Set parcel thermo properties. | |
| void | checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed) |
| Check parcel properties. | |
| void | storeState () |
| Store the current cloud state. | |
| void | restoreState () |
| Reset the current cloud to the previously stored state. | |
| void | resetSourceTerms () |
| Reset the cloud source terms. | |
| template<class Type> | |
| void | relax (DimensionedField< Type, volMesh > &field, const DimensionedField< Type, volMesh > &field0, const word &name) const |
| Relax field. | |
| template<class Type> | |
| void | scale (DimensionedField< Type, volMesh > &field, const word &name) const |
| Scale field. | |
| void | relaxSources (const KinematicCloud< CloudType > &cloudOldTime) |
| Apply relaxation to (steady state) cloud sources. | |
| void | scaleSources () |
| Apply scaling to (transient) cloud sources. | |
| void | preEvolve (const typename parcelType::trackingData &td) |
| Pre-evolve. | |
| void | evolve () |
| Evolve the cloud. | |
| template<class TrackCloudType> | |
| void | motion (TrackCloudType &cloud, typename parcelType::trackingData &td) |
| Particle motion. | |
| void | patchData (const parcelType &p, const polyPatch &pp, vector &normal, vector &Up) const |
| Calculate the patch normal and velocity to interact with,. | |
| void | updateMesh () |
| Update mesh. | |
| virtual void | autoMap (const mapPolyMesh &) |
| Remap the cells of particles corresponding to the. | |
| void | info () |
| Print cloud information. | |
| virtual void | readObjects (const objectRegistry &obr) |
| Read particle fields from objects in the obr registry. | |
| virtual void | writeObjects (objectRegistry &obr) const |
| Write particle fields as objects into the obr registry. | |
| Public Member Functions inherited from DSMCCloud< dsmcParcel > | |
| DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true) | |
| Construct given name and mesh, will read Parcels and fields from. | |
| DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict) | |
| Construct given name, mesh and initialisation dictionary. | |
| virtual | ~DSMCCloud () |
| Destructor. | |
| const word & | cloudName () const |
| Return the cloud type. | |
| const fvMesh & | mesh () const |
| Return reference to the mesh. | |
| const IOdictionary & | particleProperties () const |
| Return particle properties dictionary. | |
| const List< word > & | typeIdList () const |
| Return the idList. | |
| scalar | nParticle () const |
| Return the number of real particles represented by one. | |
| const List< DynamicList< dsmcParcel * > > & | cellOccupancy () const |
| Return the cell occupancy addressing. | |
| volScalarField & | sigmaTcRMax () |
| Return the sigmaTcRMax field. non-const access to allow. | |
| scalarField & | collisionSelectionRemainder () |
| Return the collision selection remainder field. non-const. | |
| const List< typename dsmcParcel::constantProperties > & | constProps () const |
| Return all of the constant properties. | |
| const dsmcParcel::constantProperties & | constProps (label typeId) const |
| Return the constant properties of the given typeId. | |
| Random & | rndGen () |
| Return reference to the random object. | |
| volScalarField::Boundary & | qBF () |
| Return non-const heat flux boundary field reference. | |
| volVectorField::Boundary & | fDBF () |
| Return non-const force density at boundary field reference. | |
| volScalarField::Boundary & | rhoNBF () |
| Return non-const number density boundary field reference. | |
| volScalarField::Boundary & | rhoMBF () |
| Return non-const mass density boundary field reference. | |
| volScalarField::Boundary & | linearKEBF () |
| Return non-const linear kinetic energy density boundary. | |
| volScalarField::Boundary & | internalEBF () |
| Return non-const internal energy density boundary field. | |
| volScalarField::Boundary & | iDofBF () |
| Return non-const internal degree of freedom density boundary. | |
| volVectorField::Boundary & | momentumBF () |
| Return non-const momentum density boundary field reference. | |
| const volScalarField & | boundaryT () const |
| Return macroscopic temperature. | |
| const volVectorField & | boundaryU () const |
| Return macroscopic velocity. | |
| const volScalarField & | q () const |
| Return heat flux at surface field. | |
| const volVectorField & | fD () const |
| Return force density at surface field. | |
| const volScalarField & | rhoN () const |
| Return the real particle number density field. | |
| const volScalarField & | rhoM () const |
| Return the particle mass density field. | |
| const volScalarField & | dsmcRhoN () const |
| Return the field of number of DSMC particles. | |
| const volScalarField & | linearKE () const |
| Return the total linear kinetic energy (translational and. | |
| const volScalarField & | internalE () const |
| Return the internal energy density field. | |
| const volScalarField & | iDof () const |
| Return the average internal degrees of freedom field. | |
| const volVectorField & | momentum () const |
| Return the momentum density field. | |
| vector | equipartitionLinearVelocity (scalar temperature, scalar mass) |
| Generate a random velocity sampled from the Maxwellian speed. | |
| scalar | equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom) |
| Generate a random internal energy, sampled from the. | |
| scalar | maxwellianAverageSpeed (scalar temperature, scalar mass) const |
| Average particle speed. | |
| scalarField | maxwellianAverageSpeed (scalarField temperature, scalar mass) const |
| scalar | maxwellianRMSSpeed (scalar temperature, scalar mass) const |
| RMS particle speed. | |
| scalarField | maxwellianRMSSpeed (scalarField temperature, scalar mass) const |
| scalar | maxwellianMostProbableSpeed (scalar temperature, scalar mass) const |
| Most probable speed. | |
| scalarField | maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const |
| const BinaryCollisionModel< DSMCCloud< dsmcParcel > > & | binaryCollision () const |
| Return reference to binary elastic collision model. | |
| BinaryCollisionModel< DSMCCloud< dsmcParcel > > & | binaryCollision () |
| Return non-const reference to binary elastic collision model. | |
| const WallInteractionModel< DSMCCloud< dsmcParcel > > & | wallInteraction () const |
| Return reference to wall interaction model. | |
| WallInteractionModel< DSMCCloud< dsmcParcel > > & | wallInteraction () |
| Return non-const reference to wall interaction model. | |
| const InflowBoundaryModel< DSMCCloud< dsmcParcel > > & | inflowBoundary () const |
| Return reference to wall interaction model. | |
| InflowBoundaryModel< DSMCCloud< dsmcParcel > > & | inflowBoundary () |
| Return non-const reference to wall interaction model. | |
| scalar | massInSystem () const |
| Total mass in system. | |
| vector | linearMomentumOfSystem () const |
| Total linear momentum of the system. | |
| scalar | linearKineticEnergyOfSystem () const |
| Total linear kinetic energy in the system. | |
| scalar | internalEnergyOfSystem () const |
| Total internal energy in the system. | |
| void | info () const |
| Print cloud information. | |
| void | dumpParticlePositions () const |
| Dump particle positions to .obj file. | |
| void | addNewParcel (const vector &position, const label celli, const vector &U, const scalar Ei, const label typeId) |
| Add new parcel. | |
| void | evolve () |
| Evolve the cloud (move, collide). | |
| void | clear () |
| Clear the Cloud. | |
| Public Member Functions inherited from Cloud< ParticleType > | |
| TypeName ("Cloud") | |
| Runtime type information. | |
| Cloud (const polyMesh &mesh, const Foam::zero, const word &cloudName) | |
| Construct without particles. | |
| Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles) | |
| Construct from mesh and a list of particles. | |
| Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true) | |
| Read construct from file(s) with given cloud instance. | |
| const polyMesh & | pMesh () const noexcept |
| Return the polyMesh reference. | |
| DynamicList< label > & | labels () const |
| Return temporary addressing. | |
| void | addParticle (ParticleType *pPtr) |
| Transfer particle to cloud. | |
| void | deleteParticle (ParticleType &p) |
| Remove particle from cloud and delete. | |
| void | deleteLostParticles () |
| Remove lost particles from cloud and delete. | |
| void | cloudReset (const Cloud< ParticleType > &c) |
| Reset the particles. | |
| template<class TrackCloudType> | |
| void | move (TrackCloudType &cloud, typename ParticleType::trackingData &td, const scalar trackTime) |
| Move the particles. | |
| template<class DataType> | |
| void | checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const |
| Check lagrangian data field. | |
| template<class DataType> | |
| void | checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType > > &data) const |
| Check lagrangian data fieldfield. | |
| template<class Type> | |
| bool | readStoreFile (const IOobject &io, const IOobject &ioNew) const |
| Helper function to store a cloud field on its registry. | |
| void | readFromFiles (objectRegistry &obr, const wordRes &selectFields, const wordRes &excludeFields=wordRes::null()) const |
| Read from files into objectRegistry. | |
| virtual void | writeFields () const |
| Write the field data for the cloud of particles Dummy at. | |
| virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
| Write using stream options. | |
| void | writePositions () const |
| Write positions to <cloudName>_positions.obj file. | |
| void | storeGlobalPositions () const |
| Call this before a topology change. | |
| IOobject | fieldIOobject (const word &fieldName, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ) const |
| Helper to construct IOobject for field and current time. | |
| Public Member Functions inherited from cloud | |
| TypeName ("cloud") | |
| Runtime type information. | |
| cloud (const cloud &)=delete | |
| No copy construct. | |
| void | operator= (const cloud &)=delete |
| No copy assignment. | |
| cloud (const objectRegistry &obr) | |
| Construct for given objectRegistry. Uses default cloud name. | |
| cloud (const objectRegistry &obr, const word &cloudName) | |
| Construct for given objectRegistry and named cloud. | |
| virtual | ~cloud ()=default |
| Destructor. | |
| template<class Type> | |
| Foam::IOField< Type > & | createIOField (const word &fieldName, const label nParticle, objectRegistry &obr) |
| Public Member Functions inherited from objectRegistry | |
| TypeName ("objectRegistry") | |
| Declare type name for this IOobject. | |
| objectRegistry (const Time &db, const label initialCapacity=128) | |
| Construct the time objectRegistry, with estimated table capacity (default: 128). | |
| objectRegistry (const IOobject &io, const label initialCapacity=128) | |
| Construct sub-registry given an IObject to describe the registry, with estimated table capacity (default: 128). | |
| virtual | ~objectRegistry () |
| Destructor, with checkOut() for all objects that are ownedByRegistry. | |
| const objectRegistry & | thisDb () const noexcept |
| Return the object registry. | |
| const objectRegistry & | parent () const noexcept |
| Return the parent objectRegistry. | |
| const Time & | time () const noexcept |
| Return time registry. | |
| bool | isTimeDb () const noexcept |
| True if the registry is Time. | |
| virtual const fileName & | dbDir () const |
| Local directory path of this objectRegistry relative to the time. | |
| IOobject | newIOobject (const word &name, IOobjectOption ioOpt) const |
| Create an IOobject at the current time instance (timeName) with the specified options. | |
| IOobject | newIOobject (const word &name, IOobjectOption::readOption rOpt=IOobjectOption::NO_READ, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, IOobjectOption::registerOption regOpt=IOobjectOption::NO_REGISTER) const |
| Create an IOobject at the current time instance (timeName). | |
| HashTable< wordHashSet > | classes () const |
| A summary hash of classes used and their associated object names. | |
| template<class MatchPredicate> | |
| HashTable< wordHashSet > | classes (const MatchPredicate &matchName) const |
| A summary hash of classes used and their associated object names, restricted to objects that have a matching object name. | |
| template<class Type, bool Strict = false> | |
| UPtrList< const Type > | cobjects () const |
Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| UPtrList< Type > | objects () |
Return unsorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
Return unsorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< Type > | objects (const MatchPredicate &matchName) |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, bool Strict = false> | |
| UPtrList< const Type > | csorted () const |
Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| UPtrList< Type > | sorted () |
Return sorted list of objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| UPtrList< const regIOobject > | csorted () const |
| Return sorted list of objects. | |
| UPtrList< regIOobject > | sorted () |
| Return sorted list of objects. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< Type > | sorted (const MatchPredicate &matchName) |
Return sorted list of objects with a class satisfying isA<Type> that also have a matching object name. | |
| label | count (const char *clsName) const |
| The number of objects of the given class name. | |
| template<class MatchPredicate> | |
| label | count (const MatchPredicate &matchClass) const |
| The number of objects of the given class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The number of objects of the given class name. | |
| template<class Type> | |
| label | count (const bool strict=false) const |
The names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| label | count (const MatchPredicate &matchName) const |
The names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| wordList | names () const |
| The unsorted names of all objects. | |
| wordList | names (const char *clsName) const |
| The unsorted names of objects with the given class name. | |
| template<class MatchPredicate> | |
| wordList | names (const MatchPredicate &matchClass) const |
| The unsorted names of objects with a matching class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The unsorted names of objects with a matching class name that also have a matching object name. | |
| template<class Type> | |
| wordList | names () const |
The unsorted names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| wordList | names (const MatchPredicate &matchName) const |
The unsorted names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| wordList | sortedNames () const |
| The sorted names of all objects. | |
| wordList | sortedNames (const char *clsName) const |
| The sorted names of objects with the given class name. | |
| template<class MatchPredicate> | |
| wordList | sortedNames (const MatchPredicate &matchClass) const |
| The sorted names objects with a matching class name. | |
| template<class MatchPredicate1, class MatchPredicate2> | |
| wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| The sorted names of objects with a matching class name that also have a matching object name. | |
| template<class Type> | |
| wordList | sortedNames () const |
The sorted names of objects with a class satisfying isA<Type>. | |
| template<class Type, class MatchPredicate> | |
| wordList | sortedNames (const MatchPredicate &matchName) const |
The sorted names of objects with a class satisfying isA<Type> that also have a matching object name. | |
| const objectRegistry & | subRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const |
| Lookup and return a const sub-objectRegistry. | |
| template<class Type, bool Strict = false> | |
| HashTable< const Type * > | lookupClass () const |
Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type, bool Strict = false> | |
| HashTable< Type * > | lookupClass () |
Return all objects with a class satisfying isA<Type> or isType<Type> (with Strict). | |
| template<class Type> | |
| HashTable< const Type * > | lookupClass (const bool strict) const |
Return all objects with a class satisfying isA<Type>. | |
| template<class Type> | |
| HashTable< Type * > | lookupClass (const bool strict) |
Return all objects with a class satisfying isA<Type>. | |
| const regIOobject * | cfindIOobject (const word &name, const bool recursive=false) const |
| Return const pointer to the regIOobject. | |
| bool | contains (const word &name, const bool recursive=false) const |
| Does the registry contain the regIOobject object (by name). | |
| template<class Type> | |
| bool | foundObject (const word &name, const bool recursive=false) const |
| Contains the named Type? | |
| template<class Type> | |
| const Type * | cfindObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. | |
| template<class Type> | |
| const Type * | findObject (const word &name, const bool recursive=false) const |
| Return const pointer to the object of the given Type. | |
| template<class Type> | |
| Type * | findObject (const word &name, const bool recursive=false) |
| Return non-const pointer to the object of the given Type. | |
| template<class Type> | |
| Type * | getObjectPtr (const word &name, const bool recursive=false) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. | |
| template<class Type> | |
| const Type & | lookupObject (const word &name, const bool recursive=false) const |
| Lookup and return const reference to the object of the given Type. Fatal if not found or the wrong type. | |
| template<class Type> | |
| Type & | lookupObjectRef (const word &name, const bool recursive=false) const |
| Lookup and return non-const reference to the object of the given Type. Fatal if not found or the wrong type. | |
| label | getEvent () const |
| Return new event number. | |
| bool | checkIn (regIOobject *io) const |
| Add a regIOobject to registry. A nullptr is ignored. | |
| bool | checkIn (regIOobject &io) const |
| Add a regIOobject to registry. | |
| bool | checkOut (regIOobject *io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. A nullptr is ignored. | |
| bool | checkOut (regIOobject &io) const |
| Remove a regIOobject from registry and free memory if the object is ownedByRegistry. | |
| bool | checkOut (const word &key) const |
| Remove a regIOobject by name from registry and free memory if the object is ownedByRegistry. | |
| void | clear () |
| Clear all entries from the registry. | |
| void | clearStorage () |
| Clear all entries from the registry and the table itself. | |
| bool | erase (const iterator &iter) |
| Erase an entry specified by the given iterator. | |
| bool | erase (const word &key) |
| Erase an entry specified by the given key. | |
| label | erase (std::initializer_list< word > keys) |
| Remove entries given by the listed keys. | |
| label | erase (const UList< word > &keys) |
| Remove entries given by the listed keys. | |
| virtual void | rename (const word &newName) |
| Rename. | |
| bool | is_cacheTemporaryObject (const word &name) const |
| True if given name is in the cacheTemporaryObjects set. | |
| bool | is_cacheTemporaryObject (const regIOobject *io) const |
| True if name of object is in the cacheTemporaryObjects set. | |
| bool | is_cacheTemporaryObject (const regIOobject &io) const |
| True if name of object is in the cacheTemporaryObjects set. | |
| template<class Type> | |
| bool | cacheTemporaryObject (Type &obj) const |
| Cache the given object. Moves content and stores. | |
| void | resetCacheTemporaryObject (const regIOobject *io) const |
| Reset the cache state of the given object (nullptr is ignored). | |
| void | resetCacheTemporaryObject (const regIOobject &io) const |
| Reset the cache state of the given object in the cacheTemporaryObjects set. | |
| bool | checkCacheTemporaryObjects () const |
| Check that all objects specified in the cacheTemporaryObjects were also cached. | |
| 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 |
| The writeData function is required by regIOobject but not used. | |
| bool | found (const word &name, bool recursive=false) const |
| Same as contains(). | |
| template<class Type> | |
| const Type * | lookupObjectPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) find object. | |
| template<class Type> | |
| Type * | lookupObjectRefPtr (const word &name, bool recursive=false) const |
| Deprecated(2018-10) get object pointer, ignoring constness. | |
| template<class Type> | |
| UPtrList< const Type > | sorted () const |
| Deprecated(2023-07) use csorted() method. | |
| UPtrList< const regIOobject > | sorted () const |
| Deprecated(2023-07) use csorted() method. | |
| template<class Type, class MatchPredicate> | |
| UPtrList< const Type > | sorted (const MatchPredicate &matchName) const |
| Deprecated(2023-07) use csorted() method. | |
| template<class MatchPredicate> | |
| Foam::HashTable< Foam::wordHashSet > | classesImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1, class MatchPredicate2> | |
| Foam::label | countImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) |
| template<class Type, class MatchPredicate> | |
| Foam::label | countTypeImpl (const objectRegistry &list, const MatchPredicate &matchName) |
| template<class MatchPredicate1, class MatchPredicate2> | |
| Foam::wordList | namesImpl (const objectRegistry &list, const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName, const bool doSort) |
| template<class Type, class MatchPredicate> | |
| Foam::wordList | namesTypeImpl (const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | objectsTypeImpl (const bool strict, const objectRegistry &list, const MatchPredicate &matchName, const bool doSort) |
| template<class Type> | |
| Foam::HashTable< Type * > | lookupClassTypeImpl (const bool strict, const objectRegistry &list) |
| template<class MatchPredicate> | |
| Foam::HashTable< Foam::wordHashSet > | classes (const MatchPredicate &matchName) const |
| template<class MatchPredicate> | |
| Foam::label | count (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> | |
| Foam::label | count (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type, class MatchPredicate> | |
| Foam::label | count (const MatchPredicate &matchName) const |
| template<class Type> | |
| Foam::label | count (const bool strict) const |
| template<class Type, bool Strict> | |
| Foam::UPtrList< const Type > | cobjects () const |
| template<class Type, bool Strict> | |
| Foam::UPtrList< Type > | objects () |
| template<class Type, bool Strict> | |
| Foam::UPtrList< const Type > | csorted () const |
| template<class Type, bool Strict> | |
| Foam::UPtrList< Type > | sorted () |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< const Type > | cobjects (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | objects (const MatchPredicate &matchName) |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< const Type > | csorted (const MatchPredicate &matchName) const |
| template<class Type, class MatchPredicate> | |
| Foam::UPtrList< Type > | sorted (const MatchPredicate &matchName) |
| template<class MatchPredicate> | |
| Foam::wordList | names (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> | |
| Foam::wordList | names (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type> | |
| Foam::wordList | names () const |
| template<class Type, class MatchPredicate> | |
| Foam::wordList | names (const MatchPredicate &matchName) const |
| template<class MatchPredicate> | |
| Foam::wordList | sortedNames (const MatchPredicate &matchClass) const |
| template<class MatchPredicate1, class MatchPredicate2> | |
| Foam::wordList | sortedNames (const MatchPredicate1 &matchClass, const MatchPredicate2 &matchName) const |
| template<class Type> | |
| Foam::wordList | sortedNames () const |
| template<class Type, class MatchPredicate> | |
| Foam::wordList | sortedNames (const MatchPredicate &matchName) const |
| template<class Type, bool Strict> | |
| Foam::HashTable< const Type * > | lookupClass () const |
| template<class Type, bool Strict> | |
| Foam::HashTable< Type * > | lookupClass () |
| 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 | |
| void | operator= (const regIOobject &)=delete |
| No copy assignment. | |
| TypeName ("regIOobject") | |
| Runtime type information. | |
| regIOobject (const IOobject &io, const bool isTimeObject=false) | |
| Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). | |
| regIOobject (const regIOobject &rio) | |
| Copy construct. | |
| regIOobject (const regIOobject &rio, bool registerCopy) | |
| Copy construct, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
| Copy construct with new name, transferring registry registration to the copy if registerCopy is true. | |
| regIOobject (const IOobject &io, const regIOobject &rio) | |
| Copy construct with new IO parameters. | |
| virtual | ~regIOobject () |
| Destructor. | |
| bool | checkIn () |
| Add object to registry, if not already registered. | |
| bool | checkOut () |
| Remove object from registry, and remove all file watches. | |
| virtual void | addWatch () |
| Add file watch on object (if registered and READ_IF_MODIFIED). | |
| bool | registered () const noexcept |
| Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. | |
| bool | ownedByRegistry () const noexcept |
| Is this object owned by the registry? | |
| bool | store () |
| Register object with its registry and transfer ownership to the registry. | |
| void | release (const bool unregister=false) noexcept |
| Set object as not ownedByRegistry. | |
| label | eventNo () const noexcept |
| Event number at last update. | |
| label & | eventNo () noexcept |
| Event number at last update. | |
| bool | upToDate (const regIOobject &) const |
| Return true if up-to-date with respect to given object. | |
| bool | upToDate (const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
| Return true if up-to-date with respect to given objects. | |
| void | setUpToDate () |
| Set as up-to-date. | |
| const dictionary * | findMetaData () const noexcept |
| Return pointer to meta-data or nullptr. | |
| dictionary & | getMetaData () noexcept |
| Get or create meta-data. | |
| void | removeMetaData () |
| Remove meta-data. | |
| virtual void | updateMetaData () |
| Update internal meta-data (eg, prior to writing). | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. | |
| bool | headerOk () |
| Read and check header info. Does not check the headerClassName. | |
| Istream & | readStream (const word &, const bool readOnProc=true) |
| 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 label | addWatch (const fileName &) |
| Add file watch for fileName on object if not yet watched. | |
| const labelList & | watchIndices () const noexcept |
| Read access to file-monitoring handles. | |
| labelList & | watchIndices () noexcept |
| Write access to file-monitoring handles. | |
| virtual bool | write (const bool writeOnProc=true) const |
| Write using setting from DB. | |
| virtual bool | global () const |
| Is object global. | |
| void | operator= (const IOobject &io) |
| Copy assignment. | |
| virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
| Write using given format, version and compression. | |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Declare type-name, virtual type (with debug switch). | |
| IOobject (const IOobject &)=default | |
| Copy construct. | |
| virtual | ~IOobject ()=default |
| Destructor. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
| Construct from path, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, registry, io options. | |
| IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from name, instance, local, registry, io options. | |
| IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
| Construct from path, registry, io options. | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| Copy construct, resetting registry. | |
| IOobject (const IOobject &io, const word &name) | |
| Copy construct, resetting name. | |
| IOobject (const IOobject &io, const word &name, const fileName &local) | |
| Copy construct, resetting name and local component. | |
| IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
| Copy construct, resetting read/write options. | |
| IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
| Copy construct, resetting register option. | |
| autoPtr< IOobject > | clone () const |
| Clone. | |
| autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
| Clone resetting registry. | |
| const objectRegistry & | db () const noexcept |
| Return the local objectRegistry. | |
| const Time & | time () const noexcept |
| Return Time associated with the objectRegistry. | |
| const word & | name () const noexcept |
| Return the object name. | |
| const word & | headerClassName () const noexcept |
| Return name of the class name read from header. | |
| word & | headerClassName () noexcept |
| Modifiable access to the class name read from header. | |
| const string & | note () const noexcept |
| Return the optional note. | |
| string & | note () noexcept |
| Modifiable access to the optional note. | |
| unsigned | labelByteSize () const noexcept |
| The sizeof (label) in bytes, possibly read from the header. | |
| unsigned | scalarByteSize () const noexcept |
| The sizeof (scalar) in bytes, possibly read from the header. | |
| void | resetHeader (const word &newName=word::null) |
| Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. | |
| bool | hasHeaderClass () const noexcept |
| True if headerClassName() is non-empty (after reading). | |
| bool | isHeaderClass (const word &expectedType) const |
| Check if headerClassName() equals the expected type. Always true if the expected type is empty. | |
| template<class Type> | |
| bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName Always true for a void type. | |
| word | group () const |
| Return group (extension part of name). | |
| word | member () const |
| Return member (name without the extension). | |
| const fileName & | rootPath () const noexcept |
| Return the Time::rootPath(). | |
| const fileName & | caseName () const noexcept |
| Return the Time::caseName(). | |
| const fileName & | globalCaseName () const noexcept |
| Return the Time::globalCaseName(). | |
| const fileName & | caseName (IOobjectOption::Layout) const noexcept |
| Return the Time::caseName() - normal or global. | |
| const fileName & | instance () const noexcept |
| Read access to instance path component. | |
| fileName & | instance () noexcept |
| Modifiable access to instance path component. | |
| scalar | instanceValue () const |
| Return the scalar value of the instance component (or 0), which often corresponds to a time index/value. | |
| const fileName & | local () const noexcept |
| Read access to local path component. | |
| fileName & | local () noexcept |
| Modifiable access to the local path component. | |
| fileName | path () const |
| The complete path for the object (with instance, local,...). | |
| fileName | globalPath () const |
| The complete global path for the object (with instance, local,...). | |
| fileName | path (IOobjectOption::Layout) const |
| The complete path (normal or global) for the object. | |
| fileName | path (const word &instance, const fileName &local=fileName::null) const |
| The complete path with alternative instance and local. | |
| fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
| The complete global path with alternative instance and local. | |
| fileName | path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const |
| The complete path (normal or global) with alternative instance and local. | |
| fileName | objectPath () const |
| The complete path + object name. | |
| fileName | globalObjectPath () const |
| The complete global path + object name. | |
| fileName | objectPath (IOobjectOption::Layout) const |
| The complete path (normal or global) + object name. | |
| fileName | objectPath (IOobjectOption::Layout, const word &instance) const |
| The complete path (normal or global) + object name with alternative instance. | |
| fileName | objectPath (const word &instance) const |
| The complete path + object name with alternative instance. | |
| fileName | globalObjectPath (const word &instance) const |
| The complete global path + object name with alternative instance. | |
| fileName | objectRelPath () const |
| The object path relative to the case. | |
| fileName | localFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching locally. | |
| fileName | globalFilePath (const word &typeName, const bool search=true) const |
| Redirect to fileHandler filePath, searching up if in parallel. | |
| IOstreamOption | parseHeader (const dictionary &headerDict) |
| Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. | |
| bool | readHeader (Istream &is) |
| Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| bool | readHeader (dictionary &headerDict, Istream &is) |
| Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. | |
| template<class Type> | |
| bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. A void type suppresses trait and type-name checks. | |
| template<class Type, bool Searching> | |
| bool | typeHeaderOk (const bool checkType=true, const bool verbose=true) |
Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks. | |
| template<class Type> | |
| fileName | typeFilePath (const bool search=true) const |
| Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. | |
| template<class Type> | |
| void | warnNoRereading () const |
| Helper: warn that type does not support re-reading. | |
| bool | writeHeader (Ostream &os) const |
| Write header with current type(). | |
| bool | writeHeader (Ostream &os, const word &objectType) const |
| Write header with override of type. | |
| void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
| Write header into a dictionary with current type() and given output format. | |
| void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
| Write header into a dictionary with override of type and given output format. | |
| bool | good () const noexcept |
| Did last readHeader() succeed? | |
| bool | bad () const noexcept |
| Did last readHeader() fail? | |
| InfoProxy< IOobject > | info () const noexcept |
| Return info proxy, for printing information to a stream. | |
| void | operator= (const IOobject &io) |
| Copy assignment, copies all values (except the registry). | |
| template<class Type> | |
| bool | isHeaderClassName () const |
| Same as isHeaderClass(). | |
| template<class StringType> | |
| Foam::word | groupName (StringType base, const word &group) |
| template<class Type> | |
| Foam::fileName | typeFilePath (const bool search) const |
| Public Member Functions inherited from IOobjectOption | |
| constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. | |
| constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_WRITE with specified read/register options. | |
| constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
| Construct NO_READ with specified write/register options. | |
| constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option. | |
| constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
| Construct from components with specified register option as bool. | |
| constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
| Construct (NO_READ, NO_WRITE) with specified register option as bool. | |
| readOption | readOpt () const noexcept |
| Get the read option. | |
| readOption | readOpt (readOption opt) noexcept |
| Set the read option. | |
| writeOption | writeOpt () const noexcept |
| Get the write option. | |
| writeOption | writeOpt (writeOption opt) noexcept |
| Set the write option. | |
| bool | registerObject () const noexcept |
| Should objects created with this IOobject be registered? | |
| bool | registerObject (bool on) noexcept |
| Change registration preference. | |
| bool | globalObject () const noexcept |
| True if object is treated the same for all processors. | |
| bool | globalObject (bool on) noexcept |
| Change global-object status. | |
| bool | isAnyRead () const noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| bool | isReadRequired () const noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| bool | isReadOptional () const noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| readOption & | readOpt () noexcept |
| Access to the read option. | |
| writeOption & | writeOpt () noexcept |
| Access to the write option. | |
| bool & | registerObject () noexcept |
| Access to the register object option. | |
| bool & | globalObject () noexcept |
| Access to the global object option. | |
| Public Member Functions inherited from HashTable< regIOobject * > | |
| Foam::List< word > | sortedToc (const Compare &comp) const |
| Foam::List< word > | tocKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::List< word > | tocEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | countKeys (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countValues (const UnaryPredicate &pred, const bool invert) const |
| Foam::label | countEntries (const BinaryPredicate &pred, const bool invert) const |
| Foam::label | erase (InputIter first, InputIter last) |
| Foam::label | erase (const FixedList< word, N > &keys) |
| Foam::label | erase (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | retain (const HashTable< AnyType, word, AnyHash > &other) |
| Foam::label | filterKeys (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterValues (const UnaryPredicate &pred, const bool pruning) |
| Foam::label | filterEntries (const BinaryPredicate &pred, const bool pruning) |
| constexpr | HashTable () noexcept |
| Default construct: empty without allocation (capacity=0). | |
| ~HashTable () | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the hash table is empty. | |
| label | size () const noexcept |
| The number of elements in table. | |
| label | capacity () const noexcept |
| The size of the underlying table (the number of buckets). | |
| regIOobject *& | at (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| bool | contains (const word &key) const |
| True if hashed key is contained (found) in table. | |
| iterator | find (const word &key) |
| Find and return an iterator set at the hashed entry. | |
| const_iterator | cfind (const word &key) const |
| Find and return an const_iterator set at the hashed entry. | |
| const regIOobject *& | lookup (const word &key, const regIOobject *&deflt) const |
| Return hashed entry if it exists, or return the given default. | |
| List< word > | toc () const |
| The table of contents (the keys) in unsorted order. | |
| UPtrList< const node_type > | csorted () const |
| Const access to the hash-table contents in sorted order (sorted by keys). | |
| UPtrList< node_type > | sorted () |
| Non-const access to the hash-table contents in sorted order (sorted by keys). | |
| bool | emplace (const word &key, Args &&... args) |
| Emplace insert a new entry, not overwriting existing entries. | |
| bool | emplace_set (const word &key, Args &&... args) |
| Emplace set an entry, overwriting any existing entries. | |
| bool | insert (const word &key, const regIOobject *&obj) |
| Copy insert a new entry, not overwriting existing entries. | |
| bool | set (const word &key, const regIOobject *&obj) |
| Copy assign a new entry, overwriting existing entries. | |
| void | clear () |
| Remove all entries from table. | |
| void | clearStorage () |
| Remove all entries from table and the table itself. | |
| void | setCapacity (label newCapacity) |
| Change the hash table capacity (number of buckets). | |
| void | resize (label newCapacity) |
| Rehash the hash table with new number of buckets. Currently identical to setCapacity(). | |
| void | reserve (label numEntries) |
| Reserve space for at least the specified number of elements (not the number of buckets) and regenerates the hash table. | |
| void | swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) noexcept |
| Swap contents into this table. | |
| void | transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs) |
| Transfer contents into this table. | |
| void | merge (HashTable< regIOobject *, word, Foam::Hash< word > > &source) |
Attempts to extract entries from source parameter and insert them into this, does not overwrite existing entries. The source will contains any items that could not be merged. | |
| regIOobject *& | operator[] (const word &key) |
| Find and return a hashed entry. FatalError if it does not exist. | |
| regIOobject *& | operator() (const word &key) |
| Return existing entry or create a new entry. | |
| void | operator= (const this_type &rhs) |
| Copy assign. | |
| bool | operator== (const this_type &rhs) const |
| Equality. Tables are equal if all keys and values are equal, independent of order or underlying storage size. | |
| bool | operator!= (const this_type &rhs) const |
| The opposite of the equality operation. | |
| this_type & | operator+= (const this_type &rhs) |
| Add entries into this HashTable. | |
| const_iterator_pair< const_key_iterator, this_type > | keys () const |
| A const iterator begin/end pair for iterating over keys. | |
| iterator | begin () |
| iterator set to the beginning of the HashTable | |
| const_iterator | cbegin () const |
| const_iterator set to the beginning of the HashTable | |
| iterator | end () noexcept |
| iterator to signal the end (for any HashTable) | |
| constexpr const_iterator | cend () const noexcept |
| const_iterator to signal the end (for any HashTable) | |
| Ostream & | printInfo (Ostream &os) const |
| Print information. | |
| Ostream & | writeKeys (Ostream &os, const label shortLen=0) const |
| Write unordered keys (list), with line-breaks when length exceeds shortLen. | |
| bool | found (const word &key) const |
| Same as contains(). | |
| Public Member Functions inherited from HashTableCore | |
| ClassName ("HashTable") | |
| Declare type-name (with debug switch). | |
| constexpr | HashTableCore () noexcept=default |
| Default construct. | |
| Public Member Functions inherited from ILList< DLListBase, T > | |
| ILList ()=default | |
| Default construct. | |
| ILList (T *item) | |
| Construct and add initial item pointer. | |
| ILList (Istream &is) | |
| Construct from Istream. | |
| ILList (const ILList< DLListBase, T > &lst) | |
| Copy construct using the 'clone()' method for each element. | |
| ILList (ILList< DLListBase, T > &&lst) | |
| Move construct. | |
| ILList (const ILList< DLListBase, T > &lst, const CloneArg &cloneArg) | |
| Copy constructor with additional argument for clone 'clone()'. | |
| ILList (Istream &is, const INew &inew) | |
| Construct from Istream using given Istream constructor class. | |
| ~ILList () | |
| Destructor. Calls clear(). | |
| void | clear () |
| Clear the contents of the list. | |
| void | pop_front (label n=1) |
| Remove first element(s) from the list (deletes pointers). | |
| bool | erase (T *item) |
| Remove the specified element from the list and delete it. | |
| void | transfer (ILList< DLListBase, T > &lst) |
| Transfer the contents of the argument into this List and annul the argument list. | |
| void | operator= (const ILList< DLListBase, T > &lst) |
| Copy assignment using the 'clone()' method for each element. | |
| void | operator= (ILList< DLListBase, T > &&lst) |
| Move assignment. | |
| Public Member Functions inherited from UILList< DLListBase, T > | |
| UILList ()=default | |
| Default construct. | |
| UILList (T *item) | |
| Construct and add initial item pointer. | |
| UILList (const UILList< DLListBase, T > &list) | |
| Construct as copy. | |
| T * | front () |
| The first entry in the list. | |
| const T * | front () const |
| The first entry in the list (const access). | |
| T * | back () |
| The last entry in the list. | |
| const T * | back () const |
| The last entry in the list (const access). | |
| T * | removeHead () |
| Remove and return head. | |
| T * | remove (T *item) |
| Remove and return element. | |
| T * | remove (iterator &iter) |
| Remove and return item specified by iterator. | |
| void | operator= (const UILList< DLListBase, T > &lst) |
| Copy assignment. | |
| bool | operator== (const UILList< DLListBase, T > &lst) const |
| Equality. True both lists are element-wise equal. | |
| bool | operator!= (const UILList< DLListBase, T > &lst) const |
| The opposite of the equality operation. Takes linear time. | |
| Ostream & | writeList (Ostream &os, const label shortLen=0) const |
| Write UILList with line-breaks when length exceeds shortLen. | |
| iterator | begin () |
| Iterator to first item in list with non-const access. | |
| const_iterator | cbegin () const |
| Iterator to first item in list with const access. | |
| reverse_iterator | rbegin () |
| Iterator to last item in list with non-const access. | |
| const_reverse_iterator | crbegin () const |
| Iterator to last item in list with const access. | |
| const_iterator | begin () const |
| Iterator to first item in list with const access. | |
| const_reverse_iterator | rbegin () const |
| Iterator to last item in list with const access. | |
| const iterator & | end () |
| End of list for forward iterators. | |
| const const_iterator & | cend () const |
| End of list for forward iterators. | |
| const reverse_iterator & | rend () |
| End of list for reverse iterators. | |
| const const_reverse_iterator & | crend () const |
| End of list for reverse iterators. | |
| const const_iterator & | end () const |
| End of list for forward iterators. | |
| const const_reverse_iterator & | rend () const |
| End of list for reverse iterators. | |
| T * | first () |
| The first entry in the list. | |
| const T * | first () const |
| The first entry in the list (const access). | |
| T * | last () |
| The last entry in the list. | |
| const T * | last () const |
| The last entry in the list (const access). | |
| Public Member Functions inherited from DLListBase | |
| DLListBase ()=default | |
| Default construct. | |
| DLListBase (const DLListBase &)=delete | |
| No copy construct. | |
| void | operator= (const DLListBase &)=delete |
| No copy assignment. | |
| ~DLListBase ()=default | |
| Destructor. | |
| bool | empty () const noexcept |
| True if the list is empty. | |
| label | size () const noexcept |
| The number of elements in list. | |
| link * | front () |
| Return first entry. | |
| const link * | front () const |
| Return const access to first entry. | |
| link * | back () |
| Return last entry. | |
| const link * | back () const |
| Return const access to last entry. | |
| void | push_front (link *item) |
| Add at front of list. | |
| void | push_back (link *item) |
| Add at back of list. | |
| bool | swapUp (link *item) |
| Swap this element with the one above unless it is at the top. | |
| bool | swapDown (link *item) |
| Swap this element with the one below unless it is at the bottom. | |
| link * | removeHead () |
| Remove and return first entry. | |
| link * | remove (link *item) |
| Remove and return element. | |
| link * | remove (iterator &iter) |
| Remove and return element specified by iterator. | |
| link * | replace (link *oldLink, link *newLink) |
| Replace oldLink with newLink and return element. | |
| link * | replace (iterator &oldIter, link *newitem) |
| Replace oldIter with newItem and return element. | |
| void | clear () |
| Clear the list. | |
| void | swap (DLListBase &lst) |
| Swap the contents of the list. | |
| void | transfer (DLListBase &lst) |
| Transfer the contents of the argument into this list and annul the argument list. | |
| iterator | begin () |
| Iterator to first item in list with non-const access. | |
| const_iterator | cbegin () const |
| Iterator to first item in list with const access. | |
| const_iterator | crbegin () const |
| Iterator to last item in list with const access. | |
| const iterator & | end () |
| End of list for iterators. | |
| const const_iterator & | cend () const |
| End of list for iterators. | |
| const const_iterator & | crend () const |
| End of list for reverse iterators. | |
| link * | first () |
| Return first entry. | |
| const link * | first () const |
| Return const access to first entry. | |
| link * | last () |
| Return last entry. | |
| const link * | last () const |
| Return const access to last entry. | |
| void | prepend (link *item) |
| Add at front of list. | |
| void | append (link *item) |
| Add at back of list. | |
| Public Member Functions inherited from DSMCBaseCloud | |
| TypeName ("DSMCBaseCloud") | |
| Runtime type information. | |
| DSMCBaseCloud ()=default | |
| Null constructor. | |
| virtual | ~DSMCBaseCloud ()=default |
| Destructor. | |
| Public Member Functions inherited from kinematicCloud | |
| TypeName ("kinematicCloud") | |
| Runtime type information. | |
| kinematicCloud ()=default | |
| Null constructor. | |
| virtual | ~kinematicCloud ()=default |
| Destructor. | |
Public Attributes | |
| bool | log |
| Flag to write log into Info. | |
Protected Member Functions | |
| void | setModels () |
| Set cloud sub-models. | |
| template<class TrackCloudType> | |
| void | solve (TrackCloudType &cloud, typename parcelType::trackingData &td) |
| Solve the cloud - calls all evolution functions. | |
| void | buildCellOccupancy () |
| Build the cellOccupancy. | |
| void | updateCellOccupancy () |
| Update (i.e. build) the cellOccupancy if it has. | |
| template<class TrackCloudType> | |
| void | evolveCloud (TrackCloudType &cloud, typename parcelType::trackingData &td) |
| Evolve the cloud. | |
| void | postEvolve (const typename parcelType::trackingData &td) |
| Post-evolve. | |
| void | cloudReset (KinematicCloud< CloudType > &c) |
| Reset state of cloud. | |
| Protected Member Functions inherited from regIOobject | |
| bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
| Helper: check readOpt flags and read if necessary. | |
| Protected Member Functions inherited from IOobject | |
| void | setBad (const string &s) |
| Set the object state to bad. | |
| Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| IteratorType | iterator_first () const |
| Return iterator to first item or end-iterator if list is empty. | |
| template<class IteratorType> | |
| IteratorType | iterator_last () const |
| Return iterator to last item or end-iterator if list is empty. | |
Protected Attributes | |
| const fvMesh & | mesh_ |
| References to the mesh and time databases. | |
| IOdictionary | particleProperties_ |
| Dictionary of particle properties. | |
| IOdictionary | outputProperties_ |
| Dictionary of output properties. | |
| cloudSolution | solution_ |
| Solution properties. | |
| parcelType::constantProperties | constProps_ |
| Parcel constant properties. | |
| const dictionary | subModelProperties_ |
| Sub-models dictionary. | |
| Random | rndGen_ |
| Random number generator - used by some injection routines. | |
| autoPtr< List< DynamicList< parcelType * > > > | cellOccupancyPtr_ |
| Cell occupancy information for each parcel, (demand driven). | |
| scalarField | cellLengthScale_ |
| Cell length scale. | |
| const volScalarField & | rho_ |
| Density [kg/m3]. | |
| const volVectorField & | U_ |
| Velocity [m/s]. | |
| const volScalarField & | mu_ |
| Dynamic viscosity [Pa.s]. | |
| const dimensionedVector & | g_ |
| Gravity. | |
| scalar | pAmbient_ |
| Averaged ambient domain pressure. | |
| forceType | forces_ |
| Optional particle forces. | |
| functionType | functions_ |
| Optional cloud function objects. | |
| InjectionModelList< KinematicCloud< CloudType > > | injectors_ |
| Injector models. | |
| autoPtr< DispersionModel< KinematicCloud< CloudType > > > | dispersionModel_ |
| Dispersion model. | |
| autoPtr< PatchInteractionModel< KinematicCloud< CloudType > > > | patchInteractionModel_ |
| Patch interaction model. | |
| autoPtr< StochasticCollisionModel< KinematicCloud< CloudType > > > | stochasticCollisionModel_ |
| Stochastic collision model. | |
| autoPtr< SurfaceFilmModel< KinematicCloud< CloudType > > > | surfaceFilmModel_ |
| Surface film model. | |
| autoPtr< PackingModel< KinematicCloud< CloudType > > > | packingModel_ |
| Packing model. | |
| autoPtr< DampingModel< KinematicCloud< CloudType > > > | dampingModel_ |
| Damping model. | |
| autoPtr< IsotropyModel< KinematicCloud< CloudType > > > | isotropyModel_ |
| Exchange model. | |
| autoPtr< integrationScheme > | UIntegrator_ |
| Velocity integration. | |
| autoPtr< volScalarField::Internal > | rhokTrans_ |
| Mass for kinematic cloud. | |
| autoPtr< volVectorField::Internal > | UTrans_ |
| Momentum. | |
| autoPtr< volScalarField::Internal > | UCoeff_ |
| Coefficient for carrier phase U equation. | |
| Protected Attributes inherited from Cloud< ParticleType > | |
| cloud::geometryType | geometryType_ |
| Geometry type. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from cloud | |
| template<class Type> | |
| static IOField< Type > & | createIOField (const word &fieldName, const label nParticle, objectRegistry &obr) |
| Helper to construct IOField on a supplied object registry. | |
| template<class Type> | |
| static const IOField< Type > * | findIOField (const word &fieldName, const objectRegistry &obr) |
| Locate an IOField within object registry. | |
| static const IOField< point > * | findIOPosition (const objectRegistry &obr) |
| Locate the "position" IOField within object registry. | |
| template<class Type> | |
| static const IOField< Type > & | lookupIOField (const word &fieldName, const objectRegistry &obr) |
| Lookup an IOField within object registry. | |
| template<class Type> | |
| static const IOField< Type > & | lookupIOField (const char *fieldName, const objectRegistry &obr) |
| Lookup an IOField within object registry. | |
| Static Public Member Functions inherited from regIOobject | |
| template<class Type> | |
| static Type & | store (Type *p) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (std::unique_ptr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (autoPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (refPtr< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &ptr) |
| Transfer pointer ownership to its registry. | |
| template<class Type> | |
| static Type & | store (tmp< Type > &&ptr) |
| Transfer pointer ownership to its registry. | |
| Static Public Member Functions inherited from IOobject | |
| static bool | bannerEnabled () noexcept |
| Status of output file banner. | |
| static bool | bannerEnabled (bool on) noexcept |
| Enable/disable output file banner. | |
| static bool | fileModificationChecking_masterOnly () noexcept |
| Test fileModificationChecking for master-only. | |
| static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
| Split path into instance, local, name components. | |
| template<class StringType> | |
| static word | groupName (StringType base, const word &group) |
| Create dot-delimited name.group string. | |
| static word | group (const word &name) |
| Return group (extension part of name). | |
| static word | member (const word &name) |
| Return member (name without the extension). | |
| static word | scopedName (const std::string &scope, const word &name) |
| Create scope:name or scope_name string. | |
| static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
| Create scope:name1:name2 or scope_name1_name2 string. | |
| static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
| Return the IOobject, but also consider an alternative file name. | |
| static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
| Write the standard OpenFOAM file/dictionary banner. | |
| static Ostream & | writeDivider (Ostream &os) |
| Write the standard file section divider. | |
| static Ostream & | writeEndDivider (Ostream &os) |
| Write the standard end file divider. | |
| Static Public Member Functions inherited from IOobjectOption | |
| static bool | isAnyRead (readOption opt) noexcept |
| True if any reading may be required (ie, != NO_READ). | |
| static bool | isReadRequired (readOption opt) noexcept |
| True if (MUST_READ | READ_MODIFIED) bits are set. | |
| static bool | isReadOptional (readOption opt) noexcept |
| True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. | |
| static readOption | lazierRead (readOption opt) noexcept |
| Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. | |
| Static Public Member Functions inherited from HashTableCore | |
| static label | canonicalSize (const label size) noexcept |
| Return a canonical (power-of-two) of the requested size. | |
| Static Public Attributes inherited from Cloud< ParticleType > | |
| static word | cloudPropertiesName |
| Name of cloud properties dictionary. | |
| Static Public Attributes inherited from cloud | |
| static const Enum< geometryType > | geometryTypeNames |
| Named enumerations "coordinates", "positions". | |
| static const word | prefix |
| The prefix to local: lagrangian. | |
| static word | defaultName |
| The default cloud name: defaultCloud. | |
| Static Public Attributes inherited from IOobject | |
| static const Enum< fileCheckTypes > | fileCheckTypesNames |
| Names for the fileCheckTypes. | |
| static char | scopeSeparator |
| Character for scoping object names (':' or '_'). | |
| static fileCheckTypes | fileModificationChecking |
| Type of file modification checking. | |
| static float | fileModificationSkew |
| Time skew (seconds) for file modification checks. | |
| static int | maxFileModificationPolls |
| Max number of times to poll for file modification changes. | |
| Static Public Attributes inherited from HashTableCore | |
| static constexpr int32_t | maxTableSize = (1 << (32-3)) |
| Maximum allowable internal table size (must be a power of two!). | |
| Static Protected Member Functions inherited from IOobject | |
| static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
| Helper: write content for FoamFile IOobject header with optional meta information. | |
| static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
| Helper: write dictionary content for FoamFile header with optional meta information. | |
| Static Protected Member Functions inherited from DLListBase | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_end () |
| Factory method to return an iterator end. | |
| template<class IteratorType> | |
| static const IteratorType & | iterator_rend () |
| Factory method to return an iterator reverse end. | |
| Static Protected Attributes inherited from regIOobject | |
| static bool | masterOnlyReading = false |
| To flag master-only reading of objects. | |
Templated base class for kinematic cloud.
Definition at line 108 of file KinematicCloud.H.
Type of cloud this cloud was instantiated for.
Definition at line 120 of file KinematicCloud.H.
| typedef CloudType::particleType parcelType |
Type of parcel the cloud was instantiated for.
Definition at line 125 of file KinematicCloud.H.
| typedef KinematicCloud<CloudType> kinematicCloudType |
Convenience typedef for this cloud type.
Definition at line 130 of file KinematicCloud.H.
| typedef ParticleForceList<KinematicCloud<CloudType> > forceType |
Force models type.
Definition at line 135 of file KinematicCloud.H.
| typedef CloudFunctionObjectList<KinematicCloud<CloudType> > functionType |
Function object type.
Definition at line 141 of file KinematicCloud.H.
| KinematicCloud | ( | const word & | cloudName, |
| const volScalarField & | rho, | ||
| const volVectorField & | U, | ||
| const volScalarField & | mu, | ||
| const dimensionedVector & | g, | ||
| bool | readFields = true ) |
Construct given carrier gas fields.
Definition at line 335 of file KinematicCloud.C.
References DSMCCloud< dsmcParcel >::cloudName(), rho(), and U().
Copy constructor with new name.
Definition at line 498 of file KinematicCloud.C.
References cellLengthScale_, cellOccupancyPtr_, clone(), constProps_, dampingModel_, IOobject::db(), dispersionModel_, forces_, functions_, g_, injectors_, isotropyModel_, kinematicCloud::kinematicCloud(), log, mesh_, mu_, Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, outputProperties_, packingModel_, pAmbient_, particleProperties_, patchInteractionModel_, rho_, rhokTrans_, rndGen_, IOobject::scopedName(), solution_, stochasticCollisionModel_, subModelProperties_, surfaceFilmModel_, objectRegistry::time(), timeName, U_, UCoeff_, UIntegrator_, and UTrans_.
| KinematicCloud | ( | const fvMesh & | mesh, |
| const word & | name, | ||
| const KinematicCloud< CloudType > & | c ) |
Copy constructor with new name - creates bare cloud.
Definition at line 587 of file KinematicCloud.C.
References cellLengthScale_, cellOccupancyPtr_, constProps_, dampingModel_, dispersionModel_, forces_, functions_, g_, injectors_, isotropyModel_, kinematicCloud::kinematicCloud(), log, mesh(), mesh_, mu_, Foam::name(), IOobjectOption::NO_READ, IOobjectOption::NO_REGISTER, IOobjectOption::NO_WRITE, outputProperties_, packingModel_, pAmbient_, particleProperties_, patchInteractionModel_, cloud::prefix, rho_, rhokTrans_, rndGen_, solution_, stochasticCollisionModel_, subModelProperties_, surfaceFilmModel_, objectRegistry::time(), timeName, U_, UCoeff_, UIntegrator_, and UTrans_.
|
virtualdefault |
Destructor.
|
protected |
Set cloud sub-models.
Definition at line 43 of file KinematicCloud.C.
References dampingModel_, dispersionModel_, isotropyModel_, integrationScheme::New(), Foam::New(), packingModel_, patchInteractionModel_, solution_, stochasticCollisionModel_, subModelProperties_, surfaceFilmModel_, and UIntegrator_.
|
protected |
Solve the cloud - calls all evolution functions.
Definition at line 121 of file KinematicCloud.C.
References addProfiling, evolveCloud(), IOobject::info(), log, solution_, and td().
|
protected |
Build the cellOccupancy.
Definition at line 168 of file KinematicCloud.C.
References cellOccupancy(), cellOccupancyPtr_, mesh_, p, and DLListBase::size().
Referenced by cellOccupancy(), and updateCellOccupancy().
|
protected |
Update (i.e. build) the cellOccupancy if it has.
already been used
Definition at line 200 of file KinematicCloud.C.
References buildCellOccupancy(), and cellOccupancyPtr_.
Referenced by evolveCloud(), motion(), and preEvolve().
|
protected |
Evolve the cloud.
Definition at line 214 of file KinematicCloud.C.
References injectors_, Cloud< ParticleType >::move(), DLListBase::size(), solution_, stochasticCollision(), surfaceFilm, td(), and updateCellOccupancy().
Referenced by solve().
|
protected |
Post-evolve.
Definition at line 260 of file KinematicCloud.C.
References IOstreamOption::ASCII, dampingModel(), IOobject::db(), dispersion(), Foam::endl(), forces_, functions_, Log_, outputProperties_, packingModel(), patchInteraction(), solution_, td(), objectRegistry::time(), and Cloud< ParticleType >::writePositions().
Reset state of cloud.
Definition at line 307 of file KinematicCloud.C.
References Cloud< ParticleType >::cloudReset(), dampingModel_, dispersionModel_, forces_, functions_, injectors_, isotropyModel_, packingModel_, patchInteractionModel_, rndGen_, stochasticCollisionModel_, surfaceFilmModel_, and UIntegrator_.
Referenced by restoreState().
|
inlinevirtual |
Construct and return clone based on (this) with new name.
Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >, MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >, and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >.
Definition at line 435 of file KinematicCloud.H.
Referenced by KinematicCloud(), and storeState().
|
inlinevirtual |
Construct and return bare clone based on (this) with new name.
Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >, MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >, and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >.
Definition at line 446 of file KinematicCloud.H.
|
inline |
Return a reference to the cloud copy.
Definition at line 28 of file KinematicCloudI.H.
|
inline |
Return reference to the mesh.
Definition at line 35 of file KinematicCloudI.H.
References mesh_.
Referenced by KinematicCloud< Cloud< basicKinematicParcel > >::cloneBare(), CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CollidingCloud(), KinematicCloud(), MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >::MPPICCloud(), and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >::ThermoCloud().
|
inline |
Return particle properties dictionary.
Definition at line 43 of file KinematicCloudI.H.
References particleProperties_.
|
inline |
Return output properties dictionary.
Definition at line 51 of file KinematicCloudI.H.
References outputProperties_.
|
inline |
Return non-const access to the output properties dictionary.
Definition at line 58 of file KinematicCloudI.H.
References outputProperties_.
|
inline |
Return const access to the solution properties.
Definition at line 66 of file KinematicCloudI.H.
References solution_.
|
inline |
Return access to the solution properties.
Definition at line 73 of file KinematicCloudI.H.
References solution_.
|
inline |
Return the constant properties.
Definition at line 81 of file KinematicCloudI.H.
References constProps_.
|
inline |
Return access to the constant properties.
Definition at line 89 of file KinematicCloudI.H.
References constProps_.
|
inline |
Return reference to the sub-models dictionary.
Definition at line 97 of file KinematicCloudI.H.
References subModelProperties_.
|
inline |
Return reference to the random object.
Definition at line 403 of file KinematicCloudI.H.
References rndGen_.
|
inline |
Return the cell occupancy information for each.
parcel, non-const access, the caller is responsible for updating it for its own purposes if particles are removed or created.
Definition at line 411 of file KinematicCloudI.H.
References buildCellOccupancy(), and cellOccupancyPtr_.
Referenced by buildCellOccupancy().
|
inline |
Return the cell length scale.
Definition at line 424 of file KinematicCloudI.H.
References cellLengthScale_.
|
inline |
Return carrier gas velocity.
Definition at line 111 of file KinematicCloudI.H.
References U_.
Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CollidingCloud(), KinematicCloud(), MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >::MPPICCloud(), SU(), and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >::ThermoCloud().
|
inline |
Return carrier gas density.
Definition at line 104 of file KinematicCloudI.H.
References rho_.
Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CollidingCloud(), KinematicCloud(), MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >::MPPICCloud(), and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >::ThermoCloud().
|
inline |
Return carrier gas dynamic viscosity.
Definition at line 118 of file KinematicCloudI.H.
References mu_.
Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CollidingCloud(), and MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >::MPPICCloud().
|
inline |
Gravity.
Definition at line 125 of file KinematicCloudI.H.
References g_.
Referenced by CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >::CollidingCloud(), MPPICCloud< KinematicCloud< Cloud< basicKinematicMPPICParcel > > >::MPPICCloud(), and ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >::ThermoCloud().
|
inline |
Return const-access to the ambient pressure.
Definition at line 132 of file KinematicCloudI.H.
References pAmbient_.
|
inline |
Return reference to the ambient pressure.
Definition at line 139 of file KinematicCloudI.H.
References pAmbient_.
|
inline |
|
inline |
Return the optional particle forces.
Definition at line 156 of file KinematicCloudI.H.
References forces_.
|
inline |
Optional cloud function objects.
Definition at line 164 of file KinematicCloudI.H.
References functions_.
|
inline |
Return const access to the injection model.
Definition at line 172 of file KinematicCloudI.H.
References injectors_.
|
inline |
Return reference to the injection model.
Definition at line 180 of file KinematicCloudI.H.
References injectors_.
|
inline |
Return const-access to the dispersion model.
Definition at line 188 of file KinematicCloudI.H.
References dispersionModel_.
Referenced by postEvolve(), and preEvolve().
|
inline |
Return reference to the dispersion model.
Definition at line 196 of file KinematicCloudI.H.
References dispersionModel_.
|
inline |
Return const-access to the patch interaction model.
Definition at line 204 of file KinematicCloudI.H.
References patchInteractionModel_.
Referenced by postEvolve().
|
inline |
Return reference to the patch interaction model.
Definition at line 212 of file KinematicCloudI.H.
References patchInteractionModel_.
|
inline |
Return const-access to the stochastic collision model.
Definition at line 220 of file KinematicCloudI.H.
References stochasticCollisionModel_.
Referenced by evolveCloud().
|
inline |
Return reference to the stochastic collision model.
Definition at line 228 of file KinematicCloudI.H.
References stochasticCollisionModel_.
|
inline |
Return const-access to the surface film model.
Definition at line 236 of file KinematicCloudI.H.
References surfaceFilmModel_.
|
inline |
Return reference to the surface film model.
Definition at line 244 of file KinematicCloudI.H.
References surfaceFilmModel_.
|
inline |
Return const access to the packing model.
Definition at line 252 of file KinematicCloudI.H.
References packingModel_.
Referenced by postEvolve(), and preEvolve().
|
inline |
Return a reference to the packing model.
Definition at line 260 of file KinematicCloudI.H.
References packingModel_.
|
inline |
Return const access to the damping model.
Definition at line 268 of file KinematicCloudI.H.
References dampingModel_.
Referenced by postEvolve(), and preEvolve().
|
inline |
Return a reference to the damping model.
Definition at line 276 of file KinematicCloudI.H.
References dampingModel_.
|
inline |
Return const access to the isotropy model.
Definition at line 284 of file KinematicCloudI.H.
References isotropyModel_.
|
inline |
Return a reference to the isotropy model.
Definition at line 292 of file KinematicCloudI.H.
References isotropyModel_.
|
inline |
Return reference to velocity integration.
Definition at line 300 of file KinematicCloudI.H.
References UIntegrator_.
|
inline |
Transfer the effect of parcel to the carrier phase.
Definition at line 431 of file KinematicCloudI.H.
References p, rhokTrans(), td(), and UTrans().
|
inline |
Return reference to mass for kinematic source.
Definition at line 447 of file KinematicCloudI.H.
References rhokTrans_.
Referenced by relaxSources(), resetSourceTerms(), and transferToCarrier().
|
inline |
Return const reference to mass for kinematic source.
Definition at line 455 of file KinematicCloudI.H.
References rhokTrans_.
|
inline |
Return reference to momentum source.
Definition at line 463 of file KinematicCloudI.H.
References UTrans_.
Referenced by relaxSources(), resetSourceTerms(), and transferToCarrier().
|
inline |
Return const reference to momentum source.
Definition at line 471 of file KinematicCloudI.H.
References UTrans_.
|
inline |
Return coefficient for carrier phase U equation.
Definition at line 479 of file KinematicCloudI.H.
Referenced by relaxSources(), and resetSourceTerms().
|
inline |
Return const coefficient for carrier phase U equation.
Definition at line 487 of file KinematicCloudI.H.
References UCoeff_.
|
inline |
Return tmp mass source for kinematic.
Definition at line 495 of file KinematicCloudI.H.
|
inline |
Return tmp momentum source term (compressible).
Definition at line 522 of file KinematicCloudI.H.
References U().
|
inlinevirtual |
Total number of parcels.
Reimplemented from Cloud< ParticleType >.
Definition at line 767 of file KinematicCloud.H.
|
inlinevirtual |
Total mass in system.
Implements kinematicCloud.
Definition at line 307 of file KinematicCloudI.H.
References p.
|
inlinevirtual |
Total linear momentum of the system.
Implements kinematicCloud.
Definition at line 321 of file KinematicCloudI.H.
References p, and Foam::Zero.
|
inline |
|
inlinevirtual |
Total linear kinetic energy in the system.
Implements kinematicCloud.
Definition at line 351 of file KinematicCloudI.H.
References p.
|
inline |
Total rotational kinetic energy in the system.
|
inlinevirtual |
Mean diameter Dij.
Implements kinematicCloud.
Definition at line 365 of file KinematicCloudI.H.
References Foam::max(), p, Foam::pow(), and Foam::reduce().
|
inlinevirtual |
Max diameter.
Implements kinematicCloud.
Definition at line 388 of file KinematicCloudI.H.
References Foam::max(), p, and Foam::reduce().
|
inlinevirtual |
Volume swept rate of parcels per cell.
Implements kinematicCloud.
Definition at line 570 of file KinematicCloudI.H.
|
inlinevirtual |
Return the particle volume fraction field.
Note: for particles belonging to this cloud only
Implements kinematicCloud.
Definition at line 597 of file KinematicCloudI.H.
References tmp< T >::New().
|
inlinevirtual |
Return the particle mass fraction field.
Note: for particles belonging to this cloud only
Implements kinematicCloud.
Definition at line 624 of file KinematicCloudI.H.
References alpha(), Foam::dimless, mesh_, name, tmp< T >::New(), objectRegistry::newIOobject(), p, IOobject::scopedName(), and Foam::Zero.
Referenced by alpha().
|
inlinevirtual |
Return the particle effective density field.
Note: for particles belonging to this cloud only
Implements kinematicCloud.
Definition at line 649 of file KinematicCloudI.H.
References Foam::dimDensity, mesh_, name, tmp< T >::New(), objectRegistry::newIOobject(), p, rhoEff(), IOobject::scopedName(), and Foam::Zero.
Referenced by rhoEff().
| void setParcelThermoProperties | ( | parcelType & | parcel, |
| const scalar | lagrangianDt ) |
Set parcel thermo properties.
Definition at line 657 of file KinematicCloud.C.
References constProps_.
| void checkParcelProperties | ( | parcelType & | parcel, |
| const scalar | lagrangianDt, | ||
| const bool | fullyDescribed ) |
Check parcel properties.
Definition at line 672 of file KinematicCloud.C.
References Foam::abort(), constProps_, Foam::FatalError, FatalErrorInFunction, mesh_, and Foam::nl.
| void storeState | ( | ) |
Store the current cloud state.
Definition at line 698 of file KinematicCloud.C.
| void restoreState | ( | ) |
Reset the current cloud to the previously stored state.
Definition at line 711 of file KinematicCloud.C.
References cloudReset().
| void resetSourceTerms | ( | ) |
Reset the cloud source terms.
Definition at line 719 of file KinematicCloud.C.
References rhokTrans(), UCoeff(), UTrans(), and Foam::Zero.
| void relax | ( | DimensionedField< Type, volMesh > & | field, |
| const DimensionedField< Type, volMesh > & | field0, | ||
| const word & | name ) const |
Relax field.
Definition at line 729 of file KinematicCloud.C.
References field(), Foam::name(), and solution_.
| void scale | ( | DimensionedField< Type, volMesh > & | field, |
| const word & | name ) const |
Scale field.
Definition at line 743 of file KinematicCloud.C.
References field(), Foam::name(), and solution_.
Referenced by scaleSources().
Apply relaxation to (steady state) cloud sources.
Definition at line 755 of file KinematicCloud.C.
References relax(), rhokTrans(), rhokTrans_, UCoeff(), UCoeff_, UTrans(), and UTrans_.
| void scaleSources | ( | ) |
Apply scaling to (transient) cloud sources.
Definition at line 767 of file KinematicCloud.C.
References rhokTrans_, scale(), UCoeff_, and UTrans_.
| void preEvolve | ( | const typename parcelType::trackingData & | td | ) |
Pre-evolve.
Definition at line 776 of file KinematicCloud.C.
References constProps_, dampingModel(), dispersion(), Foam::endl(), forces_, functions_, Log_, mesh_, name, packingModel(), pAmbient_, td(), and updateCellOccupancy().
| void evolve | ( | ) |
Evolve the cloud.
Definition at line 814 of file KinematicCloud.C.
References solution_, solve(), and td().
| void motion | ( | TrackCloudType & | cloud, |
| typename parcelType::trackingData & | td ) |
Particle motion.
Definition at line 826 of file KinematicCloud.C.
References isotropyModel_, Cloud< ParticleType >::move(), solution_, td(), and updateCellOccupancy().
| void patchData | ( | const parcelType & | p, |
| const polyPatch & | pp, | ||
| vector & | normal, | ||
| vector & | Up ) const |
Calculate the patch normal and velocity to interact with,.
accounting for patch motion if required.
Definition at line 846 of file KinematicCloud.C.
| void updateMesh | ( | ) |
Update mesh.
Definition at line 888 of file KinematicCloud.C.
Referenced by autoMap().
|
virtual |
Remap the cells of particles corresponding to the.
mesh topology change with a default tracking data object
Reimplemented from DSMCCloud< dsmcParcel >.
Reimplemented in ThermoCloud< KinematicCloud< Cloud< basicThermoParcel > > >.
Definition at line 897 of file KinematicCloud.C.
References Cloud< ParticleType >::autoMap(), and updateMesh().
| void info | ( | ) |
Print cloud information.
Definition at line 906 of file KinematicCloud.C.
|
virtual |
Read particle fields from objects in the obr registry.
Reimplemented from cloud.
Definition at line 981 of file KinematicCloud.C.
References cloud::readObjects().
|
virtual |
Write particle fields as objects into the obr registry.
Reimplemented from cloud.
Definition at line 988 of file KinematicCloud.C.
References cloud::writeObjects().
References to the mesh and time databases.
Definition at line 174 of file KinematicCloud.H.
Referenced by alpha(), buildCellOccupancy(), checkParcelProperties(), KinematicCloud(), KinematicCloud(), mesh(), preEvolve(), and rhoEff().
|
protected |
Dictionary of particle properties.
Definition at line 179 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), and particleProperties().
|
protected |
Dictionary of output properties.
Definition at line 184 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), outputProperties(), outputProperties(), and postEvolve().
|
protected |
Solution properties.
Definition at line 189 of file KinematicCloud.H.
Referenced by evolve(), evolveCloud(), KinematicCloud(), KinematicCloud(), motion(), postEvolve(), relax(), scale(), setModels(), solution(), solution(), and solve().
|
protected |
Parcel constant properties.
Definition at line 194 of file KinematicCloud.H.
Referenced by checkParcelProperties(), constProps(), constProps(), KinematicCloud(), KinematicCloud(), preEvolve(), and setParcelThermoProperties().
|
protected |
Sub-models dictionary.
Definition at line 199 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), setModels(), and subModelProperties().
Random number generator - used by some injection routines.
Definition at line 204 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), and rndGen().
|
protected |
Cell occupancy information for each parcel, (demand driven).
Definition at line 209 of file KinematicCloud.H.
Referenced by buildCellOccupancy(), cellOccupancy(), KinematicCloud(), KinematicCloud(), and updateCellOccupancy().
|
protected |
Cell length scale.
Definition at line 214 of file KinematicCloud.H.
Referenced by cellLengthScale(), KinematicCloud(), and KinematicCloud().
|
protected |
Density [kg/m3].
Definition at line 222 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), and rho().
|
protected |
Velocity [m/s].
Definition at line 227 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), and U().
|
protected |
Dynamic viscosity [Pa.s].
Definition at line 232 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), and mu().
|
protected |
Gravity.
Definition at line 240 of file KinematicCloud.H.
Referenced by g(), KinematicCloud(), and KinematicCloud().
|
protected |
Averaged ambient domain pressure.
Definition at line 245 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), pAmbient(), pAmbient(), and preEvolve().
Optional particle forces.
Definition at line 251 of file KinematicCloud.H.
Referenced by cloudReset(), forces(), forces(), KinematicCloud(), KinematicCloud(), postEvolve(), and preEvolve().
|
protected |
Optional cloud function objects.
Definition at line 256 of file KinematicCloud.H.
Referenced by cloudReset(), functions(), KinematicCloud(), KinematicCloud(), postEvolve(), and preEvolve().
|
protected |
Injector models.
Definition at line 264 of file KinematicCloud.H.
Referenced by cloudReset(), evolveCloud(), injectors(), injectors(), KinematicCloud(), and KinematicCloud().
|
protected |
Dispersion model.
Definition at line 270 of file KinematicCloud.H.
Referenced by cloudReset(), dispersion(), dispersion(), KinematicCloud(), KinematicCloud(), and setModels().
|
protected |
Patch interaction model.
Definition at line 276 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), patchInteraction(), patchInteraction(), and setModels().
|
protected |
Stochastic collision model.
Definition at line 282 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), setModels(), stochasticCollision(), and stochasticCollision().
|
protected |
Surface film model.
Definition at line 288 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), setModels(), surfaceFilm(), and surfaceFilm().
|
protected |
Packing model.
Definition at line 294 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), packingModel(), packingModel(), and setModels().
|
protected |
Damping model.
Definition at line 300 of file KinematicCloud.H.
Referenced by cloudReset(), dampingModel(), dampingModel(), KinematicCloud(), KinematicCloud(), and setModels().
|
protected |
Exchange model.
Definition at line 306 of file KinematicCloud.H.
Referenced by cloudReset(), isotropyModel(), isotropyModel(), KinematicCloud(), KinematicCloud(), motion(), and setModels().
|
protected |
Velocity integration.
Definition at line 314 of file KinematicCloud.H.
Referenced by cloudReset(), KinematicCloud(), KinematicCloud(), setModels(), and UIntegrator().
|
protected |
Mass for kinematic cloud.
Definition at line 322 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), relaxSources(), rhokTrans(), rhokTrans(), and scaleSources().
|
protected |
Momentum.
Definition at line 327 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), relaxSources(), scaleSources(), UTrans(), and UTrans().
|
protected |
Coefficient for carrier phase U equation.
Definition at line 332 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), relaxSources(), scaleSources(), and UCoeff().
| bool log |
Flag to write log into Info.
Definition at line 395 of file KinematicCloud.H.
Referenced by KinematicCloud(), KinematicCloud(), and solve().
1.16.1 