Templated base class for multiphase reacting cloud. More...

Inheritance diagram for ReactingMultiphaseCloud< CloudType >:

Collaboration diagram for ReactingMultiphaseCloud< CloudType >:

[legend]

Public Types
typedef CloudType	cloudType
	Type of cloud this cloud was instantiated for. More...

typedef CloudType::particleType	parcelType
	Type of parcel the cloud was instantiated for. More...

typedef ReactingMultiphaseCloud< CloudType >	reactingMultiphaseCloudType
	Convenience typedef for this cloud type. More...

Public Types inherited from DSMCCloud< ParcelType >
typedef ParcelType	parcelType
	Type of parcel the cloud was instantiated for. More...

Public Types inherited from Cloud< ParcelType >
typedef ParticleType	particleType

typedef IDLList< ParticleType >::iterator	iterator

typedef IDLList< ParticleType >::const_iterator	const_iterator

Public Member Functions
	ReactingMultiphaseCloud (const word &cloudName, const volScalarField &rho, const volVectorField &U, const dimensionedVector &g, const SLGThermo &thermo, bool readFields=true)
	Construct given carrier gas fields. More...

	ReactingMultiphaseCloud (ReactingMultiphaseCloud< CloudType > &c, const word &name)
	Copy constructor with new name. More...

	ReactingMultiphaseCloud (const fvMesh &mesh, const word &name, const ReactingMultiphaseCloud< CloudType > &c)
	Copy constructor with new name - creates bare cloud. More...

virtual autoPtr< Cloud< parcelType > >	clone (const word &name)
	Construct and return clone based on (this) with new name. More...

virtual autoPtr< Cloud< parcelType > >	cloneBare (const word &name) const
	Construct and return bare clone based on (this) with new name. More...

virtual	~ReactingMultiphaseCloud ()
	Destructor. More...

const ReactingMultiphaseCloud &	cloudCopy () const
	Return a reference to the cloud copy. More...

const parcelType::constantProperties &	constProps () const
	Return the constant properties. More...

parcelType::constantProperties &	constProps ()
	Return access to the constant properties. More...

const DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > &	devolatilisation () const
	Return const access to devolatilisation model. More...

DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > &	devolatilisation ()
	Return reference to devolatilisation model. More...

const SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > &	surfaceReaction () const
	Return const access to reacting surface reaction model. More...

SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > &	surfaceReaction ()
	Return reference to reacting surface reaction model. More...

void	setParcelThermoProperties (parcelType &parcel, const scalar lagrangianDt)
	Set parcel thermo properties. More...

void	checkParcelProperties (parcelType &parcel, const scalar lagrangianDt, const bool fullyDescribed)
	Check parcel properties. More...

void	storeState ()
	Store the current cloud state. More...

void	restoreState ()
	Reset the current cloud to the previously stored state. More...

void	resetSourceTerms ()
	Reset the cloud source terms. More...

void	evolve ()
	Evolve the cloud. More...

virtual void	autoMap (const mapPolyMesh &)
	Remap the cells of particles corresponding to the. More...

void	info ()
	Print cloud information. More...

virtual void	writeFields () const
	Write the field data for the cloud. More...

Public Member Functions inherited from DSMCCloud< ParcelType >
	DSMCCloud (const word &cloudName, const fvMesh &mesh, bool readFields=true)
	Construct given name and mesh, will read Parcels and fields from. More...

	DSMCCloud (const word &cloudName, const fvMesh &mesh, const IOdictionary &dsmcInitialiseDict)
	Construct given name, mesh and initialisation dictionary. More...

virtual	~DSMCCloud ()
	Destructor. More...

const word &	cloudName () const
	Return the cloud type. More...

const fvMesh &	mesh () const
	Return refernce to the mesh. More...

const IOdictionary &	particleProperties () const
	Return particle properties dictionary. More...

const List< word > &	typeIdList () const
	Return the idList. More...

scalar	nParticle () const
	Return the number of real particles represented by one. More...

const List< DynamicList< ParcelType * > > &	cellOccupancy () const
	Return the cell occupancy addressing. More...

volScalarField &	sigmaTcRMax ()
	Return the sigmaTcRMax field. non-const access to allow. More...

scalarField &	collisionSelectionRemainder ()
	Return the collision selection remainder field. non-const. More...

const List< typename ParcelType::constantProperties > &	constProps () const
	Return all of the constant properties. More...

const ParcelType::constantProperties &	constProps (label typeId) const
	Return the constant properties of the given typeId. More...

Random &	rndGen ()
	Return refernce to the random object. More...

volScalarField::GeometricBoundaryField &	qBF ()
	Return non-const heat flux boundary field reference. More...

volVectorField::GeometricBoundaryField &	fDBF ()
	Return non-const force density at boundary field reference. More...

volScalarField::GeometricBoundaryField &	rhoNBF ()
	Return non-const number density boundary field reference. More...

volScalarField::GeometricBoundaryField &	rhoMBF ()
	Return non-const mass density boundary field reference. More...

volScalarField::GeometricBoundaryField &	linearKEBF ()
	Return non-const linear kinetic energy density boundary. More...

volScalarField::GeometricBoundaryField &	internalEBF ()
	Return non-const internal energy density boundary field. More...

volScalarField::GeometricBoundaryField &	iDofBF ()
	Return non-const internal degree of freedom density boundary. More...

volVectorField::GeometricBoundaryField &	momentumBF ()
	Return non-const momentum density boundary field reference. More...

const volScalarField &	boundaryT () const
	Return macroscopic temperature. More...

const volVectorField &	boundaryU () const
	Return macroscopic velocity. More...

const volScalarField &	q () const
	Return heat flux at surface field. More...

const volVectorField &	fD () const
	Return force density at surface field. More...

const volScalarField &	rhoN () const
	Return the real particle number density field. More...

const volScalarField &	rhoM () const
	Return the particle mass density field. More...

const volScalarField &	dsmcRhoN () const
	Return the field of number of DSMC particles. More...

const volScalarField &	linearKE () const
	Return the total linear kinetic energy (translational and. More...

const volScalarField &	internalE () const
	Return the internal energy density field. More...

const volScalarField &	iDof () const
	Return the average internal degrees of freedom field. More...

const volVectorField &	momentum () const
	Return the momentum density field. More...

vector	equipartitionLinearVelocity (scalar temperature, scalar mass)
	Generate a random velocity sampled from the Maxwellian speed. More...

scalar	equipartitionInternalEnergy (scalar temperature, direction internalDegreesOfFreedom)
	Generate a random internal energy, sampled from the. More...

scalar	maxwellianAverageSpeed (scalar temperature, scalar mass) const
	Average particle speed. More...

scalarField	maxwellianAverageSpeed (scalarField temperature, scalar mass) const

scalar	maxwellianRMSSpeed (scalar temperature, scalar mass) const
	RMS particle speed. More...

scalarField	maxwellianRMSSpeed (scalarField temperature, scalar mass) const

scalar	maxwellianMostProbableSpeed (scalar temperature, scalar mass) const
	Most probable speed. More...

scalarField	maxwellianMostProbableSpeed (scalarField temperature, scalar mass) const

const BinaryCollisionModel< DSMCCloud< ParcelType > > &	binaryCollision () const
	Return reference to binary elastic collision model. More...

BinaryCollisionModel< DSMCCloud< ParcelType > > &	binaryCollision ()
	Return non-const reference to binary elastic collision model. More...

const WallInteractionModel< DSMCCloud< ParcelType > > &	wallInteraction () const
	Return reference to wall interaction model. More...

WallInteractionModel< DSMCCloud< ParcelType > > &	wallInteraction ()
	Return non-const reference to wall interaction model. More...

const InflowBoundaryModel< DSMCCloud< ParcelType > > &	inflowBoundary () const
	Return reference to wall interaction model. More...

InflowBoundaryModel< DSMCCloud< ParcelType > > &	inflowBoundary ()
	Return non-const reference to wall interaction model. More...

scalar	massInSystem () const
	Total mass in system. More...

vector	linearMomentumOfSystem () const
	Total linear momentum of the system. More...

scalar	linearKineticEnergyOfSystem () const
	Total linear kinetic energy in the system. More...

scalar	internalEnergyOfSystem () const
	Total internal energy in the system. More...

void	info () const
	Print cloud information. More...

void	dumpParticlePositions () const
	Dump particle positions to .obj file. More...

void	addNewParcel (const vector &position, const vector &U, const scalar Ei, const label cellI, const label tetFaceI, const label tetPtI, const label typeId)
	Add new parcel. More...

void	evolve ()
	Evolve the cloud (move, collide) More...

void	clear ()
	Clear the Cloud. More...

Public Member Functions inherited from Cloud< ParcelType >
	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...

Public Member Functions inherited from DSMCBaseCloud
	TypeName ("DSMCBaseCloud")
	Runtime type information. More...

	DSMCBaseCloud ()
	Null constructor. More...

virtual	~DSMCBaseCloud ()
	Destructor. More...

Public Member Functions inherited from reactingMultiphaseCloud
	TypeName ("reactingMultiphaseCloud")
	Runtime type information. More...

	reactingMultiphaseCloud ()
	Null constructor. More...

virtual	~reactingMultiphaseCloud ()
	Destructor. More...

Protected Member Functions
void	setModels ()
	Set cloud sub-models. More...

void	cloudReset (ReactingMultiphaseCloud< CloudType > &c)
	Reset state of cloud. More...

Protected Attributes
parcelType::constantProperties	constProps_
	Parcel constant properties. More...

autoPtr< DevolatilisationModel< ReactingMultiphaseCloud< CloudType > > >	devolatilisationModel_
	Devolatilisation model. More...

autoPtr< SurfaceReactionModel< ReactingMultiphaseCloud< CloudType > > >	surfaceReactionModel_
	Surface reaction model. More...

scalar	dMassDevolatilisation_
	Total mass transferred to continuous phase via devolatilisation. More...

scalar	dMassSurfaceReaction_
	Total mass transferred to continuous phase via surface. More...

Private Member Functions
	ReactingMultiphaseCloud (const ReactingMultiphaseCloud &)
	Disallow default bitwise copy construct. More...

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

Private Attributes
autoPtr< ReactingMultiphaseCloud< CloudType > >	cloudCopyPtr_
	Cloud copy pointer. More...

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

Detailed Description

template<class CloudType>
class Foam::ReactingMultiphaseCloud< CloudType >

Templated base class for multiphase reacting cloud.

- Adds to reacting cloud

multiphase composition
devolatilisatsion
surface reactions

Source files

Definition at line 63 of file ReactingMultiphaseCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this cloud was instantiated for.

Definition at line 73 of file ReactingMultiphaseCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 76 of file ReactingMultiphaseCloud.H.

◆ reactingMultiphaseCloudType

typedef ReactingMultiphaseCloud<CloudType> reactingMultiphaseCloudType

Convenience typedef for this cloud type.

Definition at line 79 of file ReactingMultiphaseCloud.H.

Constructor & Destructor Documentation

◆ ReactingMultiphaseCloud() [1/4]

ReactingMultiphaseCloud ( const ReactingMultiphaseCloud< CloudType > & )

private

Disallow default bitwise copy construct.

Referenced by ReactingMultiphaseCloud< CloudType >::clone(), and ReactingMultiphaseCloud< CloudType >::cloneBare().

Here is the caller graph for this function:

◆ ReactingMultiphaseCloud() [2/4]

ReactingMultiphaseCloud	(	const word &	cloudName,
		const volScalarField &	rho,
		const volVectorField &	U,
		const dimensionedVector &	g,
		const SLGThermo &	thermo,
		bool	readFields = `true`
	)

Construct given carrier gas fields.

Definition at line 76 of file ReactingMultiphaseCloud.C.

References composition, and readFields().

Here is the call graph for this function:

◆ ReactingMultiphaseCloud() [3/4]

ReactingMultiphaseCloud	(	ReactingMultiphaseCloud< CloudType > &	c,
		const word &	name
	)

Copy constructor with new name.

Definition at line 113 of file ReactingMultiphaseCloud.C.

◆ ReactingMultiphaseCloud() [4/4]

ReactingMultiphaseCloud	(	const fvMesh &	mesh,
		const word &	name,
		const ReactingMultiphaseCloud< CloudType > &	c
	)

Copy constructor with new name - creates bare cloud.

Definition at line 131 of file ReactingMultiphaseCloud.C.

◆ ~ReactingMultiphaseCloud()

~ReactingMultiphaseCloud

virtual

Destructor.

Definition at line 151 of file ReactingMultiphaseCloud.C.

Member Function Documentation

◆ operator=()

void operator= ( const ReactingMultiphaseCloud< CloudType > & )

private

Disallow default bitwise assignment.

◆ setModels()

void setModels

protected

Set cloud sub-models.

Definition at line 34 of file ReactingMultiphaseCloud.C.

References Foam::compressible::New().

Here is the call graph for this function:

◆ cloudReset()

void cloudReset ( ReactingMultiphaseCloud< CloudType > & c )

protected

Reset state of cloud.

Definition at line 58 of file ReactingMultiphaseCloud.C.

References Foam::constant::universal::c.

◆ clone()

virtual autoPtr<Cloud<parcelType> > clone ( const word & name )

inlinevirtual

Construct and return clone based on (this) with new name.

Definition at line 180 of file ReactingMultiphaseCloud.H.

References Foam::name(), and ReactingMultiphaseCloud< CloudType >::ReactingMultiphaseCloud().

Here is the call graph for this function:

◆ cloneBare()

virtual autoPtr<Cloud<parcelType> > cloneBare ( const word & name ) const

inlinevirtual

Construct and return bare clone based on (this) with new name.

Definition at line 189 of file ReactingMultiphaseCloud.H.

References DSMCCloud< ParcelType >::mesh(), and ReactingMultiphaseCloud< CloudType >::ReactingMultiphaseCloud().

Here is the call graph for this function:

◆ cloudCopy()

const Foam::ReactingMultiphaseCloud< CloudType > & cloudCopy

inline

Return a reference to the cloud copy.

Definition at line 30 of file ReactingMultiphaseCloudI.H.

◆ constProps() [1/2]

CloudType::particleType::constantProperties & constProps

inline

Return the constant properties.

Definition at line 38 of file ReactingMultiphaseCloudI.H.

◆ constProps() [2/2]

parcelType::constantProperties& constProps ( )

inline

Return access to the constant properties.

◆ devolatilisation() [1/2]

const DevolatilisationModel< ReactingMultiphaseCloud<CloudType> >& devolatilisation ( ) const

inline

Return const access to devolatilisation model.

◆ devolatilisation() [2/2]

DevolatilisationModel< ReactingMultiphaseCloud<CloudType> >& devolatilisation ( )

inline

Return reference to devolatilisation model.

◆ surfaceReaction() [1/2]

const SurfaceReactionModel< ReactingMultiphaseCloud<CloudType> >& surfaceReaction ( ) const

inline

Return const access to reacting surface reaction model.

◆ surfaceReaction() [2/2]

SurfaceReactionModel< ReactingMultiphaseCloud<CloudType> >& surfaceReaction ( )

inline

Return reference to reacting surface reaction model.

◆ setParcelThermoProperties()

void setParcelThermoProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt
	)

Set parcel thermo properties.

Definition at line 159 of file ReactingMultiphaseCloud.C.

References composition.

◆ checkParcelProperties()

void checkParcelProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt,
		const bool	fullyDescribed
	)

Check parcel properties.

Definition at line 178 of file ReactingMultiphaseCloud.C.

References composition.

◆ storeState()

void storeState

Store the current cloud state.

Definition at line 215 of file ReactingMultiphaseCloud.C.

References Foam::name().

Here is the call graph for this function:

◆ restoreState()

void restoreState

Reset the current cloud to the previously stored state.

Definition at line 228 of file ReactingMultiphaseCloud.C.

◆ resetSourceTerms()

void resetSourceTerms

Reset the cloud source terms.

Definition at line 236 of file ReactingMultiphaseCloud.C.

◆ evolve()

void evolve

Evolve the cloud.

Definition at line 243 of file ReactingMultiphaseCloud.C.

References solve().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const mapPolyMesh & mapper )

virtual

Remap the cells of particles corresponding to the.

mesh topology change with a default tracking data object

Reimplemented from DSMCCloud< ParcelType >.

Definition at line 257 of file ReactingMultiphaseCloud.C.

◆ info()

void info

Print cloud information.

Definition at line 273 of file ReactingMultiphaseCloud.C.

References Foam::Info.

◆ writeFields()

void writeFields

virtual

Write the field data for the cloud.

Definition at line 283 of file ReactingMultiphaseCloud.C.

References composition.

Field Documentation

◆ cloudCopyPtr_

autoPtr<ReactingMultiphaseCloud<CloudType> > cloudCopyPtr_

private

Cloud copy pointer.

Definition at line 87 of file ReactingMultiphaseCloud.H.

◆ constProps_

parcelType::constantProperties constProps_

protected

Parcel constant properties.

Definition at line 104 of file ReactingMultiphaseCloud.H.

◆ devolatilisationModel_

autoPtr< DevolatilisationModel<ReactingMultiphaseCloud<CloudType> > > devolatilisationModel_

protected

Devolatilisation model.

Definition at line 114 of file ReactingMultiphaseCloud.H.

◆ surfaceReactionModel_

autoPtr< SurfaceReactionModel<ReactingMultiphaseCloud<CloudType> > > surfaceReactionModel_

protected

Surface reaction model.

Definition at line 121 of file ReactingMultiphaseCloud.H.

◆ dMassDevolatilisation_

scalar dMassDevolatilisation_

protected

Total mass transferred to continuous phase via devolatilisation.

Definition at line 127 of file ReactingMultiphaseCloud.H.

◆ dMassSurfaceReaction_

scalar dMassSurfaceReaction_

protected

Total mass transferred to continuous phase via surface.

reactions

Definition at line 131 of file ReactingMultiphaseCloud.H.

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

src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.H
src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloud.C
src/lagrangian/intermediate/clouds/Templates/ReactingMultiphaseCloud/ReactingMultiphaseCloudI.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class CloudType> class Foam::ReactingMultiphaseCloud< CloudType >

Member Typedef Documentation

◆ cloudType

◆ parcelType

◆ reactingMultiphaseCloudType

Constructor & Destructor Documentation

◆ ReactingMultiphaseCloud() [1/4]

◆ ReactingMultiphaseCloud() [2/4]

◆ ReactingMultiphaseCloud() [3/4]

◆ ReactingMultiphaseCloud() [4/4]

◆ ~ReactingMultiphaseCloud()

Member Function Documentation

◆ operator=()

◆ setModels()

◆ cloudReset()

◆ clone()

◆ cloneBare()

◆ cloudCopy()

◆ constProps() [1/2]

◆ constProps() [2/2]

◆ devolatilisation() [1/2]

◆ devolatilisation() [2/2]

◆ surfaceReaction() [1/2]

◆ surfaceReaction() [2/2]

◆ setParcelThermoProperties()

◆ checkParcelProperties()

◆ storeState()

◆ restoreState()

◆ resetSourceTerms()

◆ evolve()

◆ autoMap()

◆ info()

◆ writeFields()

Field Documentation

◆ cloudCopyPtr_

◆ constProps_

◆ devolatilisationModel_

◆ surfaceReactionModel_

◆ dMassDevolatilisation_

◆ dMassSurfaceReaction_

template<class CloudType>
class Foam::ReactingMultiphaseCloud< CloudType >