FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

ExactParticle< ParticleType > Class Template Reference

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

#include <autoMesh/ExactParticle.H>


Detailed Description

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

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

Definition at line 64 of file ExactParticle.H.

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 >
Ostream &  operator (Ostream &, const ExactParticle< ParticleType > &)

Constructor & Destructor Documentation

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

Construct from components.

Definition at line 78 of file ExactParticle.H.

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

Construct from Istream.

Definition at line 90 of file ExactParticle.H.

virtual ~ExactParticle (  ) [inline, virtual]

Definition at line 128 of file ExactParticle.H.


Member Function Documentation

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

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 33 of file ExactParticle.C.

Foam::label track ( const vector &   endPosition  )

Calls the templated track with dummy TrackingData.

Reimplemented from Particle< ParticleType >.

Definition at line 54 of file ExactParticle.C.

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

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 66 of file ExactParticle.C.

References Foam::abort(), polyMesh::boundaryMesh(), primitiveMesh::cellCentres(), primitiveMesh::cells(), PointHit< Point >::distance(), primitiveMesh::faceCentres(), polyMesh::faceNeighbour(), polyMesh::faceOwner(), polyMesh::faces(), Foam::FatalError, FatalErrorIn, forAll, PointHit< Point >::hit(), PointHit< Point >::hitPoint(), mesh, Foam::nl, p, and polyMesh::points().

Foam::scalar trackToFace ( const vector &   endPosition  )

Calls the templated trackToFace with dummy TrackingData.

Reimplemented from Particle< ParticleType >.

Definition at line 241 of file ExactParticle.C.


Friends And Related Function Documentation

friend class Cloud< ParticleType > [friend]

Reimplemented from Particle< ParticleType >.

Definition at line 71 of file ExactParticle.H.

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

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