#include <lagrangian/indexedParticle.H>
Definition at line 52 of file indexedParticle.H.
Inheritance diagram for indexedParticle: Collaboration diagram for indexedParticle:Public Member Functions | |
| indexedParticle (const Cloud< indexedParticle > &c, const vector &position, const label celli, const label index=0) | |
| Construct from components. | |
| indexedParticle (const Cloud< indexedParticle > &c, Istream &is, bool readFields=true) | |
| Construct from Istream. | |
| indexedParticle (const indexedParticle &p) | |
| Construct as a copy. | |
| autoPtr< indexedParticle > | clone () const |
| Construct and return a clone. | |
| label | index () const |
| label & | index () |
| Public Member Functions inherited from Particle< indexedParticle > | |
| TypeName ("Particle") | |
| Runtime type information. | |
| Particle (const Cloud< indexedParticle > &, const vector &position, const label celli) | |
| Construct from components. | |
| Particle (const Cloud< indexedParticle > &, Istream &, bool readFields=true) | |
| Construct from Istream. | |
| Particle (const Particle &p) | |
| Construct as a copy. | |
| virtual | ~Particle () |
| Destructor. | |
| bool | inCell () const |
| Return true if particle is in cell. | |
| bool | inCell (const vector &position, const label celli, const scalar stepFraction) const |
| Return true if position is in cell i. | |
| const vector & | position () const |
| Return current particle position. | |
| vector & | position () |
| Return current particle position. | |
| label & | cell () |
| Return current cell particle is in. | |
| label | cell () const |
| Return current cell particle is in. | |
| label | face () const |
| Return current face particle is on otherwise -1. | |
| const Cloud< indexedParticle > & | cloud () const |
| Return reference to the particle cloud. | |
| bool | softImpact () const |
| Return the impact model to be used, soft or hard (default). | |
| scalar | currentTime () const |
| Return the particle current time. | |
| bool | onBoundary () const |
| Is the particle on the boundary/(or outside the domain)? | |
| label | patch (const label facei) const |
| Which patch is particle on. | |
| label | patchFace (const label patchi, const label facei) const |
| Which face of this patch is this particle on. | |
| scalar | wallImpactDistance (const vector &n) const |
| The nearest distance to a wall that. | |
| scalar & | stepFraction () |
| Return the fraction of time-step completed. | |
| scalar | stepFraction () const |
| Return the fraction of time-step completed. | |
| label | origProc () const |
| Return the originating processor id. | |
| label | origId () const |
| Return the particle id on originating processor. | |
| label | track (const vector &endPosition, TrackData &td) |
| Track particle to end of trajectory. | |
| label | track (const vector &endPosition) |
| Calls the templated track with dummy TrackData. | |
| scalar | trackToFace (const vector &endPosition, TrackData &td) |
| Track particle to a given position and returns 1.0 if the. | |
| scalar | trackToFace (const vector &endPosition) |
| Calls the templated trackToFace with dummy TrackData. | |
| label | faceInterpolation () const |
| Return the index of the face to be used in the interpolation. | |
| void | write (Ostream &os, bool writeFields) const |
| Write the particle data. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from Particle< indexedParticle > | |
| static void | readFields (Cloud< indexedParticle > &c) |
| Read the fields associated with the owner cloud. | |
| static void | writeFields (const Cloud< indexedParticle > &c) |
| Write the fields associated with the owner cloud. | |
| Static Public Attributes inherited from Particle< indexedParticle > | |
| static string | propHeader |
| String representation of properties. | |
| Protected Member Functions inherited from Particle< indexedParticle > | |
| scalar | lambda (const vector &from, const vector &to, const label facei, const scalar stepFraction) const |
| Return the 'lambda' value for the position, p, on the face,. | |
| scalar | lambda (const vector &from, const vector &to, const label facei) const |
| Return the 'lambda' value for the position, p, on the face,. | |
| void | findFaces (const vector &position, DynamicList< label > &faceList) const |
| Find the faces between position and cell centre. | |
| void | findFaces (const vector &position, const label celli, const scalar stepFraction, DynamicList< label > &faceList) const |
| Find the faces between position and cell centre. | |
| bool | hitPatch (const polyPatch &, TrackData &td, const label patchI) |
| Overridable function to handle the particle hitting a patch. | |
| void | hitPatch (const polyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a. | |
| void | hitWedgePatch (const wedgePolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a wedgePatch. | |
| void | hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a. | |
| void | hitCyclicPatch (const cyclicPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a cyclicPatch. | |
| void | hitProcessorPatch (const processorPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a. | |
| void | hitWallPatch (const wallPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a wallPatch. | |
| virtual void | transformPosition (const tensor &T) |
| Transform the position the particle. | |
| virtual void | transformProperties (const tensor &T) |
| Transform the physical properties of the particle. | |
| virtual void | transformProperties (const vector &separation) |
| Transform the physical properties of the particle. | |
| void | prepareForParallelTransfer (const label patchi, TrackData &td) |
| Convert global addressing to the processor patch. | |
| void | correctAfterParallelTransfer (const label patchi, TrackData &td) |
| Convert processor patch addressing to the global equivalents. | |
| Protected Attributes inherited from Particle< indexedParticle > | |
| const Cloud< indexedParticle > & | cloud_ |
| Reference to the particle cloud. | |
| vector | position_ |
| Position of particle. | |
| label | celli_ |
| Index of the cell it is in. | |
| label | facei_ |
| Face index if the particle is on a face otherwise -1. | |
| scalar | stepFraction_ |
| Fraction of time-step completed. | |
| label | origProc_ |
| Originating processor id. | |
| label | origId_ |
| Local particle id on originating processor. | |
|
inline |
Construct from components.
Definition at line 67 of file indexedParticle.H.
Referenced by indexedParticle::clone().
|
inline |
Construct from Istream.
Definition at line 80 of file indexedParticle.H.
|
inline |
Construct as a copy.
Definition at line 90 of file indexedParticle.H.
|
inline |
Construct and return a clone.
Reimplemented from Particle< indexedParticle >.
Definition at line 96 of file indexedParticle.H.
References indexedParticle::indexedParticle().
|
inline |
Definition at line 104 of file indexedParticle.H.
|
inline |
Definition at line 109 of file indexedParticle.H.
