KinematicParcel< ParcelType >::constantProperties Class Reference

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

Collaboration diagram for KinematicParcel< ParcelType >::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...

Detailed Description

template<class ParcelType>
class Foam::KinematicParcel< ParcelType >::constantProperties

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.

Referenced by KinematicParcel< ParcelType >::constantProperties::constantProperties().

Here is the caller graph for this function:

constantProperties() [2/3]

constantProperties ( const constantProperties &  cp )

inline

Copy constructor.

Definition at line 46 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::constantProperties::constantProperties().

Here is the call graph for this function:

constantProperties() [3/3]

constantProperties ( const dictionary &  parentDict )

inline

Construct from dictionary.

Definition at line 60 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::KinematicParcel().

Here is the call graph for this function:

Member Function Documentation

dict()

const Foam::dictionary & dict ( ) const

inline

Return const access to the constant properties dictionary.

Definition at line 161 of file KinematicParcelI.H.

References KinematicParcel< ParcelType >::constantProperties::dict_.

parcelTypeId()

Foam::label parcelTypeId ( ) const

inline

Return const access to the parcel type id.

Definition at line 169 of file KinematicParcelI.H.

References demandDrivenEntry< Type >::value().

Here is the call graph for this function:

rhoMin()

Foam::scalar rhoMin ( ) const

inline

Return const access to the minimum density.

Definition at line 177 of file KinematicParcelI.H.

References demandDrivenEntry< Type >::value().

Here is the call graph for this function:

rho0()

Foam::scalar rho0 ( ) const

inline

Return const access to the particle density.

Definition at line 185 of file KinematicParcelI.H.

References demandDrivenEntry< Type >::value().

Here is the call graph for this function:

minParcelMass()

Foam::scalar minParcelMass ( ) const

inline

Return const access to the minimum parcel mass.

Definition at line 193 of file KinematicParcelI.H.

References demandDrivenEntry< Type >::value().

Here is the call graph for this function:

Member Data Documentation

dict_

const dictionary dict_

protected

Constant properties dictionary.

Definition at line 99 of file KinematicParcel.H.

Referenced by KinematicParcel< ParcelType >::constantProperties::dict().

---

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