OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

ExactParticle< ParticleType > Class Template Reference

Special version of Particle to do tracking on non-convex cells. More...

Inheritance diagram for ExactParticle< ParticleType >:
Collaboration diagram for ExactParticle< ParticleType >:

List of all members.


Classes

class  iNew
 Factory class to read-construct particles used for parallel transfer. More...

Public Member Functions

 ExactParticle (const Cloud< ParticleType > &cloud, const vector &position, const label celli)
 Construct from components.
 ExactParticle (const Cloud< ParticleType > &cloud, Istream &is, bool readFields=true)
 Construct from Istream.
virtual ~ExactParticle ()
template<class TrackingData >
label track (const vector &endPosition, TrackingData &td)
 Track particle to end of trajectory.
label track (const vector &endPosition)
 Calls the templated track with dummy TrackingData.
template<class TrackingData >
scalar trackToFace (const vector &endPosition, TrackingData &td)
 Track particle to a given position and returns 1.0 if the.
scalar trackToFace (const vector &endPosition)
 Calls the templated trackToFace with dummy TrackingData.

Friends

class Cloud< ParticleType >
Ostreamoperator (Ostream &, const ExactParticle< ParticleType > &)

Detailed Description

template<class ParticleType>
class Foam::ExactParticle< ParticleType >

Special version of Particle to do tracking on non-convex cells.

Definition at line 56 of file ExactParticle.H.


Constructor & Destructor Documentation

ExactParticle ( const Cloud< ParticleType > &  cloud,
const vector position,
const label  celli 
) [inline]

Construct from components.

Definition at line 70 of file ExactParticle.H.

ExactParticle ( const Cloud< ParticleType > &  cloud,
Istream is,
bool  readFields = true 
) [inline]

Construct from Istream.

Definition at line 82 of file ExactParticle.H.

virtual ~ExactParticle (  )  [inline, virtual]

Definition at line 120 of file ExactParticle.H.


Member Function Documentation

Foam::label track ( const vector endPosition,
TrackingData &  td 
) [inline]

Track particle to end of trajectory.

or until it hits the boundary. On entry 'stepFraction()' should be set to the fraction of the time-step at which the tracking starts and on exit it contains the fraction of the time-step completed. Returns the boundary face index if the track stops at the boundary, -1 otherwise.

Definition at line 25 of file ExactParticle.C.

References Particle< ParticleType >::facei_, Particle< ParticleType >::onBoundary(), Particle< ParticleType >::stepFraction_, and ExactParticle< ParticleType >::trackToFace().

Referenced by ExactParticle< ParticleType >::trackToFace().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::label track ( const vector endPosition  )  [inline]

Calls the templated track with dummy TrackingData.

Reimplemented from Particle< ParticleType >.

Definition at line 46 of file ExactParticle.C.

Foam::scalar trackToFace ( const vector endPosition,
TrackingData &  td 
) [inline]

Track particle to a given position and returns 1.0 if the.

trajectory is completed without hitting a face otherwise stops at the face and returns the fraction of the trajectory completed. on entry 'stepFraction()' should be set to the fraction of the time-step at which the tracking starts.

Definition at line 58 of file ExactParticle.C.

References ExactParticle< ParticleType >::track().

Referenced by ExactParticle< ParticleType >::track().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::scalar trackToFace ( const vector endPosition  )  [inline]

Calls the templated trackToFace with dummy TrackingData.

Reimplemented from Particle< ParticleType >.

Definition at line 233 of file ExactParticle.C.


Friends And Related Function Documentation

friend class Cloud< ParticleType > [friend]

Reimplemented from Particle< ParticleType >.

Definition at line 63 of file ExactParticle.H.

Ostream& operator ( Ostream ,
const ExactParticle< ParticleType > &   
) [friend]


The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd