Public Member Functions | Protected Attributes | List of all members
KinematicParcel< ParcelType >::constantProperties Class Reference

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

Collaboration diagram for KinematicParcel< ParcelType >::constantProperties:
Collaboration graph
[legend]

Public Member Functions

 constantProperties ()
 Default construct. 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 104 of file KinematicParcel.H.

Constructor & Destructor Documentation

◆ constantProperties() [1/3]

constantProperties ( )
inline

Default construct.

Definition at line 30 of file KinematicParcelI.H.

◆ constantProperties() [2/3]

constantProperties ( const constantProperties &  cp)
inline

Copy constructor.

Definition at line 42 of file KinematicParcelI.H.

◆ constantProperties() [3/3]

constantProperties ( const dictionary &  parentDict)
inline

Construct from dictionary.

Definition at line 56 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 148 of file KinematicParcelI.H.

◆ parcelTypeId()

Foam::label parcelTypeId ( ) const
inline

Return const access to the parcel type id.

Definition at line 156 of file KinematicParcelI.H.

◆ rhoMin()

Foam::scalar rhoMin ( ) const
inline

Return const access to the minimum density.

Definition at line 164 of file KinematicParcelI.H.

◆ rho0()

Foam::scalar rho0 ( ) const
inline

Return const access to the particle density.

Definition at line 172 of file KinematicParcelI.H.

◆ minParcelMass()

Foam::scalar minParcelMass ( ) const
inline

Return const access to the minimum parcel mass.

Definition at line 180 of file KinematicParcelI.H.

Member Data Documentation

◆ dict_

const dictionary dict_
protected

Constant properties dictionary.

Definition at line 113 of file KinematicParcel.H.

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