momentumParcelInjectionData Class Reference

Container class to provide injection data for momentum parcels. More...

Inheritance diagram for momentumParcelInjectionData:
Collaboration diagram for momentumParcelInjectionData:

Public Member Functions

 TypeName ("momentumParcelInjectionData")
 Runtime type information. More...
 
 momentumParcelInjectionData ()
 Null constructor. More...
 
 momentumParcelInjectionData (const dictionary &dict)
 Construct from dictionary. More...
 
 momentumParcelInjectionData (Istream &is)
 Construct from Istream. More...
 
virtual ~momentumParcelInjectionData ()
 Destructor. More...
 
const pointx () const
 Return const access to the position. More...
 
const vectorU () const
 Return const access to the velocity. More...
 
scalar d () const
 Return const access to the diameter. More...
 
scalar rho () const
 Return const access to the density. More...
 
scalar mDot () const
 Return const access to the mass flow rate. More...
 
pointx ()
 Return access to the position. More...
 
vectorU ()
 Return access to the velocity. More...
 
scalar & d ()
 Return access to the diameter. More...
 
scalar & rho ()
 Return access to the density. More...
 
scalar & mDot ()
 Return access to the mass flow rate. More...
 

Protected Attributes

point x_
 Position [m]. More...
 
vector U_
 Velocity [m/s]. More...
 
scalar d_
 Diameter [m]. More...
 
scalar rho_
 Density [kg/m^3]. More...
 
scalar mDot_
 Mass flow rate [kg/s]. More...
 

Friends

bool operator== (const momentumParcelInjectionData &a, const momentumParcelInjectionData &b)
 
bool operator!= (const momentumParcelInjectionData &a, const momentumParcelInjectionData &b)
 
Ostreamoperator<< (Ostream &os, const momentumParcelInjectionData &data)
 Ostream operator. More...
 
Istreamoperator>> (Istream &is, momentumParcelInjectionData &data)
 Istream operator. More...
 

Detailed Description

Container class to provide injection data for momentum parcels.

Source files

Definition at line 67 of file momentumParcelInjectionData.H.

Constructor & Destructor Documentation

◆ momentumParcelInjectionData() [1/3]

Null constructor.

Definition at line 37 of file momentumParcelInjectionData.C.

◆ momentumParcelInjectionData() [2/3]

Construct from dictionary.

Definition at line 47 of file momentumParcelInjectionData.C.

◆ momentumParcelInjectionData() [3/3]

◆ ~momentumParcelInjectionData()

Destructor.

Definition at line 61 of file momentumParcelInjectionData.C.

Member Function Documentation

◆ TypeName()

TypeName ( "momentumParcelInjectionData"  )

Runtime type information.

◆ x() [1/2]

const Foam::point & x ( ) const
inline

Return const access to the position.

Definition at line 30 of file momentumParcelInjectionDataI.H.

References momentumParcelInjectionData::x_.

◆ U() [1/2]

const Foam::vector & U ( ) const
inline

Return const access to the velocity.

Definition at line 36 of file momentumParcelInjectionDataI.H.

◆ d() [1/2]

Foam::scalar d ( ) const
inline

Return const access to the diameter.

Definition at line 42 of file momentumParcelInjectionDataI.H.

◆ rho() [1/2]

Foam::scalar rho ( ) const
inline

Return const access to the density.

Definition at line 48 of file momentumParcelInjectionDataI.H.

◆ mDot() [1/2]

Foam::scalar mDot ( ) const
inline

Return const access to the mass flow rate.

Definition at line 54 of file momentumParcelInjectionDataI.H.

◆ x() [2/2]

Foam::point & x ( )
inline

Return access to the position.

Definition at line 60 of file momentumParcelInjectionDataI.H.

◆ U() [2/2]

Foam::vector & U ( )
inline

Return access to the velocity.

Definition at line 66 of file momentumParcelInjectionDataI.H.

◆ d() [2/2]

Foam::scalar & d ( )
inline

Return access to the diameter.

Definition at line 72 of file momentumParcelInjectionDataI.H.

◆ rho() [2/2]

Foam::scalar & rho ( )
inline

Return access to the density.

Definition at line 78 of file momentumParcelInjectionDataI.H.

◆ mDot() [2/2]

Foam::scalar & mDot ( )
inline

Return access to the mass flow rate.

Definition at line 84 of file momentumParcelInjectionDataI.H.

Friends And Related Function Documentation

◆ operator==

bool operator== ( const momentumParcelInjectionData a,
const momentumParcelInjectionData b 
)
friend

Definition at line 148 of file momentumParcelInjectionData.H.

◆ operator!=

bool operator!= ( const momentumParcelInjectionData a,
const momentumParcelInjectionData b 
)
friend

Definition at line 159 of file momentumParcelInjectionData.H.

◆ operator<<

Ostream& operator<< ( Ostream os,
const momentumParcelInjectionData data 
)
friend

Ostream operator.

◆ operator>>

Istream& operator>> ( Istream is,
momentumParcelInjectionData data 
)
friend

Istream operator.

Member Data Documentation

◆ x_

◆ U_

vector U_
protected

◆ d_

scalar d_
protected

◆ rho_

scalar rho_
protected

◆ mDot_

scalar mDot_
protected

Mass flow rate [kg/s].

Definition at line 86 of file momentumParcelInjectionData.H.

Referenced by momentumParcelInjectionData::momentumParcelInjectionData(), and Foam::operator>>().


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