FreeFOAM The Cross-Platform CFD Toolkit
Public Member Functions | Protected Attributes | Friends
kinematicParcelInjectionData Class Reference

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

#include <lagrangianIntermediate/kinematicParcelInjectionData.H>

Detailed Description

Container class to provide injection data for kinematic parcels.

Source files

Definition at line 68 of file kinematicParcelInjectionData.H.

+ Inheritance diagram for kinematicParcelInjectionData:
+ Collaboration diagram for kinematicParcelInjectionData:

List of all members.

Public Member Functions

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

Protected Attributes

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

Friends

bool operator== (const kinematicParcelInjectionData &a, const kinematicParcelInjectionData &b)
bool operator!= (const kinematicParcelInjectionData &a, const kinematicParcelInjectionData &b)
Ostream & operator<< (Ostream &os, const kinematicParcelInjectionData &data)
 Ostream operator.
Istream & operator>> (Istream &is, kinematicParcelInjectionData &data)
 Istream operator.

Constructor & Destructor Documentation

kinematicParcelInjectionData ( )

Null constructor.

Definition at line 37 of file kinematicParcelInjectionData.C.

kinematicParcelInjectionData ( const dictionary &  dict)

Construct from dictionary.

Definition at line 48 of file kinematicParcelInjectionData.C.

kinematicParcelInjectionData ( Istream &  is)

Construct from Istream.

Definition at line 30 of file kinematicParcelInjectionDataIO.C.

References IOstream::check(), kinematicParcelInjectionData::d_, kinematicParcelInjectionData::mDot_, kinematicParcelInjectionData::rho_, kinematicParcelInjectionData::U_, and kinematicParcelInjectionData::x_.

~kinematicParcelInjectionData ( )
virtual

Destructor.

Definition at line 61 of file kinematicParcelInjectionData.C.

Member Function Documentation

TypeName ( "kinematicParcelInjectionData"  )

Runtime type information.

const Foam::point & x ( ) const
inline

Return const access to the position.

Definition at line 30 of file kinematicParcelInjectionDataI.H.

References kinematicParcelInjectionData::x_.

const Foam::vector & U ( ) const
inline

Return const access to the velocity.

Definition at line 36 of file kinematicParcelInjectionDataI.H.

Foam::scalar d ( ) const
inline

Return const access to the diameter.

Definition at line 42 of file kinematicParcelInjectionDataI.H.

Foam::scalar rho ( ) const
inline

Return const access to the density.

Definition at line 48 of file kinematicParcelInjectionDataI.H.

Foam::scalar mDot ( ) const
inline

Return const access to the mass flow rate.

Definition at line 54 of file kinematicParcelInjectionDataI.H.

Foam::point & x ( )
inline

Return access to the position.

Definition at line 60 of file kinematicParcelInjectionDataI.H.

Foam::vector & U ( )
inline

Return access to the velocity.

Definition at line 66 of file kinematicParcelInjectionDataI.H.

Foam::scalar & d ( )
inline

Return access to the diameter.

Definition at line 72 of file kinematicParcelInjectionDataI.H.

Foam::scalar & rho ( )
inline

Return access to the density.

Definition at line 78 of file kinematicParcelInjectionDataI.H.

Foam::scalar & mDot ( )
inline

Return access to the mass flow rate.

Definition at line 84 of file kinematicParcelInjectionDataI.H.

Friends And Related Function Documentation

bool operator== ( const kinematicParcelInjectionData &  a,
const kinematicParcelInjectionData &  b 
)
friend

Definition at line 152 of file kinematicParcelInjectionData.H.

bool operator!= ( const kinematicParcelInjectionData &  a,
const kinematicParcelInjectionData &  b 
)
friend

Definition at line 170 of file kinematicParcelInjectionData.H.

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

Ostream operator.

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

Istream operator.

Member Data Documentation

point x_
protected

Position [m].

Definition at line 75 of file kinematicParcelInjectionData.H.

Referenced by kinematicParcelInjectionData::kinematicParcelInjectionData(), Foam::operator>>(), and kinematicParcelInjectionData::x().

vector U_
protected

Velocity [m/s].

Definition at line 78 of file kinematicParcelInjectionData.H.

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

scalar d_
protected

Diameter [m].

Definition at line 81 of file kinematicParcelInjectionData.H.

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

scalar rho_
protected

Density [kg/m3].

Definition at line 84 of file kinematicParcelInjectionData.H.

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

scalar mDot_
protected

Mass flow rate [kg/s].

Definition at line 87 of file kinematicParcelInjectionData.H.

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

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