Cloud< ParticleType > Class Template Reference

Inheritance diagram for Cloud< ParticleType >:

[legend]

Collaboration diagram for Cloud< ParticleType >:

[legend]

List of all members.

Public Types
typedef ParticleType	particleType
typedef IDLList< ParticleType > ::iterator	iterator
typedef IDLList< ParticleType > ::const_iterator	const_iterator
Public Member Functions
	TypeName ("Cloud")
	Runtime type information.
	Cloud (const polyMesh &mesh, const IDLList< ParticleType > &particles)
	Construct from mesh and a list of particles.
	Cloud (const polyMesh &mesh, const word &cloudName, const IDLList< ParticleType > &particles)
	Construct from mesh, cloud name, and a list of particles.
	Cloud (const polyMesh &mesh, const bool checkClass=true)
	Construct from mesh by reading from file.
	Cloud (const polyMesh &pMesh, const word &cloudName, const bool checkClass=true)
	Construct from mesh by reading from file with given cloud instance.
const polyMesh &	pMesh () const
	Return the polyMesh reference.
bool	internalFace (const label facei) const
	Is this global face an internal face?
bool	boundaryFace (const label facei) const
	Is this global face a boundary face?
label	facePatch (const label facei) const
	Which patch is this global face on.
label	patchFace (const label patchi, const label facei) const
	Which face of this patch is this global face.
label	size () const
	Return number of elements in table.
const const_iterator	begin () const
	const_iterator set to the beginning of the HashTable
const const_iterator	cbegin () const
	const_iterator set to the beginning of the HashTable
const const_iterator	end () const
	const_iterator set to beyond the end of the HashTable
const const_iterator	cend () const
	const_iterator set to beyond the end of the HashTable
iterator	begin ()
	iterator set to the begining of the HashTable
iterator	end ()
	iterator set to beyond the end of the HashTable
void	clear ()
	Clear the contents of the list.
label	getNewParticleID () const
	Get unique particle creation id.
void	addParticle (ParticleType *pPtr)
	Transfer particle to cloud.
void	deleteParticle (ParticleType &)
	Remove particle from cloud and delete.
template<class TrackingData >
void	move (TrackingData &td)
	Move the particles.
virtual void	autoMap (const mapPolyMesh &)
	Remap the cells of particles corresponding to the.
IOobject	fieldIOobject (const word &fieldName, const IOobject::readOption r) const
	Helper to construct IOobject for field and current time.
template<class DataType >
void	checkFieldIOobject (const Cloud< ParticleType > &c, const IOField< DataType > &data) const
	Check lagrangian data field.
virtual void	readFields ()
	Read the field data for the cloud of particles. Dummy at.
virtual void	writeFields () const
	Write the field data for the cloud of particles Dummy at.
virtual bool	writeObject (IOstream::streamFormat fmt, IOstream::versionNumber ver, IOstream::compressionType cmp) const
	Write using given format, version and compression.
void	writePositions () const
	Write positions to <cloudName>_positions.obj file.
Friends
class	Particle
class	IOPosition
Ostream &	operator (Ostream &, const Cloud< ParticleType > &)

---

Detailed Description

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

Source files

• Cloud.H
• Cloud.C
• CloudIO.C

Definition at line 63 of file Cloud.H.

---

Member Typedef Documentation

typedef ParticleType particleType

Definition at line 92 of file Cloud.H.

typedef IDLList<ParticleType>::iterator iterator

Reimplemented from HashTable< regIOobject * >.

Definition at line 94 of file Cloud.H.

typedef IDLList<ParticleType>::const_iterator const_iterator

Reimplemented from HashTable< regIOobject * >.

Definition at line 95 of file Cloud.H.

---

Constructor & Destructor Documentation

Cloud	(	const polyMesh &	mesh,
		const IDLList< ParticleType > &	particles
	)			[inline]

Construct from mesh and a list of particles.

Definition at line 30 of file Cloud.C.

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

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

Definition at line 46 of file Cloud.C.

Cloud	(	const polyMesh &	mesh,
		const bool	checkClass = true
	)			[inline]

Construct from mesh by reading from file.

Optionally disable checking of class name for post-processing

Definition at line 54 of file CloudIO.C.

Cloud	(	const polyMesh &	pMesh,
		const word &	cloudName,
		const bool	checkClass = true
	)			[inline]

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

Optionally disable checking of class name for post-processing

Definition at line 69 of file CloudIO.C.

---

Member Function Documentation

TypeName

(

"Cloud< ParticleType >"

)

Runtime type information.

const polyMesh& pMesh

(

)

const [inline]

Return the polyMesh reference.

Definition at line 146 of file Cloud.H.

Referenced by solidParticle::move().

Here is the caller graph for this function:

bool internalFace

(

const label

facei

)

const [inline]

Is this global face an internal face?

Definition at line 152 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::boundaryFace().

Here is the caller graph for this function:

bool boundaryFace

(

const label

facei

)

const [inline]

Is this global face a boundary face?

Definition at line 158 of file Cloud.H.

label facePatch

(

const label

facei

)

const [inline]

Which patch is this global face on.

Definition at line 164 of file Cloud.H.

label patchFace	(	const label	patchi,
		const label	facei
	)			const [inline]

Which face of this patch is this global face.

Definition at line 170 of file Cloud.H.

label size

(

)

const [inline]

Return number of elements in table.

Reimplemented from HashTable< regIOobject * >.

Definition at line 175 of file Cloud.H.

const const_iterator begin

(

)

const [inline]

const_iterator set to the beginning of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 183 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::begin().

Here is the caller graph for this function:

const const_iterator cbegin

(

)

const [inline]

const_iterator set to the beginning of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 188 of file Cloud.H.

const const_iterator end

(

)

const [inline]

const_iterator set to beyond the end of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 193 of file Cloud.H.

const const_iterator cend

(

)

const [inline]

const_iterator set to beyond the end of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 198 of file Cloud.H.

iterator begin

(

)

[inline]

iterator set to the begining of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 203 of file Cloud.H.

iterator end

(

)

[inline]

iterator set to beyond the end of the HashTable

Reimplemented from HashTable< regIOobject * >.

Definition at line 208 of file Cloud.H.

void clear

(

)

[inline]

Clear the contents of the list.

Reimplemented from ILList< DLListBase, ParticleType >.

Reimplemented in DsmcCloud< ParcelType >, and DsmcCloud< dsmcParcel >.

Definition at line 216 of file Cloud.H.

Referenced by Cloud< BasicReactingParcel< ThermoType > >::clear().

Here is the caller graph for this function:

Foam::label getNewParticleID

(

)

const [inline]

Get unique particle creation id.

Definition at line 64 of file Cloud.C.

void addParticle

(

ParticleType *

pPtr

)

[inline]

Transfer particle to cloud.

Definition at line 79 of file Cloud.C.

void deleteParticle

(

ParticleType &

p

)

[inline]

Remove particle from cloud and delete.

Definition at line 86 of file Cloud.C.

References DLListBase::append().

Here is the call graph for this function:

void move

(

TrackingData &

td

)

[inline]

Move the particles.

passing the TrackingData to the track function

Definition at line 117 of file Cloud.C.

void autoMap

(

const mapPolyMesh &

mapper

)

[inline, virtual]

Remap the cells of particles corresponding to the.

mesh topology change

Implements cloud.

Definition at line 279 of file Cloud.C.

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

Helper to construct IOobject for field and current time.

Definition at line 87 of file CloudIO.C.

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

Check lagrangian data field.

Definition at line 107 of file CloudIO.C.

void readFields

(

)

[inline, virtual]

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

this level.

Reimplemented in passiveParticleCloud.

Definition at line 127 of file CloudIO.C.

void writeFields

(

)

const [inline, virtual]

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

this level.

Reimplemented in indexedParticleCloud, passiveParticleCloud, CoalCloud< ThermoType >, spray, dsmcCloud, basicKinematicCloud, BasicReactingCloud< ThermoType >, BasicReactingMultiphaseCloud< ThermoType >, basicThermoCloud, moleculeCloud, and solidParticleCloud.

Definition at line 132 of file CloudIO.C.

bool writeObject	(	IOstream::streamFormat	fmt,
		IOstream::versionNumber	ver,
		IOstream::compressionType	cmp
	)			const [inline, virtual]

Write using given format, version and compression.

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

Reimplemented from objectRegistry.

Definition at line 138 of file CloudIO.C.

void writePositions

(

)

const [inline]

Write positions to <cloudName>_positions.obj file.

Definition at line 325 of file Cloud.C.

---

Friends And Related Function Documentation

friend class Particle [friend]

Definition at line 88 of file Cloud.H.

friend class IOPosition [friend]

Definition at line 90 of file Cloud.H.

Ostream& operator	(	Ostream &	,
		const Cloud< ParticleType > &
	)			[friend]

---

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