Public Member Functions | List of all members
solidParticleCloud Class Reference

A Cloud of solid particles. More...

Inheritance diagram for solidParticleCloud:
[legend]
Collaboration diagram for solidParticleCloud:
[legend]

Public Member Functions

 solidParticleCloud (const fvMesh &mesh, const word &cloudName=cloud::defaultName, bool readFields=true)
 Construct given mesh. More...
 
const fvMesh & mesh () const
 
scalar rhop () const
 
scalar e () const
 
scalar mu () const
 
void move (const dimensionedVector &g)
 Move the particles under the influence of the given. More...
 
- Public Member Functions inherited from Cloud< ParticleType >
 TypeName ("Cloud")
 Runtime type information. More...
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &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 polyMesh & pMesh () 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 (ParticleType *pPtr)
 Transfer particle to cloud. More...
 
void deleteParticle (ParticleType &p)
 Remove particle from cloud and delete. More...
 
void deleteLostParticles ()
 Remove lost particles from cloud and delete. More...
 
void cloudReset (const Cloud< ParticleType > &c)
 Reset the particles. More...
 
template<class TrackCloudType >
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...
 
template<class DataType >
void checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const
 Check lagrangian data field. More...
 
template<class DataType >
void checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const
 Check lagrangian data fieldfield. More...
 
template<class Type >
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
 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...
 

Additional Inherited Members

- Public Types inherited from Cloud< ParticleType >
typedef ParticleType particleType
 
typedef ParticleType parcelType
 Parcels are just particles. More...
 
- Static Public Attributes inherited from Cloud< ParticleType >
static word cloudPropertiesName
 Name of cloud properties dictionary. More...
 
- Protected Attributes inherited from Cloud< ParticleType >
cloud::geometryType geometryType_
 Geometry type. More...
 

Detailed Description

A Cloud of solid particles.

Source files

Definition at line 58 of file solidParticleCloud.H.

Constructor & Destructor Documentation

◆ solidParticleCloud()

solidParticleCloud ( const fvMesh &  mesh,
const word &  cloudName = cloud::defaultName,
bool  readFields = true 
)
explicit

Construct given mesh.

Definition at line 36 of file solidParticleCloud.C.

References Foam::readFields().

Here is the call graph for this function:

Member Function Documentation

◆ mesh()

const Foam::fvMesh & mesh ( ) const
inline

Definition at line 30 of file solidParticleCloudI.H.

◆ rhop()

Foam::scalar rhop ( ) const
inline

Definition at line 36 of file solidParticleCloudI.H.

◆ e()

Foam::scalar e ( ) const
inline

Definition at line 42 of file solidParticleCloudI.H.

◆ mu()

Foam::scalar mu ( ) const
inline

Definition at line 48 of file solidParticleCloudI.H.

◆ move()

void move ( const dimensionedVector &  g)

Move the particles under the influence of the given.

gravitational acceleration

Definition at line 68 of file solidParticleCloud.C.

References TimeState::deltaTValue(), g, objectRegistry::lookupObject(), Cloud< ParticleType >::move(), nu, rho, fvMesh::time(), and U.

Here is the call graph for this function:
The documentation for this class was generated from the following files: