KinematicCloud< CloudType > Class Template Reference

Templated base class for kinematic cloud. More...

Inheritance diagram for KinematicCloud< CloudType >:
[legend]
Collaboration diagram for KinematicCloud< CloudType >:
[legend]

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< CloudTypekinematicCloudType
 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 class  geometryType { COORDINATES , POSITIONS }
 Cloud geometry type (internal or IO representations) More...
 
- Public Types inherited from IOobject
enum  readOption : char { NO_READ = 0 , MUST_READ = 1 , MUST_READ_IF_MODIFIED = 3 , READ_IF_PRESENT = 4 }
 Enumeration defining the read options. More...
 
enum  writeOption : char { NO_WRITE = 0 , AUTO_WRITE = 0x10 }
 Enumeration defining the write options. More...
 
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 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< zero::null, typenamestd::remove_cv< regIOobject * >::type >::value, Detail::HashTableSingle< word >, Detail::HashTablePair< word, regIOobject * > >::type node_type
 
typedef word key_type
 The second template parameter, type of keys used. More...
 
typedef regIOobjectmapped_type
 The first template parameter, type of objects contained. More...
 
typedef regIOobjectvalue_type
 Same as mapped_type for OpenFOAM HashTables. More...
 
typedef Foam::Hash< wordhasher
 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 Tpointer
 Pointer for value_type. More...
 
typedef const Tconst_pointer
 Const pointer for value_type. More...
 
typedef Treference
 Reference for value_type. More...
 
typedef const Tconst_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 KinematicCloudcloudCopy () const
 Return a reference to the cloud copy. More...
 
const fvMeshmesh () const
 Return reference to the mesh. More...
 
const IOdictionaryparticleProperties () const
 Return particle properties dictionary. More...
 
const IOdictionaryoutputProperties () const
 Return output properties dictionary. More...
 
IOdictionaryoutputProperties ()
 Return non-const access to the output properties dictionary. More...
 
const cloudSolutionsolution () const
 Return const access to the solution properties. More...
 
cloudSolutionsolution ()
 Return access to the solution properties. More...
 
const parcelType::constantPropertiesconstProps () const
 Return the constant properties. More...
 
parcelType::constantPropertiesconstProps ()
 Return access to the constant properties. More...
 
const dictionarysubModelProperties () const
 Return reference to the sub-models dictionary. More...
 
RandomrndGen () const
 Return reference to the random object. More...
 
List< DynamicList< parcelType * > > & cellOccupancy ()
 Return the cell occupancy information for each. More...
 
const scalarFieldcellLengthScale () const
 Return the cell length scale. More...
 
const volVectorFieldU () const
 Return carrier gas velocity. More...
 
const volScalarFieldrho () const
 Return carrier gas density. More...
 
const volScalarFieldmu () const
 Return carrier gas dynamic viscosity. More...
 
const dimensionedVectorg () const
 Gravity. More...
 
scalar pAmbient () const
 Return const-access to the ambient pressure. More...
 
scalar & pAmbient ()
 Return reference to the ambient pressure. More...
 
const forceTypeforces () const
 Optional particle forces. More...
 
forceTypeforces ()
 Return the optional particle forces. More...
 
functionTypefunctions ()
 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 integrationSchemeUIntegrator () const
 Return reference to velocity integration. More...
 
volVectorField::InternalUTrans ()
 Return reference to momentum source. More...
 
const volVectorField::InternalUTrans () const
 Return const reference to momentum source. More...
 
volScalarField::InternalUCoeff ()
 Return coefficient for carrier phase U equation. More...
 
const volScalarField::InternalUCoeff () const
 Return const coefficient for carrier phase U equation. More...
 
tmp< fvVectorMatrixSU (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< volScalarFieldvDotSweep () const
 Volume swept rate of parcels per cell. More...
 
const tmp< volScalarFieldtheta () const
 Return the particle volume fraction field. More...
 
const tmp< volScalarFieldalpha () const
 Return the particle mass fraction field. More...
 
const tmp< volScalarFieldrhoEff () 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 wordcloudName () const
 Return the cloud type. More...
 
const fvMeshmesh () const
 Return reference to the mesh. More...
 
const IOdictionaryparticleProperties () 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...
 
volScalarFieldsigmaTcRMax ()
 Return the sigmaTcRMax field. non-const access to allow. More...
 
scalarFieldcollisionSelectionRemainder ()
 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...
 
RandomrndGen ()
 Return reference to the random object. More...
 
volScalarField::BoundaryqBF ()
 Return non-const heat flux boundary field reference. More...
 
volVectorField::BoundaryfDBF ()
 Return non-const force density at boundary field reference. More...
 
volScalarField::BoundaryrhoNBF ()
 Return non-const number density boundary field reference. More...
 
volScalarField::BoundaryrhoMBF ()
 Return non-const mass density boundary field reference. More...
 
volScalarField::BoundarylinearKEBF ()
 Return non-const linear kinetic energy density boundary. More...
 
volScalarField::BoundaryinternalEBF ()
 Return non-const internal energy density boundary field. More...
 
volScalarField::BoundaryiDofBF ()
 Return non-const internal degree of freedom density boundary. More...
 
volVectorField::BoundarymomentumBF ()
 Return non-const momentum density boundary field reference. More...
 
const volScalarFieldboundaryT () const
 Return macroscopic temperature. More...
 
const volVectorFieldboundaryU () const
 Return macroscopic velocity. More...
 
const volScalarFieldq () const
 Return heat flux at surface field. More...
 
const volVectorFieldfD () const
 Return force density at surface field. More...
 
const volScalarFieldrhoN () const
 Return the real particle number density field. More...
 
const volScalarFieldrhoM () const
 Return the particle mass density field. More...
 
const volScalarFielddsmcRhoN () const
 Return the field of number of DSMC particles. More...
 
const volScalarFieldlinearKE () const
 Return the total linear kinetic energy (translational and. More...
 
const volScalarFieldinternalE () const
 Return the internal energy density field. More...
 
const volScalarFieldiDof () const
 Return the average internal degrees of freedom field. More...
 
const volVectorFieldmomentum () 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...
 
virtual void autoMap (const mapPolyMesh &)
 Remap the particles to the correct cells following mesh change. More...
 
- Public Member Functions inherited from Cloud< ParcelType >
 TypeName ("Cloud")
 Runtime type information. 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)
 Construct from mesh by reading from file with given cloud instance. More...
 
const polyMeshpMesh () const
 Return the polyMesh reference. More...
 
virtual label nParcels () const
 Return the number of particles in the cloud. 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 ParticleType::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, const IOobject::readOption r) 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 valid) 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 objectRegistry &obr)
 Construct for given objectRegistry and default cloud name. More...
 
 cloud (const objectRegistry &obr, const word &cloudName)
 Construct for given objectRegistry and named cloud instance. More...
 
virtual ~cloud ()=default
 Destructor. More...
 
virtual label nParcels () const
 Number of parcels for the hosting cloud. More...
 
virtual void autoMap (const mapPolyMesh &)
 
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...
 
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 nObjects=128)
 
 objectRegistry (const IOobject &io, const label nObjects=128)
 
virtual ~objectRegistry ()
 Destructor, with checkOut() for all objects that are ownedByRegistry. More...
 
const objectRegistrythisDb () const noexcept
 Return the object registry. More...
 
const objectRegistryparent () const noexcept
 Return the parent objectRegistry. More...
 
const Timetime () const noexcept
 Return time registry. More...
 
bool isTimeDb () const noexcept
 True if the registry is Time. More...
 
virtual const fileNamedbDir () const
 Local directory path of this objectRegistry relative to the time. More...
 
HashTable< wordHashSetclasses () const
 A summary hash of classes used and their associated object names. More...
 
template<class MatchPredicate >
HashTable< wordHashSetclasses (const MatchPredicate &matchName) const
 
UPtrList< const regIOobjectcsorted () const
 Return sorted list of objects. More...
 
UPtrList< const regIOobjectsorted () const
 Return sorted list of objects. More...
 
UPtrList< regIOobjectsorted ()
 Return sorted list of objects. More...
 
template<class Type >
UPtrList< const Type > csorted () const
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type >
UPtrList< const Type > sorted () const
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type >
UPtrList< Type > sorted ()
 Return sorted list of objects with a class satisfying isA<Type> More...
 
template<class Type , class MatchPredicate >
UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
UPtrList< const Type > sorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
UPtrList< Type > sorted (const MatchPredicate &matchName)
 
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
 
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
 
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
 
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
 
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
 
const objectRegistrysubRegistry (const word &name, const bool forceCreate=false, const bool recursive=false) const
 Lookup and return a const sub-objectRegistry. More...
 
template<class Type >
HashTable< const Type * > lookupClass (const bool strict=false) const
 Return all objects with a class satisfying isA<Type> More...
 
template<class Type >
HashTable< Type * > lookupClass (const bool strict=false)
 Return all objects with a class satisfying isA<Type> More...
 
const regIOobjectcfindIOobject (const word &name, const bool recursive=false) const
 Return const pointer to the regIOobject. More...
 
bool found (const word &name, const bool recursive=false) const
 Can the regIOobject object be found (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
 
template<class Type >
const Type & lookupObject (const word &name, const bool recursive=false) const
 
template<class Type >
Type & lookupObjectRef (const word &name, const bool recursive=false) const
 
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
 
bool checkOut (regIOobject &io) const
 
bool checkOut (const word &key) const
 
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...
 
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
 writeData function required by regIOobject but not used. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write the objects using stream options. 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 MatchPredicate >
Foam::HashTable< Foam::wordHashSetclassesImpl (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 objectRegistry &list, const MatchPredicate &matchName)
 
template<class MatchPredicate >
Foam::HashTable< Foam::wordHashSetclasses (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 >
Foam::UPtrList< const Type > csorted () const
 
template<class Type >
Foam::UPtrList< const Type > sorted () const
 
template<class Type >
Foam::UPtrList< Type > sorted ()
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > csorted (const MatchPredicate &matchName) const
 
template<class Type , class MatchPredicate >
Foam::UPtrList< const Type > sorted (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 >
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
 TypeName ("regIOobject")
 Runtime type information. More...
 
 regIOobject (const IOobject &io, const bool isTimeObject=false)
 
 regIOobject (const regIOobject &rio)
 Copy construct. More...
 
 regIOobject (const regIOobject &rio, bool registerCopy)
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 
 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
 
bool ownedByRegistry () const noexcept
 Is this object owned by the registry? More...
 
bool store ()
 
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...
 
virtual void rename (const word &newName)
 Rename. More...
 
const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data or nullptr. More...
 
dictionarygetMetaData () 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...
 
IstreamreadStream (const word &, const bool valid=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 labelListwatchIndices () const noexcept
 Read access to file-monitoring handles. More...
 
labelListwatchIndices () noexcept
 Write access to file-monitoring handles. More...
 
virtual bool modified () const
 
virtual bool readIfModified ()
 Read object if modified (as set by call to modified) More...
 
virtual bool writeData (Ostream &) const =0
 Pure virtual writeData function. More...
 
virtual bool writeObject (IOstreamOption streamOpt, const bool valid) const
 Write using stream options. More...
 
virtual bool write (const bool valid=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 comp, const bool valid) 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 &registry, readOption rOpt=NO_READ, writeOption wOpt=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 &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from name, instance, local, registry, io options. More...
 
 IOobject (const fileName &path, const objectRegistry &registry, readOption rOpt=NO_READ, writeOption wOpt=NO_WRITE, bool registerObject=true, bool globalObject=false)
 Construct from path, registry, io options. More...
 
 IOobject (const IOobject &io, const objectRegistry &registry)
 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, readOption rOpt, writeOption wOpt)
 Copy construct, resetting read/write options. More...
 
autoPtr< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
const objectRegistrydb () const noexcept
 Return the local objectRegistry. More...
 
const Timetime () const
 Return Time associated with the objectRegistry. More...
 
const wordname () const noexcept
 Return the object name. More...
 
const wordheaderClassName () const noexcept
 Return name of the class name read from header. More...
 
wordheaderClassName () noexcept
 Return non-constant access to the class name read from header. More...
 
const stringnote () const noexcept
 Return the optional note. More...
 
stringnote () noexcept
 Modifiable access to the optional note. More...
 
virtual void rename (const word &newName)
 Rename the object. More...
 
bool registerObject () const noexcept
 Should object created with this IOobject be registered? More...
 
bool registerObject (bool on) noexcept
 Change registration preference, return previous value. More...
 
bool globalObject () const noexcept
 Is object same for all processors? More...
 
bool globalObject (bool on) noexcept
 Change global-object status, return previous value. 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...
 
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...
 
virtual const dictionaryfindMetaData () const noexcept
 Return pointer to meta-data (if any) or nullptr. More...
 
readOption readOpt () const noexcept
 The read option. More...
 
readOption readOpt (readOption opt) noexcept
 Change the read option, return previous value. More...
 
writeOption writeOpt () const noexcept
 The write option. More...
 
writeOption writeOpt (writeOption opt) noexcept
 Change the write option, return previous value. More...
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 Return the Time::rootPath() More...
 
const fileNamecaseName () const
 Return the Time::caseName() More...
 
const fileNameinstance () const noexcept
 Read access to instance path component. More...
 
fileNameinstance () noexcept
 Write access to instance path component. More...
 
const fileNamelocal () const noexcept
 Read access to local path component. More...
 
fileName path () const
 The complete path. More...
 
fileName path (const word &instance, const fileName &local=fileName::null) const
 The complete path with alternative instance and local. More...
 
fileName objectPath () const
 The complete 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
 Helper for filePath that searches locally. More...
 
fileName globalFilePath (const word &typeName, const bool search=true) const
 Helper for filePath that searches up if in parallel. More...
 
IOstreamOption parseHeader (const dictionary &headerDict)
 
bool readHeader (Istream &is)
 
bool readHeader (dictionary &headerDict, Istream &is)
 
template<class Type >
bool typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
 Read header (uses typeFilePath to find file) and check its info. 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
 
void writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
 
bool good () const noexcept
 Did last readHeader() succeed? More...
 
bool bad () const noexcept
 Did last readHeader() fail? More...
 
InfoProxy< IOobjectinfo () const
 Return info proxy, for printing information to a stream. More...
 
void operator= (const IOobject &io)
 Copy assignment, copies all values (except the registry) More...
 
readOptionreadOpt () noexcept
 Access to the read option. More...
 
writeOptionwriteOpt () noexcept
 Access to the write option. More...
 
boolregisterObject () noexcept
 Access to the register object option. More...
 
boolglobalObject () noexcept
 Access to the global object option. 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)
 
- Public Member Functions inherited from HashTable< regIOobject * >
 HashTable ()
 Default construct with default (128) table capacity. More...
 
 HashTable (const label size)
 Construct given initial table capacity. More...
 
 HashTable (Istream &is, const label size=128)
 Construct from Istream with default table capacity. More...
 
 HashTable (const this_type &ht)
 Copy construct. More...
 
 HashTable (this_type &&rhs)
 Move construct. More...
 
 HashTable (std::initializer_list< std::pair< word, regIOobject * > > list)
 Construct from an initializer list. More...
 
 ~HashTable ()
 Destructor. More...
 
label capacity () const noexcept
 The size of the underlying table. More...
 
label size () const noexcept
 The number of elements in table. More...
 
bool empty () const noexcept
 True if the hash table is empty. 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 found (const word &key) const
 Return true if hashed entry is 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< wordtoc () const
 The table of contents (the keys) in unsorted order. More...
 
List< wordsortedToc () const
 The table of contents (the keys) in sorted order. More...
 
List< wordsortedToc (const Compare &comp) const
 
Foam::List< wordsortedToc (const Compare &comp) const
 
List< wordtocKeys (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocKeys (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocValues (const UnaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocValues (const UnaryPredicate &pred, const bool invert) const
 
List< wordtocEntries (const BinaryPredicate &pred, const bool invert=false) const
 
Foam::List< wordtocEntries (const BinaryPredicate &pred, const bool invert) const
 
UPtrList< const node_typecsorted () const
 
UPtrList< const node_typesorted () const
 
UPtrList< node_typesorted ()
 
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 resize (const label sz)
 Resize the hash table for efficiency. More...
 
void clear ()
 Clear all entries from table. More...
 
void clearStorage ()
 Clear the table entries and the table itself. More...
 
void swap (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Swap contents into this table. More...
 
void transfer (HashTable< regIOobject *, word, Foam::Hash< word > > &rhs)
 Transfer contents into this table. 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
 
bool operator!= (const this_type &rhs) const
 The opposite of the equality operation. More...
 
this_typeoperator+= (const this_type &rhs)
 Add entries into this HashTable. More...
 
const_iterator_pair< const_key_iterator, this_typekeys () 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...
 
OstreamprintInfo (Ostream &os) const
 Print information. More...
 
OstreamwriteKeys (Ostream &os, const label shortLen=0) const
 
- Public Member Functions inherited from HashTableCore
 ClassName ("HashTable")
 Declare type-name (with debug switch) More...
 
 HashTableCore ()=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. More...
 
bool eraseHead ()
 Remove the head element specified from the list and delete it. More...
 
bool erase (T *item)
 Remove the specified element from the list and delete it. More...
 
void clear ()
 Clear the contents of the list. More...
 
void transfer (ILList< LListBase, T > &lst)
 
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 > &lst)
 Construct as copy. More...
 
Tfirst ()
 The first entry in the list. More...
 
const Tfirst () const
 The first entry in the list (const access) More...
 
Tlast ()
 The last entry in the list. More...
 
const Tlast () const
 The last entry in the list (const access) More...
 
TremoveHead ()
 Remove and return head. More...
 
Tremove (T *item)
 Remove and return element. More...
 
Tremove (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...
 
OstreamwriteList (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 iteratorend ()
 End of list for forward iterators. More...
 
const const_iteratorcend () const
 End of list for forward iterators. More...
 
const reverse_iteratorrend ()
 End of list for reverse iterators. More...
 
const const_reverse_iteratorcrend () const
 End of list for reverse iterators. More...
 
const const_iteratorend () const
 End of list for forward iterators. More...
 
const const_reverse_iteratorrend () const
 End of list for reverse iterators. 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...
 
virtual label nParcels () const =0
 Number of parcels. More...
 
virtual scalar massInSystem () const =0
 Total mass in system. More...
 
virtual vector linearMomentumOfSystem () const =0
 Total linear momentum of the system. More...
 
virtual scalar linearKineticEnergyOfSystem () const =0
 Total linear kinetic energy in the system. More...
 
virtual scalar Dij (const label i, const label j) const =0
 Mean diameter Dij. More...
 
virtual scalar Dmax () const =0
 Max diameter. More...
 
virtual const tmp< volScalarFieldvDotSweep () const =0
 Volume swept rate of parcels per cell. More...
 
virtual const tmp< volScalarFieldtheta () const =0
 Return the particle volume fraction field. More...
 
virtual const tmp< volScalarFieldalpha () const =0
 Return the particle mass fraction field. More...
 
virtual const tmp< volScalarFieldrhoEff () const =0
 Return the particle effective density field. 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...
 
- Protected Member Functions inherited from HashTable< regIOobject * >
bool iterator_erase (node_type *&entry, label &index)
 Low-level entry erasure using iterator internals. More...
 

Protected Attributes

const fvMeshmesh_
 References to the mesh and time databases. More...
 
IOdictionary particleProperties_
 Dictionary of particle properties. More...
 
IOdictionary outputProperties_
 Dictionary of output properties. More...
 
cloudSolution solution_
 Solution properties. More...
 
parcelType::constantProperties constProps_
 Parcel constant properties. More...
 
const dictionary subModelProperties_
 Sub-models dictionary. More...
 
Random rndGen_
 Random number generator - used by some injection routines. More...
 
autoPtr< List< DynamicList< parcelType * > > > cellOccupancyPtr_
 Cell occupancy information for each parcel, (demand driven) More...
 
scalarField cellLengthScale_
 Cell length scale. More...
 
const volScalarFieldrho_
 Density [kg/m3]. More...
 
const volVectorFieldU_
 Velocity [m/s]. More...
 
const volScalarFieldmu_
 Dynamic viscosity [Pa.s]. More...
 
const dimensionedVectorg_
 Gravity. More...
 
scalar pAmbient_
 Averaged ambient domain pressure. More...
 
forceType forces_
 Optional particle forces. More...
 
functionType functions_
 Optional cloud function objects. More...
 
InjectionModelList< KinematicCloud< CloudType > > injectors_
 Injector models. More...
 
autoPtr< DispersionModel< KinematicCloud< CloudType > > > dispersionModel_
 Dispersion model. More...
 
autoPtr< PatchInteractionModel< KinematicCloud< CloudType > > > patchInteractionModel_
 Patch interaction model. More...
 
autoPtr< StochasticCollisionModel< KinematicCloud< CloudType > > > stochasticCollisionModel_
 Stochastic collision model. More...
 
autoPtr< SurfaceFilmModel< KinematicCloud< CloudType > > > surfaceFilmModel_
 Surface film model. More...
 
autoPtr< PackingModel< KinematicCloud< CloudType > > > packingModel_
 Packing model. More...
 
autoPtr< DampingModel< KinematicCloud< CloudType > > > dampingModel_
 Damping model. More...
 
autoPtr< IsotropyModel< KinematicCloud< CloudType > > > isotropyModel_
 Exchange model. More...
 
autoPtr< integrationSchemeUIntegrator_
 Velocity integration. More...
 
autoPtr< volVectorField::InternalUTrans_
 Momentum. More...
 
autoPtr< volScalarField::InternalUCoeff_
 Coefficient for carrier phase U equation. More...
 
- Protected Attributes inherited from Cloud< ParcelType >
cloud::geometryType geometryType_
 Geometry type. 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 IOobject selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
 Return the IOobject, but also consider an alternative file name. More...
 
static OstreamwriteBanner (Ostream &os, const bool noSyntaxHint=false)
 Write the standard OpenFOAM file/dictionary banner. More...
 
static OstreamwriteDivider (Ostream &os)
 Write the standard file section divider. More...
 
static OstreamwriteEndDivider (Ostream &os)
 Write the standard end file divider. 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< geometryTypegeometryTypeNames
 
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< fileCheckTypesfileCheckTypesNames
 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)
 
static void writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

template<class CloudType>
class Foam::KinematicCloud< CloudType >

Templated base class for kinematic cloud.

  • cloud function objects
  • particle forces, e.g.
    • buoyancy
    • drag
    • pressure gradient
    • ...
  • sub-models:
    • dispersion model
    • injection model
    • patch interaction model
    • stochastic collision model
    • surface film model
Source files

Definition at line 112 of file KinematicCloud.H.

Member Typedef Documentation

◆ cloudType

Type of cloud this cloud was instantiated for.

Definition at line 122 of file KinematicCloud.H.

◆ parcelType

Type of parcel the cloud was instantiated for.

Definition at line 125 of file KinematicCloud.H.

◆ kinematicCloudType

Convenience typedef for this cloud type.

Definition at line 128 of file KinematicCloud.H.

◆ forceType

Force models type.

Definition at line 131 of file KinematicCloud.H.

◆ functionType

Function object type.

Definition at line 135 of file KinematicCloud.H.

Constructor & Destructor Documentation

◆ KinematicCloud() [1/3]

KinematicCloud ( const word cloudName,
const volScalarField rho,
const volVectorField U,
const volScalarField mu,
const dimensionedVector g,
bool  readFields = true 
)

Construct given carrier gas fields.

Definition at line 340 of file KinematicCloud.C.

References cloudSolution::active(), Foam::cbrt(), Cloud< ParcelType >::deleteLostParticles(), Foam::dimMass, Foam::dimVelocity, Foam::mag(), Foam::name(), Foam::readFields(), cloudSolution::resetSourcesOnStartup(), KinematicCloud< CloudType >::resetSourceTerms(), KinematicCloud< CloudType >::setModels(), and KinematicCloud< CloudType >::solution_.

Here is the call graph for this function:

◆ KinematicCloud() [2/3]

KinematicCloud ( KinematicCloud< CloudType > &  c,
const word name 
)

Copy constructor with new name.

Definition at line 481 of file KinematicCloud.C.

◆ KinematicCloud() [3/3]

KinematicCloud ( const fvMesh mesh,
const word name,
const KinematicCloud< CloudType > &  c 
)

Copy constructor with new name - creates bare cloud.

Definition at line 553 of file KinematicCloud.C.

◆ ~KinematicCloud()

virtual ~KinematicCloud ( )
virtualdefault

Destructor.

Member Function Documentation

◆ setModels()

void setModels
protected

Set cloud sub-models.

Definition at line 50 of file KinematicCloud.C.

Referenced by KinematicCloud< CloudType >::KinematicCloud().

Here is the caller graph for this function:

◆ solve()

void solve ( TrackCloudType &  cloud,
typename parcelType::trackingData td 
)
protected

Solve the cloud - calls all evolution functions.

Definition at line 128 of file KinematicCloud.C.

References addProfiling, and IOobject::info().

Here is the call graph for this function:

◆ buildCellOccupancy()

void buildCellOccupancy
protected

Build the cellOccupancy.

Definition at line 173 of file KinematicCloud.C.

References cellOccupancy, and p.

◆ updateCellOccupancy()

void updateCellOccupancy
protected

Update (i.e. build) the cellOccupancy if it has.

already been used

Definition at line 205 of file KinematicCloud.C.

◆ evolveCloud()

void evolveCloud ( TrackCloudType &  cloud,
typename parcelType::trackingData td 
)
protected

Evolve the cloud.

Definition at line 219 of file KinematicCloud.C.

References surfaceFilm.

◆ postEvolve()

void postEvolve ( const typename parcelType::trackingData td)
protected

Post-evolve.

Definition at line 265 of file KinematicCloud.C.

◆ cloudReset()

void cloudReset ( KinematicCloud< CloudType > &  c)
protected

Reset state of cloud.

Definition at line 312 of file KinematicCloud.C.

◆ clone()

virtual autoPtr< Cloud< parcelType > > clone ( const word name)
inlinevirtual

Construct and return clone based on (this) with new name.

Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >.

Definition at line 333 of file KinematicCloud.H.

References IOobject::name().

Here is the call graph for this function:

◆ cloneBare()

virtual autoPtr< Cloud< parcelType > > cloneBare ( const word name) const
inlinevirtual

Construct and return bare clone based on (this) with new name.

Reimplemented in CollidingCloud< KinematicCloud< Cloud< basicKinematicCollidingParcel > > >.

Definition at line 342 of file KinematicCloud.H.

References KinematicCloud< CloudType >::mesh().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::KinematicCloud< CloudType > & cloudCopy
inline

Return a reference to the cloud copy.

Definition at line 35 of file KinematicCloudI.H.

◆ mesh()

const Foam::fvMesh & mesh
inline

Return reference to the mesh.

Definition at line 42 of file KinematicCloudI.H.

Referenced by KinematicCloud< CloudType >::cloneBare().

Here is the caller graph for this function:

◆ particleProperties()

const Foam::IOdictionary & particleProperties
inline

Return particle properties dictionary.

Definition at line 50 of file KinematicCloudI.H.

◆ outputProperties() [1/2]

const Foam::IOdictionary & outputProperties
inline

Return output properties dictionary.

Definition at line 58 of file KinematicCloudI.H.

◆ outputProperties() [2/2]

Foam::IOdictionary & outputProperties
inline

Return non-const access to the output properties dictionary.

Definition at line 65 of file KinematicCloudI.H.

◆ solution() [1/2]

const Foam::cloudSolution & solution
inline

Return const access to the solution properties.

Definition at line 73 of file KinematicCloudI.H.

◆ solution() [2/2]

Return access to the solution properties.

Definition at line 80 of file KinematicCloudI.H.

◆ constProps() [1/2]

Return the constant properties.

Definition at line 88 of file KinematicCloudI.H.

◆ constProps() [2/2]

Return access to the constant properties.

Definition at line 96 of file KinematicCloudI.H.

◆ subModelProperties()

const Foam::dictionary & subModelProperties
inline

Return reference to the sub-models dictionary.

Definition at line 104 of file KinematicCloudI.H.

◆ rndGen()

Foam::Random & rndGen
inline

Return reference to the random object.

Definition at line 410 of file KinematicCloudI.H.

◆ cellOccupancy()

Foam::List< Foam::DynamicList< typename CloudType::particleType * > > & cellOccupancy
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 418 of file KinematicCloudI.H.

◆ cellLengthScale()

const Foam::scalarField & cellLengthScale
inline

Return the cell length scale.

Definition at line 431 of file KinematicCloudI.H.

◆ U()

const Foam::volVectorField & U
inline

Return carrier gas velocity.

Definition at line 118 of file KinematicCloudI.H.

◆ rho()

const Foam::volScalarField & rho
inline

Return carrier gas density.

Definition at line 111 of file KinematicCloudI.H.

◆ mu()

const Foam::volScalarField & mu
inline

Return carrier gas dynamic viscosity.

Definition at line 125 of file KinematicCloudI.H.

◆ g()

const Foam::dimensionedVector & g
inline

Gravity.

Definition at line 132 of file KinematicCloudI.H.

◆ pAmbient() [1/2]

Foam::scalar pAmbient
inline

Return const-access to the ambient pressure.

Definition at line 139 of file KinematicCloudI.H.

◆ pAmbient() [2/2]

Foam::scalar & pAmbient
inline

Return reference to the ambient pressure.

Definition at line 146 of file KinematicCloudI.H.

◆ forces() [1/2]

const Foam::KinematicCloud< CloudType >::forceType & forces
inline

Optional particle forces.

Definition at line 155 of file KinematicCloudI.H.

◆ forces() [2/2]

Return the optional particle forces.

Definition at line 163 of file KinematicCloudI.H.

◆ functions()

Optional cloud function objects.

Definition at line 171 of file KinematicCloudI.H.

◆ injectors() [1/2]

Return const access to the injection model.

Definition at line 179 of file KinematicCloudI.H.

◆ injectors() [2/2]

Return reference to the injection model.

Definition at line 187 of file KinematicCloudI.H.

◆ dispersion() [1/2]

const Foam::DispersionModel< Foam::KinematicCloud< CloudType > > & dispersion
inline

Return const-access to the dispersion model.

Definition at line 195 of file KinematicCloudI.H.

◆ dispersion() [2/2]

Return reference to the dispersion model.

Definition at line 203 of file KinematicCloudI.H.

◆ patchInteraction() [1/2]

const Foam::PatchInteractionModel< Foam::KinematicCloud< CloudType > > & patchInteraction
inline

Return const-access to the patch interaction model.

Definition at line 211 of file KinematicCloudI.H.

◆ patchInteraction() [2/2]

Return reference to the patch interaction model.

Definition at line 219 of file KinematicCloudI.H.

◆ stochasticCollision() [1/2]

const Foam::StochasticCollisionModel< Foam::KinematicCloud< CloudType > > & stochasticCollision
inline

Return const-access to the stochastic collision model.

Definition at line 227 of file KinematicCloudI.H.

◆ stochasticCollision() [2/2]

Return reference to the stochastic collision model.

Definition at line 235 of file KinematicCloudI.H.

◆ surfaceFilm() [1/2]

const Foam::SurfaceFilmModel< Foam::KinematicCloud< CloudType > > & surfaceFilm
inline

Return const-access to the surface film model.

Definition at line 243 of file KinematicCloudI.H.

◆ surfaceFilm() [2/2]

Return reference to the surface film model.

Definition at line 251 of file KinematicCloudI.H.

◆ packingModel() [1/2]

const Foam::PackingModel< Foam::KinematicCloud< CloudType > > & packingModel
inline

Return const access to the packing model.

Definition at line 259 of file KinematicCloudI.H.

◆ packingModel() [2/2]

Foam::PackingModel< Foam::KinematicCloud< CloudType > > & packingModel
inline

Return a reference to the packing model.

Definition at line 267 of file KinematicCloudI.H.

◆ dampingModel() [1/2]

const Foam::DampingModel< Foam::KinematicCloud< CloudType > > & dampingModel
inline

Return const access to the damping model.

Definition at line 275 of file KinematicCloudI.H.

◆ dampingModel() [2/2]

Foam::DampingModel< Foam::KinematicCloud< CloudType > > & dampingModel
inline

Return a reference to the damping model.

Definition at line 283 of file KinematicCloudI.H.

◆ isotropyModel() [1/2]

const Foam::IsotropyModel< Foam::KinematicCloud< CloudType > > & isotropyModel
inline

Return const access to the isotropy model.

Definition at line 291 of file KinematicCloudI.H.

◆ isotropyModel() [2/2]

Foam::IsotropyModel< Foam::KinematicCloud< CloudType > > & isotropyModel
inline

Return a reference to the isotropy model.

Definition at line 299 of file KinematicCloudI.H.

◆ UIntegrator()

const Foam::integrationScheme & UIntegrator
inline

Return reference to velocity integration.

Definition at line 307 of file KinematicCloudI.H.

◆ UTrans() [1/2]

Return reference to momentum source.

Definition at line 439 of file KinematicCloudI.H.

Referenced by KinematicCloud< CloudType >::relaxSources().

Here is the caller graph for this function:

◆ UTrans() [2/2]

Return const reference to momentum source.

Definition at line 447 of file KinematicCloudI.H.

◆ UCoeff() [1/2]

Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff
inline

Return coefficient for carrier phase U equation.

Definition at line 455 of file KinematicCloudI.H.

Referenced by KinematicCloud< CloudType >::relaxSources().

Here is the caller graph for this function:

◆ UCoeff() [2/2]

const Foam::DimensionedField< Foam::scalar, Foam::volMesh > & UCoeff
inline

Return const coefficient for carrier phase U equation.

Definition at line 463 of file KinematicCloudI.H.

◆ SU()

Foam::tmp< Foam::fvVectorMatrix > SU ( volVectorField U,
bool  incompressible = false 
) const
inline

Return tmp momentum source term (compressible)

Definition at line 471 of file KinematicCloudI.H.

◆ nParcels()

virtual label nParcels ( ) const
inlinevirtual

Total number of parcels.

Implements kinematicCloud.

Definition at line 547 of file KinematicCloud.H.

References Cloud< ParticleType >::nParcels().

Here is the call graph for this function:

◆ massInSystem()

Foam::scalar massInSystem
inlinevirtual

Total mass in system.

Implements kinematicCloud.

Definition at line 314 of file KinematicCloudI.H.

References p.

◆ linearMomentumOfSystem()

Foam::vector linearMomentumOfSystem
inlinevirtual

Total linear momentum of the system.

Implements kinematicCloud.

Definition at line 328 of file KinematicCloudI.H.

References p.

◆ totalParticlePerParcel()

Foam::scalar totalParticlePerParcel
inline

Average particle per parcel.

Definition at line 343 of file KinematicCloudI.H.

References p.

◆ linearKineticEnergyOfSystem()

Foam::scalar linearKineticEnergyOfSystem
inlinevirtual

Total linear kinetic energy in the system.

Implements kinematicCloud.

Definition at line 358 of file KinematicCloudI.H.

◆ rotationalKineticEnergyOfSystem()

scalar rotationalKineticEnergyOfSystem ( ) const
inline

Total rotational kinetic energy in the system.

◆ Dij()

Foam::scalar Dij ( const label  i,
const label  j 
) const
inlinevirtual

Mean diameter Dij.

Implements kinematicCloud.

Definition at line 372 of file KinematicCloudI.H.

◆ Dmax()

Foam::scalar Dmax
inlinevirtual

Max diameter.

Implements kinematicCloud.

Definition at line 395 of file KinematicCloudI.H.

◆ vDotSweep()

const Foam::tmp< Foam::volScalarField > vDotSweep
inlinevirtual

Volume swept rate of parcels per cell.

Implements kinematicCloud.

Definition at line 519 of file KinematicCloudI.H.

◆ theta()

const Foam::tmp< Foam::volScalarField > theta
inlinevirtual

Return the particle volume fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 557 of file KinematicCloudI.H.

◆ alpha()

const Foam::tmp< Foam::volScalarField > alpha
inlinevirtual

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 595 of file KinematicCloudI.H.

References alpha, Foam::dimless, Foam::name(), p, tmp< T >::ref(), and timeName.

Here is the call graph for this function:

◆ rhoEff()

const Foam::tmp< Foam::volScalarField > rhoEff
inlinevirtual

Return the particle effective density field.

Note: for particles belonging to this cloud only

Implements kinematicCloud.

Definition at line 631 of file KinematicCloudI.H.

References Foam::dimDensity, Foam::name(), p, tmp< T >::ref(), and timeName.

Here is the call graph for this function:

◆ setParcelThermoProperties()

void setParcelThermoProperties ( parcelType parcel,
const scalar  lagrangianDt 
)

Set parcel thermo properties.

Definition at line 621 of file KinematicCloud.C.

Referenced by ThermoCloud< Foam::DSMCCloud >::relaxSources(), ReactingCloud< CloudType >::setParcelThermoProperties(), ReactingMultiphaseCloud< CloudType >::setParcelThermoProperties(), and SprayCloud< CloudType >::setParcelThermoProperties().

Here is the caller graph for this function:

◆ checkParcelProperties()

void checkParcelProperties ( parcelType parcel,
const scalar  lagrangianDt,
const bool  fullyDescribed 
)

Check parcel properties.

Definition at line 636 of file KinematicCloud.C.

Referenced by ReactingCloud< CloudType >::checkParcelProperties(), ReactingHeterogeneousCloud< CloudType >::checkParcelProperties(), ReactingMultiphaseCloud< CloudType >::checkParcelProperties(), and SprayCloud< CloudType >::checkParcelProperties().

Here is the caller graph for this function:

◆ storeState()

void storeState

Store the current cloud state.

Definition at line 662 of file KinematicCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Reset the current cloud to the previously stored state.

Definition at line 675 of file KinematicCloud.C.

◆ resetSourceTerms()

void resetSourceTerms

Reset the cloud source terms.

Definition at line 683 of file KinematicCloud.C.

Referenced by KinematicCloud< CloudType >::KinematicCloud(), ThermoCloud< CloudType >::resetSourceTerms(), ReactingMultiphaseCloud< Foam::DSMCCloud >::setParcelThermoProperties(), and SprayCloud< CloudType >::SprayCloud().

Here is the caller graph for this function:

◆ relax()

void relax ( DimensionedField< Type, volMesh > &  field,
const DimensionedField< Type, volMesh > &  field0,
const word name 
) const

Relax field.

Definition at line 692 of file KinematicCloud.C.

References field(), and Foam::name().

Here is the call graph for this function:

◆ scale()

void scale ( DimensionedField< Type, volMesh > &  field,
const word name 
) const

Scale field.

Definition at line 706 of file KinematicCloud.C.

References field(), and Foam::name().

Here is the call graph for this function:

◆ relaxSources()

void relaxSources ( const KinematicCloud< CloudType > &  cloudOldTime)

Apply relaxation to (steady state) cloud sources.

Definition at line 718 of file KinematicCloud.C.

References relax(), KinematicCloud< CloudType >::UCoeff(), and KinematicCloud< CloudType >::UTrans().

Referenced by ReactingCloud< CloudType >::relaxSources(), and ThermoCloud< CloudType >::relaxSources().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scaleSources()

void scaleSources

Apply scaling to (transient) cloud sources.

Definition at line 729 of file KinematicCloud.C.

Referenced by ThermoCloud< CloudType >::scaleSources().

Here is the caller graph for this function:

◆ preEvolve()

void preEvolve ( const typename parcelType::trackingData td)

Pre-evolve.

Definition at line 737 of file KinematicCloud.C.

References Foam::endl(), Foam::Info, and Foam::name().

Referenced by ThermoCloud< CloudType >::preEvolve().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ evolve()

void evolve

Evolve the cloud.

Definition at line 775 of file KinematicCloud.C.

References solve().

Here is the call graph for this function:

◆ motion()

void motion ( TrackCloudType &  cloud,
typename parcelType::trackingData td 
)

Particle motion.

Definition at line 787 of file KinematicCloud.C.

References engineMesh::move().

Here is the call graph for this function:

◆ patchData()

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 807 of file KinematicCloud.C.

References f(), patchIdentifier::index(), p, and polyPatch::whichFace().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh

Update mesh.

Definition at line 849 of file KinematicCloud.C.

References Foam::cbrt(), and Foam::mag().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const mapPolyMesh mapper)
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 858 of file KinematicCloud.C.

References Cloud< ParticleType >::autoMap().

Here is the call graph for this function:

◆ info()

void info

Print cloud information.

Definition at line 867 of file KinematicCloud.C.

References alpha, alphaMax(), cellOccupancy, cells, Foam::endl(), forAll, Foam::gMax(), Foam::gMin(), Foam::Info, Foam::mag(), mesh, n, Foam::name(), Foam::nl, Foam::reduce(), Foam::returnReduce(), surfaceFilm, and regIOobject::write().

Here is the call graph for this function:

◆ readObjects()

void readObjects ( const objectRegistry obr)
virtual

Read particle fields from objects in the obr registry.

Reimplemented from cloud.

Definition at line 942 of file KinematicCloud.C.

◆ writeObjects()

void writeObjects ( objectRegistry obr) const
virtual

Write particle fields as objects into the obr registry.

Reimplemented from cloud.

Definition at line 949 of file KinematicCloud.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

References to the mesh and time databases.

Definition at line 160 of file KinematicCloud.H.

◆ particleProperties_

IOdictionary particleProperties_
protected

Dictionary of particle properties.

Definition at line 163 of file KinematicCloud.H.

◆ outputProperties_

IOdictionary outputProperties_
protected

Dictionary of output properties.

Definition at line 166 of file KinematicCloud.H.

◆ solution_

cloudSolution solution_
protected

Solution properties.

Definition at line 169 of file KinematicCloud.H.

Referenced by KinematicCloud< CloudType >::KinematicCloud().

◆ constProps_

parcelType::constantProperties constProps_
protected

Parcel constant properties.

Definition at line 172 of file KinematicCloud.H.

◆ subModelProperties_

const dictionary subModelProperties_
protected

Sub-models dictionary.

Definition at line 175 of file KinematicCloud.H.

◆ rndGen_

Random rndGen_
mutableprotected

Random number generator - used by some injection routines.

Definition at line 178 of file KinematicCloud.H.

◆ cellOccupancyPtr_

autoPtr<List<DynamicList<parcelType*> > > cellOccupancyPtr_
protected

Cell occupancy information for each parcel, (demand driven)

Definition at line 181 of file KinematicCloud.H.

◆ cellLengthScale_

scalarField cellLengthScale_
protected

Cell length scale.

Definition at line 184 of file KinematicCloud.H.

◆ rho_

const volScalarField& rho_
protected

Density [kg/m3].

Definition at line 190 of file KinematicCloud.H.

◆ U_

const volVectorField& U_
protected

Velocity [m/s].

Definition at line 193 of file KinematicCloud.H.

◆ mu_

const volScalarField& mu_
protected

Dynamic viscosity [Pa.s].

Definition at line 196 of file KinematicCloud.H.

◆ g_

const dimensionedVector& g_
protected

Gravity.

Definition at line 202 of file KinematicCloud.H.

◆ pAmbient_

scalar pAmbient_
protected

Averaged ambient domain pressure.

Definition at line 205 of file KinematicCloud.H.

◆ forces_

forceType forces_
protected

Optional particle forces.

Definition at line 209 of file KinematicCloud.H.

◆ functions_

functionType functions_
protected

Optional cloud function objects.

Definition at line 212 of file KinematicCloud.H.

◆ injectors_

InjectionModelList<KinematicCloud<CloudType> > injectors_
protected

Injector models.

Definition at line 218 of file KinematicCloud.H.

◆ dispersionModel_

autoPtr<DispersionModel<KinematicCloud<CloudType> > > dispersionModel_
protected

Dispersion model.

Definition at line 222 of file KinematicCloud.H.

◆ patchInteractionModel_

autoPtr<PatchInteractionModel<KinematicCloud<CloudType> > > patchInteractionModel_
protected

Patch interaction model.

Definition at line 226 of file KinematicCloud.H.

◆ stochasticCollisionModel_

autoPtr<StochasticCollisionModel<KinematicCloud<CloudType> > > stochasticCollisionModel_
protected

Stochastic collision model.

Definition at line 230 of file KinematicCloud.H.

◆ surfaceFilmModel_

autoPtr<SurfaceFilmModel<KinematicCloud<CloudType> > > surfaceFilmModel_
protected

Surface film model.

Definition at line 234 of file KinematicCloud.H.

◆ packingModel_

autoPtr<PackingModel<KinematicCloud<CloudType> > > packingModel_
protected

Packing model.

Definition at line 238 of file KinematicCloud.H.

◆ dampingModel_

autoPtr<DampingModel<KinematicCloud<CloudType> > > dampingModel_
protected

Damping model.

Definition at line 242 of file KinematicCloud.H.

◆ isotropyModel_

autoPtr<IsotropyModel<KinematicCloud<CloudType> > > isotropyModel_
protected

Exchange model.

Definition at line 246 of file KinematicCloud.H.

◆ UIntegrator_

autoPtr<integrationScheme> UIntegrator_
protected

Velocity integration.

Definition at line 252 of file KinematicCloud.H.

◆ UTrans_

autoPtr<volVectorField::Internal> UTrans_
protected

Momentum.

Definition at line 258 of file KinematicCloud.H.

◆ UCoeff_

autoPtr<volScalarField::Internal> UCoeff_
protected

Coefficient for carrier phase U equation.

Definition at line 261 of file KinematicCloud.H.


The documentation for this class was generated from the following files: