kinematicCloud Class Reference

Virtual abstract base class for templated KinematicCloud. More...

#include <kinematicCloud.H>

Inheritance diagram for kinematicCloud:

Public Member Functions
	TypeName ("kinematicCloud")
	Runtime type information.
	kinematicCloud ()=default
	Null constructor.
virtual	~kinematicCloud ()=default
	Destructor.
virtual label	nParcels () const =0
	Number of parcels.
virtual scalar	massInSystem () const =0
	Total mass in system.
virtual vector	linearMomentumOfSystem () const =0
	Total linear momentum of the system.
virtual scalar	linearKineticEnergyOfSystem () const =0
	Total linear kinetic energy in the system.
virtual scalar	Dij (const label i, const label j) const =0
	Mean diameter Dij.
virtual scalar	Dmax () const =0
	Max diameter.
virtual const tmp< volScalarField >	vDotSweep () const =0
	Volume swept rate of parcels per cell.
virtual const tmp< volScalarField >	theta () const =0
	Return the particle volume fraction field.
virtual const tmp< volScalarField >	alpha () const =0
	Return the particle mass fraction field.
virtual const tmp< volScalarField >	rhoEff () const =0
	Return the particle effective density field.

Detailed Description

Virtual abstract base class for templated KinematicCloud.

Source files

• kinematicCloud.H
• kinematicCloud.H

Definition at line 48 of file kinematicCloud.H.

Constructor & Destructor Documentation

kinematicCloud()

kinematicCloud ( )

default

Null constructor.

Referenced by KinematicCloud< CloudType >::KinematicCloud(), KinematicCloud< CloudType >::KinematicCloud(), and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::setModels().

Here is the caller graph for this function:

~kinematicCloud()

virtual ~kinematicCloud ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"kinematicCloud"

)

Runtime type information.

nParcels()

virtual label nParcels ( ) const

pure virtual

Number of parcels.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

massInSystem()

virtual scalar massInSystem ( ) const

pure virtual

Total mass in system.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

linearMomentumOfSystem()

virtual vector linearMomentumOfSystem ( ) const

pure virtual

Total linear momentum of the system.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

linearKineticEnergyOfSystem()

virtual scalar linearKineticEnergyOfSystem ( ) const

pure virtual

Total linear kinetic energy in the system.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

Dij()

virtual scalar Dij ( const label i, const label j ) const

pure virtual

Mean diameter Dij.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

Dmax()

virtual scalar Dmax ( ) const

pure virtual

Max diameter.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

vDotSweep()

virtual const tmp< volScalarField > vDotSweep ( ) const

pure virtual

Volume swept rate of parcels per cell.

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

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.

Note: for particles belonging to this cloud only

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

alpha()

virtual const tmp< volScalarField > alpha ( ) const

pure virtual

Return the particle mass fraction field.

Note: for particles belonging to this cloud only

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

rhoEff()

virtual const tmp< volScalarField > rhoEff ( ) const

pure virtual

Return the particle effective density field.

Note: for particles belonging to this cloud only

Implemented in KinematicCloud< CloudType >, KinematicCloud< Cloud< basicKinematicParcel > >, and KinematicCloud< Foam::DSMCCloud< dsmcParcel > >.

---

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

• src/lagrangian/intermediate/clouds/baseClasses/kinematicCloud/kinematicCloud.H