Templated base class for spray cloud. More...

Inheritance diagram for SprayCloud< CloudType >:

Collaboration diagram for SprayCloud< CloudType >:

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 SprayCloud< CloudType >	sprayCloudType
	Convenience typedef for this cloud type. More...

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

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

	SprayCloud (const fvMesh &mesh, const word &name, const SprayCloud< 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	~SprayCloud ()
	Destructor. More...

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

scalar	averageParcelMass () const
	Return const-access to the average parcel mass. More...

scalar	penetration (const scalar fraction) const
	Penetration for fraction [0-1] of the current total mass. More...

const AtomizationModel< SprayCloud< CloudType > > &	atomization () const
	Return const-access to the atomization model. More...

AtomizationModel< SprayCloud< CloudType > > &	atomization ()
	Return reference to the atomization model. More...

const BreakupModel< SprayCloud< CloudType > > &	breakup () const
	Return const-access to the breakup model. More...

BreakupModel< SprayCloud< CloudType > > &	breakup ()
	Return reference to the breakup 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	evolve ()
	Evolve the spray (inject, move) More...

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

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

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

Protected Attributes
autoPtr< AtomizationModel< SprayCloud< CloudType > > >	atomizationModel_
	Atomization model. More...

autoPtr< BreakupModel< SprayCloud< CloudType > > >	breakupModel_
	Break-up model. More...

Detailed Description

template<class CloudType>
class Foam::SprayCloud< CloudType >

Templated base class for spray cloud.

- sub-models:

atomization model
break-up model

Definition at line 50 of file SprayCloud.H.

Member Typedef Documentation

◆ cloudType

typedef CloudType cloudType

Type of cloud this cloud was instantiated for.

Definition at line 68 of file SprayCloud.H.

◆ parcelType

typedef CloudType::particleType parcelType

Type of parcel the cloud was instantiated for.

Definition at line 71 of file SprayCloud.H.

◆ sprayCloudType

typedef SprayCloud<CloudType> sprayCloudType

Convenience typedef for this cloud type.

Definition at line 74 of file SprayCloud.H.

Constructor & Destructor Documentation

◆ SprayCloud() [1/3]

SprayCloud	(	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 74 of file SprayCloud.C.

◆ SprayCloud() [2/3]

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

Copy constructor with new name.

Definition at line 114 of file SprayCloud.C.

◆ SprayCloud() [3/3]

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

Copy constructor with new name - creates bare cloud.

Definition at line 130 of file SprayCloud.C.

◆ ~SprayCloud()

~SprayCloud ( )

virtual

Destructor.

Definition at line 148 of file SprayCloud.C.

Member Function Documentation

◆ setModels()

void setModels ( )

protected

Set cloud sub-models.

Definition at line 35 of file SprayCloud.C.

◆ cloudReset()

void cloudReset ( SprayCloud< CloudType > & c )

protected

Reset state of cloud.

Definition at line 59 of file SprayCloud.C.

◆ clone()

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

inlinevirtual

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

Definition at line 153 of file SprayCloud.H.

◆ 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 162 of file SprayCloud.H.

◆ cloudCopy()

const Foam::SprayCloud< CloudType > & cloudCopy ( ) const

inline

Return a reference to the cloud copy.

Definition at line 33 of file SprayCloudI.H.

◆ averageParcelMass()

Foam::scalar averageParcelMass ( ) const

inline

Return const-access to the average parcel mass.

Definition at line 72 of file SprayCloudI.H.

◆ penetration()

Foam::scalar penetration ( const scalar fraction ) const

inline

Penetration for fraction [0-1] of the current total mass.

Definition at line 80 of file SprayCloudI.H.

◆ atomization() [1/2]

const Foam::AtomizationModel< Foam::SprayCloud< CloudType > > & atomization ( ) const

inline

Return const-access to the atomization model.

Definition at line 41 of file SprayCloudI.H.

◆ atomization() [2/2]

Foam::AtomizationModel< Foam::SprayCloud< CloudType > > & atomization ( )

inline

Return reference to the atomization model.

Definition at line 49 of file SprayCloudI.H.

◆ breakup() [1/2]

const Foam::BreakupModel< Foam::SprayCloud< CloudType > > & breakup ( ) const

inline

Return const-access to the breakup model.

Definition at line 57 of file SprayCloudI.H.

◆ breakup() [2/2]

Foam::BreakupModel< Foam::SprayCloud< CloudType > > & breakup ( )

inline

Return reference to the breakup model.

Definition at line 65 of file SprayCloudI.H.

◆ setParcelThermoProperties()

void setParcelThermoProperties	(	parcelType &	parcel,
		const scalar	lagrangianDt
	)

Set parcel thermo properties.

Definition at line 156 of file SprayCloud.C.

◆ checkParcelProperties()

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

Check parcel properties.

Definition at line 179 of file SprayCloud.C.

◆ storeState()

void storeState ( )

Store the current cloud state.

Definition at line 199 of file SprayCloud.C.

◆ restoreState()

void restoreState ( )

Reset the current cloud to the previously stored state.

Definition at line 212 of file SprayCloud.C.

◆ evolve()

void evolve ( )

Evolve the spray (inject, move)

Definition at line 220 of file SprayCloud.C.

◆ info()

void info ( )

Print cloud information.

Definition at line 232 of file SprayCloud.C.

Member Data Documentation

◆ atomizationModel_

autoPtr<AtomizationModel<SprayCloud<CloudType> > > atomizationModel_

protected

Atomization model.

Definition at line 105 of file SprayCloud.H.

◆ breakupModel_

autoPtr<BreakupModel<SprayCloud<CloudType> > > breakupModel_

protected

Break-up model.

Definition at line 108 of file SprayCloud.H.

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

src/lagrangian/spray/clouds/Templates/SprayCloud/SprayCloud.H
src/lagrangian/spray/clouds/Templates/SprayCloud/SprayCloud.C
src/lagrangian/spray/clouds/Templates/SprayCloud/SprayCloudI.H

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class CloudType> class Foam::SprayCloud< CloudType >

Member Typedef Documentation

◆ cloudType

◆ parcelType

◆ sprayCloudType

Constructor & Destructor Documentation

◆ SprayCloud() [1/3]

◆ SprayCloud() [2/3]

◆ SprayCloud() [3/3]

◆ ~SprayCloud()

Member Function Documentation

◆ setModels()

◆ cloudReset()

◆ clone()

◆ cloneBare()

◆ cloudCopy()

◆ averageParcelMass()

◆ penetration()

◆ atomization() [1/2]

◆ atomization() [2/2]

◆ breakup() [1/2]

◆ breakup() [2/2]

◆ setParcelThermoProperties()

◆ checkParcelProperties()

◆ storeState()

◆ restoreState()

◆ evolve()

◆ info()

Member Data Documentation

◆ atomizationModel_

◆ breakupModel_

template<class CloudType>
class Foam::SprayCloud< CloudType >