A Cloud of streamLine particles. More...

Inheritance diagram for streamLineParticleCloud:

Collaboration diagram for streamLineParticleCloud:

Public Types
typedef streamLineParticle	parcelType
	Type of parcel the cloud was instantiated for. More...

Public Types inherited from Cloud< streamLineParticle >
typedef ParticleType	particleType

typedef IDLList< ParticleType >::iterator	iterator

typedef IDLList< ParticleType >::const_iterator	const_iterator

Public Member Functions
	streamLineParticleCloud (const polyMesh &, const word &cloudName="defaultCloud", bool readFields=true)
	Construct given mesh. More...

	streamLineParticleCloud (const polyMesh &mesh, const word &cloudName, const IDLList< streamLineParticle > &particles)
	Construct from mesh, cloud name, and a list of particles. More...

Public Member Functions inherited from Cloud< streamLineParticle >
	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
	streamLineParticleCloud (const streamLineParticleCloud &)
	Disallow default bitwise copy construct. More...

void	operator= (const streamLineParticleCloud &)
	Disallow default bitwise assignment. More...

Additional Inherited Members
Static Public Attributes inherited from Cloud< streamLineParticle >
static word	cloudPropertiesName
	Name of cloud properties dictionary. More...

Detailed Description

A Cloud of streamLine particles.

Source files

Definition at line 49 of file streamLineParticleCloud.H.

Member Typedef Documentation

◆ parcelType

typedef streamLineParticle parcelType

Type of parcel the cloud was instantiated for.

Definition at line 65 of file streamLineParticleCloud.H.

Constructor & Destructor Documentation

◆ streamLineParticleCloud() [1/3]

streamLineParticleCloud ( const streamLineParticleCloud & )

private

Disallow default bitwise copy construct.

◆ streamLineParticleCloud() [2/3]

streamLineParticleCloud	(	const polyMesh &	mesh,
		const word &	cloudName = `"defaultCloud"`,
		bool	readFields = `true`
	)

Construct given mesh.

Definition at line 38 of file streamLineParticleCloud.C.

References readFields().

Here is the call graph for this function:

◆ streamLineParticleCloud() [3/3]

streamLineParticleCloud	(	const polyMesh &	mesh,
		const word &	cloudName,
		const IDLList< streamLineParticle > &	particles
	)

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

Definition at line 54 of file streamLineParticleCloud.C.

Member Function Documentation

◆ operator=()

void operator= ( const streamLineParticleCloud & )

private

Disallow default bitwise assignment.

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

src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.H
src/postProcessing/functionObjects/field/streamLine/streamLineParticleCloud.C

Public Types

Public Member Functions

Private Member Functions

Additional Inherited Members