Base cloud calls templated on particle type. More...

Inheritance diagram for Cloud< ParticleType >:

Collaboration diagram for Cloud< ParticleType >:

Public Types
typedef ParticleType	particleType

typedef ParticleType	parcelType
	Parcels are just particles. More...

Public Member Functions
	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...

Static Public Attributes
static word	cloudPropertiesName
	Name of cloud properties dictionary. More...

Protected Attributes
cloud::geometryType	geometryType_
	Geometry type. More...

Friends
class	particle

template<class ParticleT >
class	IOPosition

Detailed Description

template<class ParticleType>
class Foam::Cloud< ParticleType >

Base cloud calls templated on particle type.

Source files

Definition at line 55 of file Cloud.H.

Member Typedef Documentation

◆ particleType

typedef ParticleType particleType

Definition at line 114 of file Cloud.H.

◆ parcelType

typedef ParticleType parcelType

Parcels are just particles.

Definition at line 117 of file Cloud.H.

Constructor & Destructor Documentation

◆ Cloud() [1/2]

Cloud	(	const polyMesh &	mesh,
		const word &	cloudName,
		const IDLList< ParticleType > &	particles
	)

Construct from mesh and a list of particles.

Definition at line 73 of file Cloud.C.

◆ Cloud() [2/2]

Cloud	(	const polyMesh &	pMesh,
		const word &	cloudName,
		const bool	checkClass = `true`
	)

Construct from mesh by reading from file with given cloud instance.

Optionally disable checking of class name for post-processing

Definition at line 167 of file CloudIO.C.

Member Function Documentation

◆ TypeName()

TypeName ( "Cloud< ParticleType >" )

Runtime type information.

◆ pMesh()

const polyMesh& pMesh ( ) const

inline

Return the polyMesh reference.

Definition at line 155 of file Cloud.H.

◆ nParcels()

virtual label nParcels ( ) const

inlinevirtual

Return the number of particles in the cloud.

Reimplemented in KinematicCloud< CloudType >, and KinematicCloud< Cloud< basicKinematicCollidingParcel > >.

Definition at line 164 of file Cloud.H.

Referenced by KinematicCloud< Cloud< basicKinematicCollidingParcel > >::nParcels().

Here is the caller graph for this function:

◆ labels()

DynamicList<label>& labels ( ) const

inline

Return temporary addressing.

Definition at line 170 of file Cloud.H.

◆ addParticle()

void addParticle ( ParticleType * pPtr )

Transfer particle to cloud.

Definition at line 104 of file Cloud.C.

Referenced by streamLine::track(), and wallBoundedStreamLine::track().

Here is the caller graph for this function:

◆ deleteParticle()

void deleteParticle ( ParticleType & p )

Remove particle from cloud and delete.

Definition at line 111 of file Cloud.C.

Referenced by InflationInjection< CloudType >::parcelsToInject().

Here is the caller graph for this function:

◆ deleteLostParticles()

void deleteLostParticles ( )

Remove lost particles from cloud and delete.

Definition at line 118 of file Cloud.C.

◆ cloudReset()

void cloudReset ( const Cloud< ParticleType > & c )

Reset the particles.

Definition at line 135 of file Cloud.C.

◆ move()

void move	(	TrackCloudType &	cloud,
		typename ParticleType::trackingData &	td,
		const scalar	trackTime
	)

Move the particles.

Definition at line 147 of file Cloud.C.

Referenced by moleculeCloud::evolve(), DSMCCloud< ParcelType >::evolve(), solidParticleCloud::move(), streamLine::track(), and wallBoundedStreamLine::track().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const mapPolyMesh & mapper )

Remap the cells of particles corresponding to the.

mesh topology change

Definition at line 345 of file Cloud.C.

Referenced by DSMCCloud< ParcelType >::autoMap().

Here is the caller graph for this function:

◆ fieldIOobject()

Foam::IOobject fieldIOobject	(	const word &	fieldName,
		const IOobject::readOption	r
	)		const

Helper to construct IOobject for field and current time.

Definition at line 192 of file CloudIO.C.

Referenced by molecule::readFields(), and molecule::writeFields().

Here is the caller graph for this function:

◆ checkFieldIOobject()

void checkFieldIOobject	(	const Cloud< ParticleType > &	c,
		const IOField< DataType > &	data
	)		const

Check lagrangian data field.

Definition at line 212 of file CloudIO.C.

Referenced by molecule::readFields().

Here is the caller graph for this function:

◆ checkFieldFieldIOobject()

void checkFieldFieldIOobject	(	const Cloud< ParticleType > &	c,
		const CompactIOField< Field< DataType >, DataType > &	data
	)		const

Check lagrangian data fieldfield.

Definition at line 231 of file CloudIO.C.

◆ readStoreFile()

bool readStoreFile	(	const IOobject &	io,
		const IOobject &	ioNew
	)		const

Helper function to store a cloud field on its registry.

Definition at line 250 of file CloudIO.C.

◆ readFromFiles()

void readFromFiles	(	objectRegistry &	obr,
		const wordRes &	selectFields
	)		const

Read from files into objectRegistry.

Definition at line 268 of file CloudIO.C.

◆ writeFields()

void writeFields ( ) const

virtual

Write the field data for the cloud of particles Dummy at.

this level.

Reimplemented in ReactingCloud< CloudType >, ReactingCloud< Foam::DSMCCloud >, ReactingMultiphaseCloud< CloudType >, ReactingMultiphaseCloud< Foam::DSMCCloud >, ReactingHeterogeneousCloud< CloudType >, and ReactingHeterogeneousCloud< Foam::DSMCCloud >.

Definition at line 322 of file CloudIO.C.

◆ writeObject()

bool writeObject	(	IOstreamOption	streamOpt,
		const bool	valid
	)		const

virtual

Write using stream options.

Only writes the cloud file if the Cloud isn't empty

Reimplemented in unmappedPassivePositionParticleCloud.

Definition at line 330 of file CloudIO.C.

◆ writePositions()

void writePositions ( ) const

Write positions to <cloudName>_positions.obj file.

Definition at line 377 of file Cloud.C.

◆ storeGlobalPositions()

void storeGlobalPositions ( ) const

Call this before a topology change.

Stores the particles global positions in the database for use during mapping.

Definition at line 397 of file Cloud.C.

Friends And Related Function Documentation

◆ particle

friend class particle

friend

Definition at line 110 of file Cloud.H.

◆ IOPosition

friend class IOPosition

friend

Definition at line 112 of file Cloud.H.

Member Data Documentation

◆ geometryType_

cloud::geometryType geometryType_

protected

Geometry type.

Definition at line 105 of file Cloud.H.

◆ cloudPropertiesName

Foam::word cloudPropertiesName

static

Name of cloud properties dictionary.

Definition at line 127 of file Cloud.H.

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

src/lagrangian/basic/Cloud/Cloud.H
src/lagrangian/basic/Cloud/Cloud.C
src/lagrangian/basic/Cloud/CloudIO.C

Public Types

Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

template<class ParticleType> class Foam::Cloud< ParticleType >

Member Typedef Documentation

◆ particleType

◆ parcelType

Constructor & Destructor Documentation

◆ Cloud() [1/2]

◆ Cloud() [2/2]

Member Function Documentation

◆ TypeName()

◆ pMesh()

◆ nParcels()

◆ labels()

◆ addParticle()

◆ deleteParticle()

◆ deleteLostParticles()

◆ cloudReset()

◆ move()

◆ autoMap()

◆ fieldIOobject()

◆ checkFieldIOobject()

◆ checkFieldFieldIOobject()

◆ readStoreFile()

◆ readFromFiles()

◆ writeFields()

◆ writeObject()

◆ writePositions()

◆ storeGlobalPositions()

Friends And Related Function Documentation

◆ particle

◆ IOPosition

Member Data Documentation

◆ geometryType_

◆ cloudPropertiesName

template<class ParticleType>
class Foam::Cloud< ParticleType >