trackedParticle Class Reference

Particle class that marks cells it passes through. Used to mark cells visited by feature edges. More...

Inheritance diagram for trackedParticle:
Collaboration diagram for trackedParticle:

Classes

class  iNew
 Factory class to read-construct particles used for. More...
 
class  trackingData
 Class used to pass tracking data to the trackToFace function. More...
 

Public Member Functions

 trackedParticle (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI, const point &end, const label level, const label i, const label j, const label k)
 Construct from components. More...
 
 trackedParticle (const polyMesh &mesh, Istream &is, bool readFields=true)
 Construct from Istream. More...
 
autoPtr< particleclone () const
 Construct and return a clone. More...
 
pointend ()
 point to track to More...
 
label i () const
 transported label More...
 
label & i ()
 transported label More...
 
label j () const
 transported label More...
 
label & j ()
 transported label More...
 
label k () const
 transported label More...
 
label & k ()
 transported label More...
 
bool move (trackingData &, const scalar)
 Track all particles to their end point. More...
 
bool hitPatch (const polyPatch &, trackingData &td, const label patchI, const scalar trackFraction, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a patch. More...
 
void hitWedgePatch (const wedgePolyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a wedge. More...
 
void hitSymmetryPlanePatch (const symmetryPlanePolyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a. More...
 
void hitSymmetryPatch (const symmetryPolyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a. More...
 
void hitCyclicPatch (const cyclicPolyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a cyclic. More...
 
void hitProcessorPatch (const processorPolyPatch &, trackingData &td)
 
void hitWallPatch (const wallPolyPatch &, trackingData &td, const tetIndices &)
 Overridable function to handle the particle hitting a wallPatch. More...
 
void hitPatch (const polyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a polyPatch. More...
 
void correctAfterParallelTransfer (const label, trackingData &)
 Convert processor patch addressing to the global equivalents. More...
 
- Public Member Functions inherited from particle< Type >
 TypeName ("particle")
 Runtime type information. More...
 
 particle (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
 Construct from components. More...
 
 particle (const polyMesh &mesh, const vector &position, const label cellI, bool doCellFacePt=true)
 Construct from components, tetFaceI_ and tetPtI_ are not. More...
 
 particle (const polyMesh &mesh, Istream &, bool readFields=true)
 Construct from Istream. More...
 
 particle (const particle &p)
 Construct as a copy. More...
 
 particle (const particle &p, const polyMesh &mesh)
 Construct as a copy with refernce to a new mesh. More...
 
virtual ~particle ()
 Destructor. More...
 
label getNewParticleID () const
 Get unique particle creation id. More...
 
const polyMeshmesh () const
 Return the mesh database. More...
 
const vectorposition () const
 Return current particle position. More...
 
vectorposition ()
 Return current particle position. More...
 
label & cell ()
 Return current cell particle is in. More...
 
label cell () const
 Return current cell particle is in. More...
 
label & tetFace ()
 Return current tet face particle is in. More...
 
label tetFace () const
 Return current tet face particle is in. More...
 
label & tetPt ()
 Return current tet face particle is in. More...
 
label tetPt () const
 Return current tet face particle is in. More...
 
tetIndices currentTetIndices () const
 Return the indices of the current tet that the. More...
 
tetPointRef currentTet () const
 Return the geometry of the current tet that the. More...
 
vector normal () const
 Return the normal of the tri on tetFaceI_ for the. More...
 
vector oldNormal () const
 Return the normal of the tri on tetFaceI_ for the. More...
 
label & face ()
 Return current face particle is on otherwise -1. More...
 
label face () const
 Return current face particle is on otherwise -1. More...
 
bool softImpact () const
 Return the impact model to be used, soft or hard (default). More...
 
scalar currentTime () const
 Return the particle current time. More...
 
void initCellFacePt ()
 Check the stored cell value (setting if necessary) and. More...
 
bool onBoundary () const
 Is the particle on the boundary/(or outside the domain)? More...
 
bool internalFace (const label faceI) const
 Is this global face an internal face? More...
 
bool boundaryFace (const label faceI) const
 Is this global face a boundary face? More...
 
label patch (const label faceI) const
 Which patch is particle on. More...
 
label patchFace (const label patchI, const label faceI) const
 Which face of this patch is this particle on. More...
 
scalar & stepFraction ()
 Return the fraction of time-step completed. More...
 
scalar stepFraction () const
 Return the fraction of time-step completed. More...
 
label origProc () const
 Return const access to the originating processor id. More...
 
label & origProc ()
 Return the originating processor id for manipulation. More...
 
label origId () const
 Return const access to the particle id on originating processor. More...
 
label & origId ()
 Return the particle id on originating processor for manipulation. More...
 
template<class TrackData >
label track (const vector &endPosition, TrackData &td)
 Track particle to end of trajectory. More...
 
template<class TrackData >
scalar trackToFace (const vector &endPosition, TrackData &td)
 Track particle to a given position and returns 1.0 if the. More...
 
label faceInterpolation () const
 Return the index of the face to be used in the interpolation. More...
 
virtual void transformProperties (const tensor &T)
 Transform the physical properties of the particle. More...
 
virtual void transformProperties (const vector &separation)
 Transform the physical properties of the particle. More...
 
virtual scalar wallImpactDistance (const vector &n) const
 The nearest distance to a wall that. More...
 
template<class TrackData >
void prepareForParallelTransfer (const label patchI, TrackData &td)
 Convert global addressing to the processor patch. More...
 
template<class TrackData >
void correctAfterParallelTransfer (const label patchI, TrackData &td)
 Convert processor patch addressing to the global equivalents. More...
 
void write (Ostream &os, bool writeFields) const
 Write the particle data. More...
 
template<class TrackData >
Foam::label track (const vector &endPosition, TrackData &td)
 
template<class TrackData >
Foam::scalar trackToFace (const vector &endPosition, TrackData &td)
 
- Public Member Functions inherited from DLListBase::link
 link ()
 Null construct. More...
 
bool registered () const
 Check if the link is registered with the DLListBase. More...
 
void deregister ()
 Deregister the link after removal. More...
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from particle< Type >
static string propertyList ()
 
template<class CloudType >
static void readFields (CloudType &c)
 Read the fields associated with the owner cloud. More...
 
template<class CloudType >
static void writeFields (const CloudType &c)
 Write the fields associated with the owner cloud. More...
 
- Public Attributes inherited from DLListBase::link
linkprev_
 Pointer to next entry in list. More...
 
linknext_
 
- Static Public Attributes inherited from particle< Type >
static string propertyList_ = Foam::particle::propertyList()
 String representation of properties. More...
 
static label particleCount_ = 0
 Cumulative particle counter - used to provode unique ID. More...
 
static const scalar trackingCorrectionTol = 1e-5
 Fraction of distance to tet centre to move a particle to. More...
 
static const scalar lambdaDistanceToleranceCoeff = 1e3*SMALL
 Fraction of the cell volume to use in determining tolerance values. More...
 
static const scalar minStepFractionTol = 1e5*SMALL
 Minimum stepFraction tolerance. More...
 
- Protected Member Functions inherited from particle< Type >
void findTris (const vector &position, DynamicList< label > &faceList, const tetPointRef &tet, const FixedList< vector, 4 > &tetAreas, const FixedList< label, 4 > &tetPlaneBasePtIs, const scalar tol) const
 Find the tet tri faces between position and tet centre. More...
 
scalar tetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
 Find the lambda value for the line to-from across the. More...
 
scalar movingTetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
 Find the lambda value for a moving tri face. More...
 
void tetNeighbour (label triI)
 Modify the tet owner data by crossing triI. More...
 
void crossEdgeConnectedFace (const label &cellI, label &tetFaceI, label &tetPtI, const edge &e)
 Cross the from the given face across the given edge of the. More...
 
template<class CloudType >
void hitWallFaces (const CloudType &td, const vector &from, const vector &to, scalar &lambdaMin, tetIndices &closestTetIs)
 
template<class TrackData >
void hitFace (TrackData &td)
 Overridable function to handle the particle hitting a face. More...
 
template<class TrackData >
bool hitPatch (const polyPatch &, TrackData &td, const label patchI, const scalar trackFraction, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitWedgePatch (const wedgePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wedgePatch. More...
 
template<class TrackData >
void hitSymmetryPlanePatch (const symmetryPlanePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitCyclicPatch (const cyclicPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a cyclicPatch. More...
 
template<class TrackData >
void hitCyclicAMIPatch (const cyclicAMIPolyPatch &, TrackData &td, const vector &direction)
 Overridable function to handle the particle hitting a cyclicAMIPatch. More...
 
template<class TrackData >
void hitProcessorPatch (const processorPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitWallPatch (const wallPolyPatch &, TrackData &td, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a wallPatch. More...
 
template<class TrackData >
void hitPatch (const polyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
- Protected Attributes inherited from particle< Type >
const polyMeshmesh_
 Reference to the polyMesh database. More...
 
vector position_
 Position of particle. More...
 
label cellI_
 Index of the cell it is in. More...
 
label faceI_
 Face index if the particle is on a face otherwise -1. More...
 
scalar stepFraction_
 Fraction of time-step completed. More...
 
label tetFaceI_
 Index of the face that owns the decomposed tet that the. More...
 
label tetPtI_
 Index of the point on the face that defines the decomposed. More...
 
label origProc_
 Originating processor id. More...
 
label origId_
 Local particle id on originating processor. More...
 

Detailed Description

Particle class that marks cells it passes through. Used to mark cells visited by feature edges.

Source files

Definition at line 52 of file trackedParticle.H.

Constructor & Destructor Documentation

trackedParticle ( const polyMesh mesh,
const vector position,
const label  cellI,
const label  tetFaceI,
const label  tetPtI,
const point end,
const label  level,
const label  i,
const label  j,
const label  k 
)

Construct from components.

Definition at line 32 of file trackedParticle.C.

Referenced by trackedParticle::clone(), and trackedParticle::iNew::operator()().

Here is the caller graph for this function:

trackedParticle ( const polyMesh mesh,
Istream is,
bool  readFields = true 
)

Construct from Istream.

Definition at line 55 of file trackedParticle.C.

References IOstream::check(), IOstream::format(), and Istream::read().

Here is the call graph for this function:

Member Function Documentation

autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 134 of file trackedParticle.H.

References trackedParticle::trackedParticle().

Here is the call graph for this function:

point& end ( )
inline

point to track to

Definition at line 165 of file trackedParticle.H.

label i ( ) const
inline

transported label

Definition at line 171 of file trackedParticle.H.

label& i ( )
inline

transported label

Definition at line 177 of file trackedParticle.H.

label j ( ) const
inline

transported label

Definition at line 183 of file trackedParticle.H.

label& j ( )
inline

transported label

Definition at line 189 of file trackedParticle.H.

label k ( ) const
inline

transported label

Definition at line 195 of file trackedParticle.H.

label& k ( )
inline

transported label

Definition at line 201 of file trackedParticle.H.

bool move ( trackingData td,
const scalar  trackTime 
)

Track all particles to their end point.

Definition at line 96 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle, Foam::max(), trackedParticle::trackingData::maxLevel_, Foam::min(), and particle< Type >::TrackingData< CloudType >::switchProcessor.

Here is the call graph for this function:

bool hitPatch ( const polyPatch ,
trackingData td,
const label  patchI,
const scalar  trackFraction,
const tetIndices tetIs 
)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 139 of file trackedParticle.C.

void hitWedgePatch ( const wedgePolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a wedge.

Definition at line 152 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void hitSymmetryPlanePatch ( const symmetryPlanePolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a.

symmetry plane

Definition at line 163 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void hitSymmetryPatch ( const symmetryPolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a.

symmetry patch

Definition at line 174 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void hitCyclicPatch ( const cyclicPolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a cyclic.

Definition at line 185 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void hitProcessorPatch ( const processorPolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a processorPatch

Definition at line 196 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::switchProcessor.

void hitWallPatch ( const wallPolyPatch wpp,
trackingData td,
const tetIndices  
)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 207 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void hitPatch ( const polyPatch wpp,
trackingData td 
)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 219 of file trackedParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void correctAfterParallelTransfer ( const label  patchI,
trackingData td 
)

Convert processor patch addressing to the global equivalents.

and set the cellI to the face-neighbour

Definition at line 230 of file trackedParticle.C.

References trackedParticle::trackingData::featureEdgeVisited_, and k.

Friends And Related Function Documentation

friend class Cloud< trackedParticle >
friend

Definition at line 76 of file trackedParticle.H.

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

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