Virtual abstract base class for parcel clouds. Inserted by ParcelCloudBase into the base of the cloud template hierarchy and adds virtualisation of most methods defined by the clouds. More...

Inheritance diagram for parcelCloudBase:

[legend]

Public Member Functions
	TypeName ("parcelCloudBase")
	Runtime type information. More...

	parcelCloudBase ()
	Null constructor. More...

	parcelCloudBase (const parcelCloudBase &)=delete
	Disallow default bitwise copy construction. More...

virtual	~parcelCloudBase ()
	Destructor. More...

virtual label	nParcels () const =0
	Number of parcels. More...

virtual scalar	massInSystem () const =0
	Total mass in system. More...

virtual const tmp< volScalarField >	vDotSweep () const =0
	Volume swept rate of parcels per cell. More...

virtual const tmp< volScalarField >	theta () const =0
	Return the particle volume fraction field. More...

virtual const tmp< volScalarField >	alpha () const =0
	Return the particle mass fraction field. More...

virtual const tmp< volScalarField >	rhoEff () const =0
	Return the particle effective density field. More...

virtual tmp< fvVectorMatrix >	SU (const volVectorField &U) const =0
	Return momentum source term [kg m/s^2]. More...

virtual tmp< volVectorField::Internal >	UTrans () const =0
	Momentum transfer [kg m/s]. More...

virtual tmp< volScalarField::Internal >	UCoeff () const =0
	Momentum transfer coefficient [kg]. More...

virtual tmp< fvScalarMatrix >	Sh (const volScalarField &hs) const =0
	Return sensible enthalpy source term [J/s]. More...

virtual tmp< volScalarField::Internal >	hsTrans () const =0
	Sensible enthalpy transfer [J]. More...

virtual tmp< volScalarField::Internal >	hsCoeff () const =0
	Sensible enthalpy transfer coefficient [J/K]. More...

virtual tmp< volScalarField >	Ep () const =0
	Return equivalent particulate emission [kg/m/s^3]. More...

virtual tmp< volScalarField >	ap () const =0
	Return equivalent particulate absorption [1/m]. More...

virtual tmp< volScalarField >	sigmap () const =0
	Return equivalent particulate scattering factor [1/m]. More...

virtual tmp< fvScalarMatrix >	SYi (const label i, const volScalarField &Yi) const =0
	Return mass source term for specie [kg/s]. More...

virtual tmp< fvScalarMatrix >	Srho (const volScalarField &rho) const =0
	Return total mass source term [kg/s]. More...

virtual tmp< volScalarField::Internal >	Srho () const =0
	Return total mass source [kg/m^3/s]. More...

virtual void	info ()=0
	Print cloud information. More...

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

Detailed Description

Virtual abstract base class for parcel clouds. Inserted by ParcelCloudBase into the base of the cloud template hierarchy and adds virtualisation of most methods defined by the clouds.

Note that the "evolve" method is not virtualised here. Due to the way in which TrackCloudType and trackingData templating work, it is not possible to virtualise this method directly. Instead it has to be wrapped. That is achieved by the parcelCloud and ParcelCloud classes.

Source files

Definition at line 54 of file parcelCloudBase.H.

Constructor & Destructor Documentation

◆ parcelCloudBase() [1/2]

parcelCloudBase ( )

Null constructor.

Definition at line 38 of file parcelCloudBase.C.

◆ parcelCloudBase() [2/2]

parcelCloudBase ( const parcelCloudBase & )

delete

Disallow default bitwise copy construction.

◆ ~parcelCloudBase()

~parcelCloudBase ( )

virtual

Destructor.

Definition at line 44 of file parcelCloudBase.C.

Member Function Documentation

◆ TypeName()

TypeName ( "parcelCloudBase" )

Runtime type information.

◆ nParcels()

virtual label nParcels ( ) const

pure virtual

Number of parcels.

Referenced by cloudInfo::write().

Here is the caller graph for this function:

◆ massInSystem()

virtual scalar massInSystem ( ) const

pure virtual

Total mass in system.

Referenced by cloudInfo::write().

Here is the caller graph for this function:

◆ vDotSweep()

virtual const tmp<volScalarField> vDotSweep ( ) const

pure virtual

Volume swept rate of parcels per cell.

Referenced by SuppressionCollision< CloudType >::collide().

Here is the caller graph for this function:

◆ theta()

virtual const tmp<volScalarField> theta ( ) const

pure virtual

Return the particle volume fraction field.

◆ alpha()

virtual const tmp<volScalarField> alpha ( ) const

pure virtual

Return the particle mass fraction field.

◆ rhoEff()

virtual const tmp<volScalarField> rhoEff ( ) const

pure virtual

Return the particle effective density field.

◆ SU()

virtual tmp<fvVectorMatrix> SU ( const volVectorField & U ) const

pure virtual

Return momentum source term [kg m/s^2].

Implemented in ParcelCloudBase< ParticleType >.

◆ UTrans()

virtual tmp<volVectorField::Internal> UTrans ( ) const

pure virtual

Momentum transfer [kg m/s].

Implemented in ParcelCloudBase< ParticleType >.

◆ UCoeff()

virtual tmp<volScalarField::Internal> UCoeff ( ) const

pure virtual

Momentum transfer coefficient [kg].

Implemented in ParcelCloudBase< ParticleType >.

◆ Sh()

virtual tmp<fvScalarMatrix> Sh ( const volScalarField & hs ) const

pure virtual

Return sensible enthalpy source term [J/s].

Implemented in ParcelCloudBase< ParticleType >.

◆ hsTrans()

virtual tmp<volScalarField::Internal> hsTrans ( ) const

pure virtual

Sensible enthalpy transfer [J].

Implemented in ParcelCloudBase< ParticleType >.

◆ hsCoeff()

virtual tmp<volScalarField::Internal> hsCoeff ( ) const

pure virtual

Sensible enthalpy transfer coefficient [J/K].

Implemented in ParcelCloudBase< ParticleType >.

◆ Ep()

virtual tmp<volScalarField> Ep ( ) const

pure virtual

Return equivalent particulate emission [kg/m/s^3].

Implemented in ParcelCloudBase< ParticleType >.

Referenced by cloud::EDisp().

Here is the caller graph for this function:

◆ ap()

virtual tmp<volScalarField> ap ( ) const

pure virtual

Return equivalent particulate absorption [1/m].

Implemented in ParcelCloudBase< ParticleType >.

Referenced by cloud::aDisp().

Here is the caller graph for this function:

◆ sigmap()

virtual tmp<volScalarField> sigmap ( ) const

pure virtual

Return equivalent particulate scattering factor [1/m].

Implemented in ParcelCloudBase< ParticleType >.

Referenced by cloud::sigmaEff().

Here is the caller graph for this function:

◆ SYi()

virtual tmp<fvScalarMatrix> SYi	(	const label	i,
		const volScalarField &	Yi
	)		const

pure virtual

Return mass source term for specie [kg/s].

Implemented in ParcelCloudBase< ParticleType >.

◆ Srho() [1/2]

virtual tmp<fvScalarMatrix> Srho ( const volScalarField & rho ) const

pure virtual

Return total mass source term [kg/s].

Implemented in ParcelCloudBase< ParticleType >.

◆ Srho() [2/2]

virtual tmp<volScalarField::Internal> Srho ( ) const

pure virtual

Return total mass source [kg/m^3/s].

Implemented in ParcelCloudBase< ParticleType >.

◆ info()

virtual void info ( )

pure virtual

Print cloud information.

◆ operator=()

void operator= ( const parcelCloudBase & )

delete

Disallow default bitwise assignment.

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

src/lagrangian/parcel/parcelCloud/parcelCloudBase.H
src/lagrangian/parcel/parcelCloud/parcelCloudBase.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ parcelCloudBase() [1/2]

◆ parcelCloudBase() [2/2]

◆ ~parcelCloudBase()

Member Function Documentation

◆ TypeName()

◆ nParcels()

◆ massInSystem()

◆ vDotSweep()

◆ theta()

◆ alpha()

◆ rhoEff()

◆ SU()

◆ UTrans()

◆ UCoeff()

◆ Sh()

◆ hsTrans()

◆ hsCoeff()

◆ Ep()

◆ ap()

◆ sigmap()

◆ SYi()

◆ Srho() [1/2]

◆ Srho() [2/2]

◆ info()

◆ operator=()