solidParticleCloud Class Reference

A Cloud of solid particles. More...

Inheritance diagram for solidParticleCloud:

Collaboration diagram for solidParticleCloud:

Public Member Functions
	solidParticleCloud (const fvMesh &, const word &cloudName="defaultCloud", bool readFields=true)
	Construct given mesh. More...
virtual bool	hasWallImpactDistance () const
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< solidParticle >
	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 polyMesh &	pMesh () 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 PackedBoolList &	cellHasWallFaces () 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
	solidParticleCloud (const solidParticleCloud &)
	Disallow default bitwise copy construct. More...
void	operator= (const solidParticleCloud &)
	Disallow default bitwise assignment. More...

Private Attributes
const fvMesh &	mesh_
IOdictionary	particleProperties_
scalar	rhop_
scalar	e_
scalar	mu_

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

Detailed Description

A Cloud of solid particles.

Source files

• solidParticleCloud.H
• solidParticleCloudI.H
• solidParticleCloud.C
• solidParticleCloudIO.C

Definition at line 55 of file solidParticleCloud.H.

Constructor & Destructor Documentation

solidParticleCloud() [1/2]

solidParticleCloud ( const solidParticleCloud &  )

private

Disallow default bitwise copy construct.

solidParticleCloud() [2/2]

solidParticleCloud	(	const fvMesh &	mesh,
		const word &	cloudName = "defaultCloud",
		bool	readFields = true
	)

Construct given mesh.

Definition at line 34 of file solidParticleCloud.C.

References readFields().

Here is the call graph for this function:

Member Function Documentation

operator=()

void operator= ( const solidParticleCloud &  )

private

Disallow default bitwise assignment.

hasWallImpactDistance()

bool hasWallImpactDistance ( ) const

virtual

Definition at line 66 of file solidParticleCloud.C.

mesh()

const Foam::fvMesh & mesh ( ) const

inline

Definition at line 28 of file solidParticleCloudI.H.

References solidParticleCloud::mesh_.

rhop()

Foam::scalar rhop ( ) const

inline

Definition at line 34 of file solidParticleCloudI.H.

Referenced by solidParticle::move().

Here is the caller graph for this function:

e()

Foam::scalar e ( ) const

inline

Definition at line 40 of file solidParticleCloudI.H.

Referenced by solidParticle::hitWallPatch().

Here is the caller graph for this function:

mu()

Foam::scalar mu ( ) const

inline

Definition at line 46 of file solidParticleCloudI.H.

Referenced by solidParticle::hitWallPatch().

Here is the caller graph for this function:

move()

void move

(

const dimensionedVector &

g

)

Move the particles under the influence of the given.

gravitational acceleration

Definition at line 72 of file solidParticleCloud.C.

References g, Cloud::move(), nu, rho, U, and dimensioned::value().

Here is the call graph for this function:

Field Documentation

mesh_

const fvMesh& mesh_

private

Definition at line 61 of file solidParticleCloud.H.

Referenced by solidParticleCloud::mesh().

particleProperties_

IOdictionary particleProperties_

private

Definition at line 63 of file solidParticleCloud.H.

rhop_

scalar rhop_

private

Definition at line 65 of file solidParticleCloud.H.

e_

scalar e_

private

Definition at line 66 of file solidParticleCloud.H.

mu_

scalar mu_

private

Definition at line 67 of file solidParticleCloud.H.

---

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

• src/lagrangian/solidParticle/solidParticleCloud.H
• src/lagrangian/solidParticle/solidParticleCloud.C
• src/lagrangian/solidParticle/solidParticleCloudI.H