Particle class that marks cells it passes through. Used to mark cells visited by feature edges. More...
Classes | |
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, label &nLocateBoundaryHits, const point &end, const label level, const label i, const label j, const label k) | |
Construct from a position and a cell, searching for the rest of the. More... | |
trackedParticle (Istream &is, bool readFields=true) | |
Construct from Istream. More... | |
autoPtr< particle > | clone () const |
Construct and return a clone. More... | |
point & | start () |
Point to track from. More... | |
point & | end () |
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 (Cloud< trackedParticle > &, trackingData &) |
Track all particles to their end point. More... | |
void | hitWedgePatch (Cloud< trackedParticle > &, trackingData &) |
Overridable function to handle the particle hitting a wedge. More... | |
void | hitSymmetryPlanePatch (Cloud< trackedParticle > &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
void | hitSymmetryPatch (Cloud< trackedParticle > &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
void | hitCyclicPatch (Cloud< trackedParticle > &, trackingData &) |
Overridable function to handle the particle hitting a cyclic. More... | |
void | hitWallPatch (Cloud< trackedParticle > &, trackingData &) |
Overridable function to handle the particle hitting a wallPatch. More... | |
void | correctAfterParallelTransfer (Cloud< trackedParticle > &, trackingData &) |
Do corrections to the particle and tracking data following a. More... | |
Public Member Functions inherited from particle | |
TypeName ("particle") | |
Runtime type information. More... | |
particle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const label facei) | |
Construct from components. More... | |
particle (const polyMesh &mesh, const vector &position, const label celli, label &nLocateBoundaryHits) | |
Construct from a position and a cell, searching for the rest of the. More... | |
particle (Istream &, bool readFields=true) | |
Construct from Istream. More... | |
particle (const particle &p) | |
Construct as a copy. More... | |
virtual | ~particle () |
Destructor. More... | |
label | getNewParticleIndex () const |
Get unique particle creation id. More... | |
const barycentric & | coordinates () const |
Return current particle coordinates. More... | |
label | cell () const |
Return current cell particle is in. More... | |
label | tetFace () const |
Return current tet face particle is in. More... | |
label | tetPt () const |
Return current tet face particle is in. More... | |
label | face () const |
Return current face particle is on otherwise -1. More... | |
label & | face () |
Return current face particle is on otherwise -1. More... | |
scalar | stepFraction () const |
Return the fraction of time-step completed. More... | |
scalar & | stepFraction () |
Return the fraction of time-step completed. More... | |
label | origProc () const |
Return the originating processor ID. More... | |
label & | origProc () |
Return the originating processor ID. More... | |
label | origId () const |
Return the particle ID on the originating processor. More... | |
label & | origId () |
Return the particle ID on the originating processor. More... | |
tetIndices | currentTetIndices (const polyMesh &mesh) const |
Return the indices of the current tet that the. More... | |
barycentricTensor | currentTetTransform (const polyMesh &mesh) const |
Return the current tet transformation tensor. More... | |
vector | normal (const polyMesh &mesh) const |
Return the normal of the tri on tetFacei_ for the. More... | |
bool | onFace () const |
Is the particle on a face? More... | |
bool | onInternalFace (const polyMesh &mesh) const |
Is the particle on an internal face? More... | |
bool | onBoundaryFace (const polyMesh &mesh) const |
Is the particle on a boundary face? More... | |
label | patch (const polyMesh &mesh) const |
Return the index of patch that the particle is on. More... | |
vector | position (const polyMesh &mesh) const |
Return current particle position. More... | |
void | reset (const scalar stepFraction) |
Set the step fraction and clear the behind data in preparation. More... | |
bool | locate (const polyMesh &mesh, const vector &position, label celli) |
Locate the particle at the given position. More... | |
scalar | track (const polyMesh &mesh, const vector &displacement, const scalar fraction) |
Track along the displacement for a given fraction of the overall. More... | |
scalar | trackToCell (const polyMesh &mesh, const vector &displacement, const scalar fraction) |
As particle::track, but stops when a new cell is reached. More... | |
scalar | trackToFace (const polyMesh &mesh, const vector &displacement, const scalar fraction) |
As particle::track, but stops when a face is hit. More... | |
scalar | trackToTri (const polyMesh &mesh, const vector &displacement, const scalar fraction, label &tetTriI) |
As particle::trackToFace, but stops when a tet triangle is hit. More... | |
scalar | trackToStationaryTri (const polyMesh &mesh, const vector &displacement, const scalar fraction, label &tetTriI) |
As particle::trackToTri, but for stationary meshes. More... | |
scalar | trackToMovingTri (const polyMesh &mesh, const vector &displacement, const scalar fraction, label &tetTriI) |
As particle::trackToTri, but for moving meshes. More... | |
template<class TrackCloudType > | |
void | hitFace (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td) |
Hit the current face. If the current face is internal than this. More... | |
template<class TrackCloudType > | |
scalar | trackToAndHitFace (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td) |
Convenience function. Combines trackToFace and hitFace. More... | |
vector | deviationFromMeshCentre (const polyMesh &mesh) const |
Get the displacement from the mesh centre. Used to correct the. More... | |
void | patchData (const polyMesh &mesh, vector &normal, vector &displacement) const |
Get the normal and displacement of the current patch location. More... | |
virtual void | transformProperties (const transformer &) |
Transform the physical properties of the particle. More... | |
template<class TrackCloudType > | |
void | prepareForParallelTransfer (TrackCloudType &, trackingData &) |
Make changes prior to a parallel transfer. Runs either. More... | |
template<class TrackCloudType > | |
void | correctAfterParallelTransfer (TrackCloudType &, trackingData &) |
Make changes following a parallel transfer. Runs either. More... | |
void | prepareForProcessorTransfer (trackingData &td) |
Make changes prior to a transfer across a processor boundary. More... | |
void | correctAfterProcessorTransfer (trackingData &td) |
Make changes following a transfer across a processor boundary. More... | |
void | prepareForNonConformalCyclicTransfer (const polyMesh &mesh, const label sendToPatch, const label sendToPatchFace, const vector &sendToPosition) |
Make changes prior to a transfer across a non conformal cyclic. More... | |
void | correctAfterNonConformalCyclicTransfer (const polyMesh &mesh, const label sendToPatch, labelList &patchNLocateBoundaryHits) |
Make changes following a transfer across a non conformal cyclic. More... | |
template<class TrackCloudType > | |
bool | hitPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a patch. More... | |
template<class TrackCloudType > | |
void | hitWedgePatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a wedgePatch. More... | |
template<class TrackCloudType > | |
void | hitSymmetryPlanePatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
template<class TrackCloudType > | |
void | hitSymmetryPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
template<class TrackCloudType > | |
void | hitCyclicPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
template<class TrackCloudType > | |
bool | hitNonConformalCyclicPatch (const vector &displacement, const scalar fraction, const label patchi, TrackCloudType &cloud, trackingData &td) |
Overridable function to handle the particle hitting an. More... | |
template<class TrackCloudType > | |
void | hitProcessorPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a. More... | |
template<class TrackCloudType > | |
void | hitWallPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a wallPatch. More... | |
template<class TrackCloudType > | |
void | hitBasicPatch (TrackCloudType &, trackingData &) |
Overridable function to handle the particle hitting a basic. More... | |
void | prepareForInteractionListReferral (const polyMesh &mesh, const transformer &transform) |
Break the topology and store the cartesian position so that the. More... | |
void | correctAfterInteractionListReferral (const polyMesh &mesh, const label celli) |
Correct the topology after referral. Locates the particle. More... | |
label | procTetPt (const polyMesh &mesh, const polyMesh &procMesh, const label procCell, const label procTetFace) const |
Return the tet point appropriate for decomposition or. More... | |
void | writePosition (Ostream &) const |
Write the particle position and cell. More... | |
template<class TrackCloudType > | |
Foam::scalar | trackToAndHitFace (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td) |
Static Public Member Functions | |
static autoPtr< trackedParticle > | New (Istream &is) |
Construct from Istream and return. More... | |
Static Public Member Functions inherited from particle | |
static string | propertyList () |
static autoPtr< particle > | New (Istream &is) |
Construct from Istream and return. More... | |
template<class TrackCloudType > | |
static void | readFields (TrackCloudType &c) |
Read the fields associated with the owner cloud. More... | |
template<class TrackCloudType > | |
static void | writeFields (const TrackCloudType &c) |
Write the fields associated with the owner cloud. More... | |
Friends | |
class | Cloud< trackedParticle > |
Ostream & | operator<< (Ostream &, const trackedParticle &) |
Additional Inherited Members | |
Static Public Attributes inherited from particle | |
static string | propertyList_ = Foam::particle::propertyList() |
String representation of properties. More... | |
static label | particleCount_ = 0 |
Cumulative particle counter - used to provide unique ID. More... | |
Particle class that marks cells it passes through. Used to mark cells visited by feature edges.
Definition at line 58 of file trackedParticle.H.
trackedParticle | ( | const polyMesh & | mesh, |
const vector & | position, | ||
const label | celli, | ||
label & | nLocateBoundaryHits, | ||
const point & | end, | ||
const label | level, | ||
const label | i, | ||
const label | j, | ||
const label | k | ||
) |
Construct from a position and a cell, searching for the rest of the.
required topology
Definition at line 31 of file trackedParticle.C.
Referenced by trackedParticle::clone(), and trackedParticle::New().
trackedParticle | ( | Istream & | is, |
bool | readFields = true |
||
) |
Construct from Istream.
Definition at line 54 of file trackedParticle.C.
References IOstream::ASCII, IOstream::check(), IOstream::format(), Istream::read(), particle::readFields(), and Foam::readLabel().
Construct and return a clone.
Reimplemented from particle.
Definition at line 141 of file trackedParticle.H.
References trackedParticle::trackedParticle().
|
inlinestatic |
Construct from Istream and return.
Definition at line 147 of file trackedParticle.H.
References trackedParticle::trackedParticle().
|
inline |
Point to track from.
Definition at line 156 of file trackedParticle.H.
|
inline |
Point to track to.
Definition at line 162 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 168 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 174 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 180 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 186 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 192 of file trackedParticle.H.
|
inline |
Transported label.
Definition at line 198 of file trackedParticle.H.
bool move | ( | Cloud< trackedParticle > & | cloud, |
trackingData & | td | ||
) |
Track all particles to their end point.
Definition at line 90 of file trackedParticle.C.
References f(), if(), particle::trackingData::keepParticle, Foam::max(), trackedParticle::trackingData::maxLevel_, trackedParticle::trackingData::maxTrackLen_, particle::trackingData::mesh, s(), and particle::trackingData::sendToProc.
void hitWedgePatch | ( | Cloud< trackedParticle > & | , |
trackingData & | td | ||
) |
Overridable function to handle the particle hitting a wedge.
Definition at line 126 of file trackedParticle.C.
References particle::trackingData::keepParticle.
void hitSymmetryPlanePatch | ( | Cloud< trackedParticle > & | , |
trackingData & | td | ||
) |
Overridable function to handle the particle hitting a.
symmetry plane
Definition at line 137 of file trackedParticle.C.
References particle::trackingData::keepParticle.
void hitSymmetryPatch | ( | Cloud< trackedParticle > & | , |
trackingData & | td | ||
) |
Overridable function to handle the particle hitting a.
symmetry patch
Definition at line 148 of file trackedParticle.C.
References particle::trackingData::keepParticle.
void hitCyclicPatch | ( | Cloud< trackedParticle > & | , |
trackingData & | td | ||
) |
Overridable function to handle the particle hitting a cyclic.
Definition at line 159 of file trackedParticle.C.
References particle::trackingData::keepParticle.
void hitWallPatch | ( | Cloud< trackedParticle > & | , |
trackingData & | td | ||
) |
Overridable function to handle the particle hitting a wallPatch.
Definition at line 170 of file trackedParticle.C.
References particle::trackingData::keepParticle.
void correctAfterParallelTransfer | ( | Cloud< trackedParticle > & | cloud, |
trackingData & | td | ||
) |
Do corrections to the particle and tracking data following a.
transfer between processors
Definition at line 181 of file trackedParticle.C.
References particle::correctAfterParallelTransfer(), trackedParticle::trackingData::featureEdgeVisited_, and k.
|
friend |
Definition at line 80 of file trackedParticle.H.
|
friend |