KinematicParcel::constantProperties Class Reference

Class to hold kinematic particle constant properties. More...

Collaboration diagram for KinematicParcel::constantProperties:

Public Member Functions
	constantProperties ()
	Null constructor. More...
	constantProperties (const constantProperties &cp)
	Copy constructor. More...
	constantProperties (const dictionary &parentDict)
	Construct from dictionary. More...
const dictionary &	dict () const
	Return const access to the constant properties dictionary. More...
label	parcelTypeId () const
	Return const access to the parcel type id. More...
scalar	rhoMin () const
	Return const access to the minimum density. More...
scalar	rho0 () const
	Return const access to the particle density. More...
scalar	minParcelMass () const
	Return const access to the minimum parcel mass. More...

Protected Attributes
const dictionary	dict_
	Constant properties dictionary. More...

Private Attributes
demandDrivenEntry< label >	parcelTypeId_
	Parcel type id - used for post-processing to flag the type. More...
demandDrivenEntry< scalar >	rhoMin_
	Minimum density [kg/m3]. More...
demandDrivenEntry< scalar >	rho0_
	Particle density [kg/m3] (constant) More...
demandDrivenEntry< scalar >	minParcelMass_
	Minimum parcel mass [kg]. More...

Detailed Description

Class to hold kinematic particle constant properties.

Definition at line 92 of file KinematicParcel.H.

Constructor & Destructor Documentation

constantProperties() [1/3]

constantProperties ( )

inline

Null constructor.

Definition at line 34 of file KinematicParcelI.H.

constantProperties() [2/3]

constantProperties ( const constantProperties &  cp )

inline

Copy constructor.

Definition at line 46 of file KinematicParcelI.H.

constantProperties() [3/3]

constantProperties ( const dictionary &  parentDict )

inline

Construct from dictionary.

Definition at line 60 of file KinematicParcelI.H.

Member Function Documentation

dict()

const Foam::dictionary & dict ( ) const

inline

Return const access to the constant properties dictionary.

Definition at line 136 of file KinematicParcelI.H.

parcelTypeId()

Foam::label parcelTypeId ( ) const

inline

Return const access to the parcel type id.

Definition at line 144 of file KinematicParcelI.H.

rhoMin()

Foam::scalar rhoMin ( ) const

inline

Return const access to the minimum density.

Definition at line 152 of file KinematicParcelI.H.

rho0()

Foam::scalar rho0 ( ) const

inline

Return const access to the particle density.

Definition at line 160 of file KinematicParcelI.H.

minParcelMass()

Foam::scalar minParcelMass ( ) const

inline

Return const access to the minimum parcel mass.

Definition at line 168 of file KinematicParcelI.H.

Field Documentation

dict_

const dictionary dict_

protected

Constant properties dictionary.

Definition at line 99 of file KinematicParcel.H.

parcelTypeId_

demandDrivenEntry<label> parcelTypeId_

private

Parcel type id - used for post-processing to flag the type.

of parcels issued by this cloud

Definition at line 108 of file KinematicParcel.H.

rhoMin_

demandDrivenEntry<scalar> rhoMin_

private

Minimum density [kg/m3].

Definition at line 111 of file KinematicParcel.H.

rho0_

demandDrivenEntry<scalar> rho0_

private

Particle density [kg/m3] (constant)

Definition at line 114 of file KinematicParcel.H.

minParcelMass_

demandDrivenEntry<scalar> minParcelMass_

private

Minimum parcel mass [kg].

Definition at line 117 of file KinematicParcel.H.

---

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

• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcel.H
• src/lagrangian/intermediate/parcels/Templates/KinematicParcel/KinematicParcelI.H