FreeFOAM The Cross-Platform CFD Toolkit
parcel Class Reference

A parcel of particles. More...

#include <dieselSpray/parcel.H>


Detailed Description

A parcel of particles.

Definition at line 49 of file parcel.H.

+ Inheritance diagram for parcel:
+ Collaboration diagram for parcel:

List of all members.

Public Member Functions

 parcel (const Cloud< parcel > &cloud, const vector &position, const label celli, const vector &n, const scalar d, const scalar T, const scalar m, const scalar y, const scalar yDot, const scalar ct, const scalar ms, const scalar tTurb, const scalar liquidCore, const scalar injector, const vector &U, const vector &Uturb, const scalarField &X, const List< word > &liquidNames)
 Construct from components.
 parcel (const Cloud< parcel > &cloud, Istream &is, bool readFields=true)
 Construct from Istream reading field values if required.
const List< word > & liquidNames () const
 Return the names of the liquid components.
const List< word > & fuelNames () const
 Return the names of the liquid fuel components - identical with liquidNames.
scalar d () const
 Return diameter of droplets in parcel.
scalar & d ()
 Return diameter of droplets in parcel.
scalar T () const
 Return temperature of droplets in parcel.
scalar & T ()
 Return temperature of droplets in parcel.
scalar m () const
 Return total parcel mass.
scalar & m ()
 Return total parcel mass.
scalar dev () const
 Return spherical deviation of droplets in parcel.
scalar & dev ()
 Return spherical deviation of droplets in parcel.
scalar ddev () const
 Return rate of change of spherical deviation of.
scalar & ddev ()
 Return rate of change of spherical deviation of.
scalar ct () const
 Return characteristic time of droplets in parcel.
scalar & ct ()
 Return characteristic time of droplets in parcel.
scalar & ms ()
 Return stripped mass of droplets in parcel.
scalar ms () const
 Return stripped mass of droplets in parcel.
scalar & tTurb ()
 Return time spent in turbulent eddy.
scalar tTurb () const
 Return time spent in turbulent eddy.
scalar & liquidCore ()
 Return part of liquid liquidCore.
scalar liquidCore () const
 Return part of liquid liquidCore.
scalar & injector ()
 Return the injector from which is injected.
scalar injector () const
 Return the injector from which is injected.
const vectorU () const
 Return velocity of parcel.
vectorU ()
 Return velocity of parcel.
const vectorUturb () const
 Return turbulent velocity fluctuation.
vectorUturb ()
 Return turbulent velocity fluctuation.
const vectorn () const
 Return the normal used for 2D purposes.
vectorn ()
 Return the normal used for 2D purposes.
const scalarFieldX () const
 Return the liquid components molar fractions.
scalarFieldX ()
 Return the liquid components molar fractions.
scalar & tMom ()
 Return the momentum relaxation time of droplets in parcel.
scalar tMom () const
 Return the momentum relaxation time of droplets in parcel.
scalar N (const scalar rho) const
 Return statistical number of drops in parcel.
vector Urel (const vector &) const
 Return relative velocity between given vector and parcel.
scalar Re (const scalar rho, const vector &U, const scalar mu) const
 Reynolds number based on rho an dynamic viscosity.
scalar Re (const vector &U, const scalar nu) const
 Reynolds number based on kinematic viscosity.
scalar We (const vector &U, const scalar rho, const scalar sigma) const
 Weber number.
scalar Sc (const scalar mu, const scalar rho, const scalar massDiffusion) const
 Schmidt number based on dynamic viscosity and rho.
scalar Sc (const scalar nu, const scalar massDiffusion) const
 Schmidt number based on kinematic viscosity.
scalar Pr (const scalar cp, const scalar mu, const scalar kappa) const
 Prandtl number.
scalar Vd () const
 Volume of one droplet in the parcel.
scalar V (const scalar rho) const
 Volume of all droplets in parcel.
bool move (spray &sprayData)
void transformProperties (const tensor &T)
 Transform the position and physical properties of the particle.
void transformProperties (const vector &separation)
 Transform the position and physical properties of the particle.
void correctNormal (const vector &sym)
 fix the 2D plane normal,
- Public Member Functions inherited from Particle< parcel >
 TypeName ("Particle")
 Runtime type information.
 Particle (const Cloud< parcel > &, const vector &position, const label celli)
 Construct from components.
 Particle (const Cloud< parcel > &, Istream &, bool readFields=true)
 Construct from Istream.
 Particle (const Particle &p)
 Construct as a copy.
autoPtr< parcelclone () const
 Construct a clone.
virtual ~Particle ()
 Destructor.
bool inCell () const
 Return true if particle is in cell.
bool inCell (const vector &position, const label celli, const scalar stepFraction) const
 Return true if position is in cell i.
const vectorposition () const
 Return current particle position.
vectorposition ()
 Return current particle position.
label & cell ()
 Return current cell particle is in.
label cell () const
 Return current cell particle is in.
label face () const
 Return current face particle is on otherwise -1.
const Cloud< parcel > & cloud () const
 Return reference to the particle cloud.
bool softImpact () const
 Return the impact model to be used, soft or hard (default).
scalar currentTime () const
 Return the particle current time.
bool onBoundary () const
 Is the particle on the boundary/(or outside the domain)?
label patch (const label facei) const
 Which patch is particle on.
label patchFace (const label patchi, const label facei) const
 Which face of this patch is this particle on.
scalar wallImpactDistance (const vector &n) const
 The nearest distance to a wall that.
scalar & stepFraction ()
 Return the fraction of time-step completed.
scalar stepFraction () const
 Return the fraction of time-step completed.
label origProc () const
 Return the originating processor id.
label origId () const
 Return the particle id on originating processor.
label track (const vector &endPosition, TrackData &td)
 Track particle to end of trajectory.
label track (const vector &endPosition)
 Calls the templated track with dummy TrackData.
scalar trackToFace (const vector &endPosition, TrackData &td)
 Track particle to a given position and returns 1.0 if the.
scalar trackToFace (const vector &endPosition)
 Calls the templated trackToFace with dummy TrackData.
label faceInterpolation () const
 Return the index of the face to be used in the interpolation.
void write (Ostream &os, bool writeFields) const
 Write the particle data.

Static Public Member Functions

static void readFields (Cloud< parcel > &c)
 Read the fields associated with the owner cloud.
static void writeFields (const Cloud< parcel > &c)
 Write the fields associated with the owner cloud.

Friends

class Cloud< parcel >
Ostreamoperator<< (Ostream &, const parcel &)

Additional Inherited Members

- Static Public Attributes inherited from Particle< parcel >
static string propHeader
 String representation of properties.
- Protected Member Functions inherited from Particle< parcel >
scalar lambda (const vector &from, const vector &to, const label facei, const scalar stepFraction) const
 Return the 'lambda' value for the position, p, on the face,.
scalar lambda (const vector &from, const vector &to, const label facei) const
 Return the 'lambda' value for the position, p, on the face,.
void findFaces (const vector &position, DynamicList< label > &faceList) const
 Find the faces between position and cell centre.
void findFaces (const vector &position, const label celli, const scalar stepFraction, DynamicList< label > &faceList) const
 Find the faces between position and cell centre.
bool hitPatch (const polyPatch &, TrackData &td, const label patchI)
 Overridable function to handle the particle hitting a patch.
void hitPatch (const polyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitWedgePatch (const wedgePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wedgePatch.
void hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitCyclicPatch (const cyclicPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a cyclicPatch.
void hitProcessorPatch (const processorPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitWallPatch (const wallPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wallPatch.
virtual void transformPosition (const tensor &T)
 Transform the position the particle.
void prepareForParallelTransfer (const label patchi, TrackData &td)
 Convert global addressing to the processor patch.
void correctAfterParallelTransfer (const label patchi, TrackData &td)
 Convert processor patch addressing to the global equivalents.
- Protected Attributes inherited from Particle< parcel >
const Cloud< parcel > & cloud_
 Reference to the particle cloud.
vector position_
 Position of particle.
label celli_
 Index of the cell it is in.
label facei_
 Face index if the particle is on a face otherwise -1.
scalar stepFraction_
 Fraction of time-step completed.
label origProc_
 Originating processor id.
label origId_
 Local particle id on originating processor.

Constructor & Destructor Documentation

parcel ( const Cloud< parcel > &  cloud,
const vector position,
const label  celli,
const vector n,
const scalar  d,
const scalar  T,
const scalar  m,
const scalar  y,
const scalar  yDot,
const scalar  ct,
const scalar  ms,
const scalar  tTurb,
const scalar  liquidCore,
const scalar  injector,
const vector U,
const vector Uturb,
const scalarField X,
const List< word > &  liquidNames 
)

Construct from components.

Definition at line 49 of file parcel.C.

parcel ( const Cloud< parcel > &  cloud,
Istream is,
bool  readFields = true 
)

Construct from Istream reading field values if required.

Definition at line 32 of file parcelIO.C.

References readScalar.


Member Function Documentation

const List< word > & liquidNames ( ) const
inline

Return the names of the liquid components.

Definition at line 33 of file parcelI.H.

Referenced by parcel::readFields(), and parcel::writeFields().

const List< word > & fuelNames ( ) const
inline

Return the names of the liquid fuel components - identical with liquidNames.

Definition at line 38 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar & d ( )
inline

Return diameter of droplets in parcel.

Definition at line 48 of file parcelI.H.

scalar & T ( )
inline

Return temperature of droplets in parcel.

Definition at line 58 of file parcelI.H.

scalar m ( ) const
inline

Return total parcel mass.

Definition at line 63 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), SHF::breakupParcel(), spray::inject(), and parcel::move().

scalar & m ( )
inline

Return total parcel mass.

Definition at line 68 of file parcelI.H.

scalar dev ( ) const
inline

Return spherical deviation of droplets in parcel.

Definition at line 73 of file parcelI.H.

Referenced by TAB::breakupParcel(), ETAB::breakupParcel(), and breakupModel::updateParcelProperties().

scalar & dev ( )
inline

Return spherical deviation of droplets in parcel.

Definition at line 78 of file parcelI.H.

scalar ddev ( ) const
inline

Return rate of change of spherical deviation of.

droplets in parcel

Definition at line 83 of file parcelI.H.

Referenced by TAB::breakupParcel(), ETAB::breakupParcel(), and breakupModel::updateParcelProperties().

scalar & ddev ( )
inline

Return rate of change of spherical deviation of.

droplets in parcel

Definition at line 88 of file parcelI.H.

scalar ct ( ) const
inline

Return characteristic time of droplets in parcel.

Definition at line 93 of file parcelI.H.

Referenced by LISA::atomizeParcel(), reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar & ct ( )
inline

Return characteristic time of droplets in parcel.

Definition at line 98 of file parcelI.H.

scalar & ms ( )
inline

Return stripped mass of droplets in parcel.

Definition at line 103 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), and parcel::move().

scalar ms ( ) const
inline

Return stripped mass of droplets in parcel.

Definition at line 108 of file parcelI.H.

scalar & tTurb ( )
inline

Return time spent in turbulent eddy.

Definition at line 113 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar tTurb ( ) const
inline

Return time spent in turbulent eddy.

Definition at line 118 of file parcelI.H.

scalar & liquidCore ( )
inline

Return part of liquid liquidCore.

Definition at line 123 of file parcelI.H.

Referenced by noAtomization::atomizeParcel(), blobsSheetAtomization::atomizeParcel(), and LISA::atomizeParcel().

scalar liquidCore ( ) const
inline

Return part of liquid liquidCore.

Definition at line 128 of file parcelI.H.

scalar & injector ( )
inline

Return the injector from which is injected.

Definition at line 133 of file parcelI.H.

Referenced by blobsSheetAtomization::atomizeParcel(), LISA::atomizeParcel(), reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar injector ( ) const
inline

Return the injector from which is injected.

Definition at line 138 of file parcelI.H.

vector & U ( )
inline

Return velocity of parcel.

Definition at line 148 of file parcelI.H.

const vector & Uturb ( ) const
inline

Return turbulent velocity fluctuation.

Definition at line 153 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), SHF::breakupParcel(), and parcel::move().

vector & Uturb ( )
inline

Return turbulent velocity fluctuation.

Definition at line 158 of file parcelI.H.

const vector & n ( ) const
inline

Return the normal used for 2D purposes.

Definition at line 163 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), SHF::breakupParcel(), and parcel::move().

vector & n ( )
inline

Return the normal used for 2D purposes.

Definition at line 168 of file parcelI.H.

scalarField & X ( )
inline

Return the liquid components molar fractions.

Definition at line 178 of file parcelI.H.

scalar & tMom ( )
inline

Return the momentum relaxation time of droplets in parcel.

Definition at line 183 of file parcelI.H.

Referenced by reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar tMom ( ) const
inline

Return the momentum relaxation time of droplets in parcel.

Definition at line 188 of file parcelI.H.

scalar N ( const scalar  rho) const

Return statistical number of drops in parcel.

Definition at line 102 of file parcelFunctions.C.

References Foam::mathematicalConstant::pi(), and Foam::pow().

Referenced by reitzKHRT::breakupParcel().

vector Urel ( const vector U) const
inline

Return relative velocity between given vector and parcel.

Definition at line 193 of file parcelI.H.

References parcel::U().

Referenced by blobsSheetAtomization::atomizeParcel(), reitzDiwakar::breakupParcel(), reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar Re ( const scalar  rho,
const vector U,
const scalar  mu 
) const

Reynolds number based on rho an dynamic viscosity.

Definition at line 48 of file parcelFunctions.C.

References Foam::mag(), and mu.

Referenced by reitzDiwakar::breakupParcel(), reitzKHRT::breakupParcel(), and SHF::breakupParcel().

scalar Re ( const vector U,
const scalar  nu 
) const

Reynolds number based on kinematic viscosity.

Definition at line 38 of file parcelFunctions.C.

References Foam::mag(), and nu.

scalar We ( const vector U,
const scalar  rho,
const scalar  sigma 
) const
scalar Sc ( const scalar  mu,
const scalar  rho,
const scalar  massDiffusion 
) const

Schmidt number based on dynamic viscosity and rho.

Definition at line 71 of file parcelFunctions.C.

scalar Sc ( const scalar  nu,
const scalar  massDiffusion 
) const

Schmidt number based on kinematic viscosity.

Definition at line 82 of file parcelFunctions.C.

scalar Pr ( const scalar  cp,
const scalar  mu,
const scalar  kappa 
) const

Prandtl number.

Definition at line 92 of file parcelFunctions.C.

References kappa().

scalar Vd ( ) const

Volume of one droplet in the parcel.

Definition at line 108 of file parcelFunctions.C.

References Foam::mathematicalConstant::pi(), and Foam::pow().

scalar V ( const scalar  rho) const

Volume of all droplets in parcel.

Definition at line 114 of file parcelFunctions.C.

References rho.

void transformProperties ( const tensor T)
virtual

Transform the position and physical properties of the particle.

according to the given transformation tensor

Reimplemented from Particle< parcel >.

Definition at line 687 of file parcel.C.

References Foam::transform().

void transformProperties ( const vector separation)
virtual

Transform the position and physical properties of the particle.

according to the given separation vector

Reimplemented from Particle< parcel >.

Definition at line 693 of file parcel.C.

void correctNormal ( const vector sym)
inline

fix the 2D plane normal,

when particle hits a face it is slightly perturbed towards the face centre and n_ will no longer be valid

Definition at line 199 of file parcelI.H.

References d, and Foam::mag().

Referenced by parcel::move().

void writeFields ( const Cloud< parcel > &  c)
static

Write the fields associated with the owner cloud.

Reimplemented from Particle< parcel >.

Definition at line 200 of file parcelIO.C.

References Cloud< ParticleType >::begin(), d, Cloud< ParticleType >::fieldIOobject(), forAllConstIter, parcel::liquidNames(), p, List< T >::size(), Cloud< ParticleType >::size(), T, U, parcel::X(), and y.


Friends And Related Function Documentation

friend class Cloud< parcel >
friend

Definition at line 143 of file parcel.H.

Ostream& operator<< ( Ostream ,
const parcel  
)
friend

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