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

trackedParticle Class Reference

Particle class that marks cells it passes through. Used to mark cells visited by feature edges. Uses ExactParticle tracking class so will work on concave cells. More...

#include <autoMesh/trackedParticle.H>


Detailed Description

Particle class that marks cells it passes through. Used to mark cells visited by feature edges. Uses ExactParticle tracking class so will work on concave cells.

Source files

Definition at line 54 of file trackedParticle.H.

Inheritance diagram for trackedParticle:
Collaboration diagram for trackedParticle:

List of all members.

Classes

class  trackData
 Class used to pass tracking data to the trackToFace function. More...

Public Member Functions

 trackedParticle (const Cloud< trackedParticle > &c, const vector &position, const label celli, const point &end, const label level, const label i, const label j)
 Construct from components.
 trackedParticle (const Cloud< trackedParticle > &c, Istream &is, bool readFields=true)
 Construct from Istream.
autoPtr< trackedParticle >  clone () const
 Construct and return a clone.
point &  end ()
 point to track to
label &  i ()
 transported label
label &  j ()
 transported label
bool  move (trackData &)
 Track all particles to their end point.
bool  hitPatch (const polyPatch &, trackedParticle::trackData &td, const label patchI)
 Overridable function to handle the particle hitting a patch.
bool  hitPatch (const polyPatch &, int &, const label patchI)
void  hitWedgePatch (const wedgePolyPatch &, trackedParticle::trackData &td)
 Overridable function to handle the particle hitting a wedge.
void  hitWedgePatch (const wedgePolyPatch &, int &)
void  hitSymmetryPatch (const symmetryPolyPatch &, trackedParticle::trackData &td)
 Overridable function to handle the particle hitting a.
void  hitSymmetryPatch (const symmetryPolyPatch &, int &)
void  hitCyclicPatch (const cyclicPolyPatch &, trackedParticle::trackData &td)
 Overridable function to handle the particle hitting a cyclic.
void  hitCyclicPatch (const cyclicPolyPatch &, int &)
void  hitProcessorPatch (const processorPolyPatch &, trackedParticle::trackData &td)
void  hitProcessorPatch (const processorPolyPatch &, int &)
void  hitWallPatch (const wallPolyPatch &, trackedParticle::trackData &td)
 Overridable function to handle the particle hitting a wallPatch.
void  hitWallPatch (const wallPolyPatch &, int &)
void  hitPatch (const polyPatch &, trackedParticle::trackData &td)
 Overridable function to handle the particle hitting a polyPatch.
void  hitPatch (const polyPatch &, int &)

Friends

class  Cloud< trackedParticle >
Ostream &  operator<< (Ostream &, const trackedParticle &)

Constructor & Destructor Documentation

trackedParticle ( const Cloud< trackedParticle > &   c,
const vector &   position,
const label   celli,
const point &   end,
const label   level,
const label   i,
const label   j  
)

Construct from components.

Definition at line 32 of file trackedParticle.C.

Referenced by trackedParticle::clone().

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

Construct from Istream.

Definition at line 52 of file trackedParticle.C.


Member Function Documentation

autoPtr<trackedParticle> clone (  ) const [inline]

Construct and return a clone.

Reimplemented from Particle< trackedParticle >.

Definition at line 137 of file trackedParticle.H.

References trackedParticle::trackedParticle().

point& end (  ) [inline]

point to track to

Definition at line 146 of file trackedParticle.H.

label& i (  ) [inline]

transported label

Definition at line 152 of file trackedParticle.H.

label& j (  ) [inline]

transported label

Definition at line 158 of file trackedParticle.H.

bool hitPatch ( const polyPatch &   ,
trackedParticle::trackData &   td,
const label   patchI  
)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 118 of file trackedParticle.C.

bool hitPatch ( const polyPatch &   ,
int &   ,
const label   patchI  
)

Definition at line 129 of file trackedParticle.C.

void hitWedgePatch ( const wedgePolyPatch &   ,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a wedge.

Definition at line 140 of file trackedParticle.C.

References trackedParticle::trackData::keepParticle.

void hitWedgePatch ( const wedgePolyPatch &   ,
int &    
)

Definition at line 151 of file trackedParticle.C.

void hitSymmetryPatch ( const symmetryPolyPatch &   ,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a.

symmetryPlane

Definition at line 159 of file trackedParticle.C.

References trackedParticle::trackData::keepParticle.

void hitSymmetryPatch ( const symmetryPolyPatch &   ,
int &    
)

Definition at line 170 of file trackedParticle.C.

void hitCyclicPatch ( const cyclicPolyPatch &   ,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a cyclic.

Definition at line 178 of file trackedParticle.C.

References trackedParticle::trackData::keepParticle.

void hitCyclicPatch ( const cyclicPolyPatch &   ,
int &    
)

Definition at line 189 of file trackedParticle.C.

void hitProcessorPatch ( const processorPolyPatch &   ,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a processorPatch

Definition at line 197 of file trackedParticle.C.

References trackedParticle::trackData::switchProcessor.

void hitProcessorPatch ( const processorPolyPatch &   ,
int &    
)

Definition at line 208 of file trackedParticle.C.

void hitWallPatch ( const wallPolyPatch &   wpp,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 216 of file trackedParticle.C.

References trackedParticle::trackData::keepParticle.

void hitWallPatch ( const wallPolyPatch &   wpp,
int &    
)

Definition at line 227 of file trackedParticle.C.

void hitPatch ( const polyPatch &   wpp,
trackedParticle::trackData &   td  
)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 235 of file trackedParticle.C.

References trackedParticle::trackData::keepParticle.

void hitPatch ( const polyPatch &   wpp,
int &    
)

Definition at line 246 of file trackedParticle.C.


Friends And Related Function Documentation

friend class Cloud< trackedParticle > [friend]

Definition at line 74 of file trackedParticle.H.

Ostream& operator<< ( Ostream &   ,
const trackedParticle &    
) [friend]

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