FreeFOAM The Cross-Platform CFD Toolkit
dsmcParcel Class Reference

#include <dsmc/dsmcParcel.H>


Detailed Description

+ Inheritance diagram for dsmcParcel:
+ Collaboration diagram for dsmcParcel:

List of all members.

Public Member Functions

 TypeName ("dsmcParcel")
 Run-time type information.
 dsmcParcel (DsmcCloud< dsmcParcel > &owner, const vector &position, const vector &U, const scalar Ei, const label celli, const label typeId)
 Construct from components.
 dsmcParcel (const Cloud< dsmcParcel > &c, Istream &is, bool readFields=true)
 Construct from Istream.
autoPtr< dsmcParcelclone () const
 Construct and return a clone.
virtual ~dsmcParcel ()
 Destructor.
- Public Member Functions inherited from DsmcParcel< dsmcParcel >
 TypeName ("DsmcParcel")
 Runtime type information.
 DsmcParcel (DsmcCloud< dsmcParcel > &owner, const vector &position, const vector &U, const scalar Ei, const label celli, const label typeId)
 Construct from components.
 DsmcParcel (const Cloud< dsmcParcel > &c, Istream &is, bool readFields=true)
 Construct from Istream.
label typeId () const
 Return type id.
const vectorU () const
 Return const access to velocity.
vectorU ()
 Return access to velocity.
scalar Ei () const
 Return const access to internal energy.
scalar & Ei ()
 Return access to internal energy.
bool move (TrackData &td)
 Move the parcel.
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 polyPatch.
void hitPatch (const polyPatch &, int &)
void hitProcessorPatch (const processorPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a.
void hitProcessorPatch (const processorPolyPatch &, int &)
 Overridable function to handle the particle hitting a.
void hitWallPatch (const wallPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wallPatch.
void hitWallPatch (const wallPolyPatch &, int &)
 Overridable function to handle the particle hitting a wallPatch.
void transformProperties (const tensor &T)
 Transform the physical properties of the particle.
void transformProperties (const vector &separation)
 Transform the physical properties of the particle.
- Public Member Functions inherited from Particle< dsmcParcel >
 TypeName ("Particle")
 Runtime type information.
 Particle (const Cloud< dsmcParcel > &, const vector &position, const label celli)
 Construct from components.
 Particle (const Cloud< dsmcParcel > &, Istream &, bool readFields=true)
 Construct from Istream.
 Particle (const Particle &p)
 Construct as a copy.
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< dsmcParcel > & 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.

Additional Inherited Members

- Static Public Member Functions inherited from DsmcParcel< dsmcParcel >
static void readFields (Cloud< dsmcParcel > &c)
 Read the fields associated with the owner cloud.
static void writeFields (const Cloud< dsmcParcel > &c)
 Write the fields associated with the owner cloud.
- Protected Attributes inherited from DsmcParcel< dsmcParcel >
vector U_
 Velocity of Parcel [m/s].
scalar Ei_
 Internal energy of the Parcel, covering all non-translational.
label typeId_
 Parcel type id.
- Protected Attributes inherited from Particle< dsmcParcel >
const Cloud< dsmcParcel > & 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

dsmcParcel ( DsmcCloud< dsmcParcel > &  owner,
const vector position,
const vector U,
const scalar  Ei,
const label  celli,
const label  typeId 
)

Construct from components.

Definition at line 41 of file dsmcParcel.C.

Referenced by dsmcParcel::clone().

dsmcParcel ( const Cloud< dsmcParcel > &  c,
Istream is,
bool  readFields = true 
)

Construct from Istream.

Definition at line 63 of file dsmcParcel.C.

~dsmcParcel ( )
virtual

Destructor.

Definition at line 75 of file dsmcParcel.C.


Member Function Documentation

TypeName ( "dsmcParcel"  )

Run-time type information.

autoPtr<dsmcParcel> clone ( ) const
inline

Construct and return a clone.

Reimplemented from DsmcParcel< dsmcParcel >.

Definition at line 82 of file dsmcParcel.H.

References dsmcParcel::dsmcParcel().


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