Public Member Functions | Private Member Functions
passiveParticleCloud Class Reference

A Cloud of passive particles. More...

Inheritance diagram for passiveParticleCloud:
Inheritance graph
[legend]
Collaboration diagram for passiveParticleCloud:
Collaboration graph
[legend]

Public Member Functions

 passiveParticleCloud (const polyMesh &, const word &cloudName="defaultCloud", bool readFields=true)
 Construct given mesh. More...
 
 passiveParticleCloud (const polyMesh &mesh, const word &cloudName, const IDLList< passiveParticle > &particles)
 Construct from mesh, cloud name, and a list of particles. More...
 
- Public Member Functions inherited from Cloud< passiveParticle >
 TypeName ("Cloud")
 Runtime type information. More...
 
 Cloud (const polyMesh &mesh, const IDLList< ParticleType > &particles)
 Construct from mesh and a list of particles. More...
 
 Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles)
 Construct from mesh, cloud name, and a list of particles. More...
 
 Cloud (const polyMesh &mesh, const bool checkClass=true)
 Construct from mesh by reading from file. 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...
 
label size () const
 
DynamicList< label > & labels ()
 
label nTrackingRescues () const
 Return nTrackingRescues. More...
 
void trackingRescue () const
 Increment the nTrackingRescues counter. More...
 
const PackedBoolListcellHasWallFaces () const
 Whether each cell has any wall faces (demand driven data) More...
 
virtual bool hasWallImpactDistance () const
 Switch to specify if particles of the cloud can return. More...
 
const const_iterator begin () const
 
iterator begin ()
 
const const_iterator cbegin () const
 
const const_iterator end () const
 
iterator end ()
 
const const_iterator cend () const
 
void clear ()
 
void addParticle (ParticleType *pPtr)
 Transfer particle to cloud. More...
 
void deleteParticle (ParticleType &)
 Remove particle from cloud and delete. More...
 
void cloudReset (const Cloud< ParticleType > &c)
 Reset the particles. More...
 
void move (TrackData &td, const scalar trackTime)
 Move the particles. More...
 
void autoMap (TrackData &td, 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< ParticleType > &c, const IOField< DataType > &data) const
 Check lagrangian data field. More...
 
void checkFieldFieldIOobject (const Cloud< ParticleType > &c, const CompactIOField< Field< DataType >, DataType > &data) const
 Check lagrangian data fieldfield. More...
 
virtual void readFields ()
 Read the field data for the cloud of particles. Dummy at. More...
 
virtual void writeFields () const
 Write the field data for the cloud of particles Dummy at. More...
 
virtual bool writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
 Write using given format, version and compression. More...
 
void writePositions () const
 Write positions to <cloudName>_positions.obj file. More...
 

Private Member Functions

 passiveParticleCloud (const passiveParticleCloud &)
 Disallow default bitwise copy construct. More...
 
void operator= (const passiveParticleCloud &)
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Public Types inherited from Cloud< passiveParticle >
typedef ParticleType particleType
 
typedef IDLList< ParticleType >::iterator iterator
 
typedef IDLList< ParticleType >::const_iterator const_iterator
 
- Static Public Attributes inherited from Cloud< passiveParticle >
static word cloudPropertiesName
 Name of cloud properties dictionary. More...
 

Detailed Description

A Cloud of passive particles.

Source files

Definition at line 49 of file passiveParticleCloud.H.

Constructor & Destructor Documentation

◆ passiveParticleCloud() [1/3]

Disallow default bitwise copy construct.

◆ passiveParticleCloud() [2/3]

passiveParticleCloud ( const polyMesh mesh,
const word cloudName = "defaultCloud",
bool  readFields = true 
)

Construct given mesh.

Definition at line 38 of file passiveParticleCloud.C.

References readFields().

Here is the call graph for this function:

◆ passiveParticleCloud() [3/3]

passiveParticleCloud ( const polyMesh mesh,
const word cloudName,
const IDLList< passiveParticle > &  particles 
)

Construct from mesh, cloud name, and a list of particles.

Definition at line 54 of file passiveParticleCloud.C.

Member Function Documentation

◆ operator=()

void operator= ( const passiveParticleCloud )
private

Disallow default bitwise assignment.


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