KinematicParcel< ParcelType >::constantProperties Class Reference

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

#include <KinematicParcel.H>

Collaboration diagram for KinematicParcel< ParcelType >::constantProperties:

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

Protected Attributes
const dictionary	dict_
	Constant properties dictionary.

Detailed Description

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

Class to hold kinematic particle constant properties.

Definition at line 103 of file KinematicParcel.H.

Constructor & Destructor Documentation

constantProperties() [1/3]

template<class ParcelType>

constantProperties ( )

inline

Default construct.

Definition at line 30 of file KinematicParcelI.H.

References dict_.

Referenced by constantProperties().

Here is the caller graph for this function:

constantProperties() [2/3]

template<class ParcelType>

constantProperties ( const constantProperties & cp )

inline

Copy constructor.

Definition at line 41 of file KinematicParcelI.H.

References constantProperties(), Foam::cp(), and dict_.

Here is the call graph for this function:

constantProperties() [3/3]

template<class ParcelType>

constantProperties ( const dictionary & parentDict )

inline

Construct from dictionary.

Definition at line 55 of file KinematicParcelI.H.

References dict_, and e.

Member Function Documentation

dict()

template<class ParcelType>

const Foam::dictionary & dict ( ) const

inline

Return const access to the constant properties dictionary.

Definition at line 148 of file KinematicParcelI.H.

parcelTypeId()

template<class ParcelType>

Foam::label parcelTypeId ( ) const

inline

Return const access to the parcel type id.

Definition at line 156 of file KinematicParcelI.H.

rhoMin()

template<class ParcelType>

Foam::scalar rhoMin ( ) const

inline

Return const access to the minimum density.

Definition at line 164 of file KinematicParcelI.H.

rho0()

template<class ParcelType>

Foam::scalar rho0 ( ) const

inline

Return const access to the particle density.

Definition at line 172 of file KinematicParcelI.H.

minParcelMass()

template<class ParcelType>

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_

template<class ParcelType>

const dictionary dict_

protected

Constant properties dictionary.

Definition at line 112 of file KinematicParcel.H.

Referenced by constantProperties(), constantProperties(), and constantProperties().

---

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