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