#include <lagrangianIntermediate/basicKinematicParcel.H>
Definition at line 49 of file basicKinematicParcel.H.
Inheritance diagram for basicKinematicParcel: Collaboration diagram for basicKinematicParcel:Public Member Functions | |
| TypeName ("basicKinematicParcel") | |
| Run-time type information. | |
| basicKinematicParcel (KinematicCloud< basicKinematicParcel > &owner, const vector &position, const label cellI) | |
| Construct from owner, position, and cloud owner. | |
| basicKinematicParcel (KinematicCloud< basicKinematicParcel > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const constantProperties &constProps) | |
| Construct from components. | |
| basicKinematicParcel (const Cloud< basicKinematicParcel > &c, Istream &is, bool readFields=true) | |
| Construct from Istream. | |
| basicKinematicParcel (const basicKinematicParcel &p) | |
| Construct as a copy. | |
| autoPtr< basicKinematicParcel > | clone () const |
| Construct and return a clone. | |
| virtual | ~basicKinematicParcel () |
| Destructor. | |
| Public Member Functions inherited from KinematicParcel< basicKinematicParcel > | |
| TypeName ("KinematicParcel") | |
| Runtime type information. | |
| KinematicParcel (KinematicCloud< basicKinematicParcel > &owner, const vector &position, const label cellI) | |
| Construct from owner, position, and cloud owner. | |
| KinematicParcel (KinematicCloud< basicKinematicParcel > &owner, const vector &position, const label cellI, const label typeId, const scalar nParticle0, const scalar d0, const vector &U0, const constantProperties &constProps) | |
| Construct from components. | |
| KinematicParcel (const Cloud< basicKinematicParcel > &c, Istream &is, bool readFields=true) | |
| Construct from Istream. | |
| KinematicParcel (const KinematicParcel &p) | |
| Construct as a copy. | |
| bool | active () const |
| Return const access to active flag. | |
| bool & | active () |
| Return const access to active flag. | |
| label | typeId () const |
| Return const access to type id. | |
| label | typeId () |
| Return access to type id. | |
| scalar | nParticle () const |
| Return const access to number of particles. | |
| scalar & | nParticle () |
| Return access to number of particles. | |
| scalar | d () const |
| Return const access to diameter. | |
| scalar & | d () |
| Return access to diameter. | |
| const vector & | U () const |
| Return const access to velocity. | |
| vector & | U () |
| Return access to velocity. | |
| scalar | rho () const |
| Return const access to density. | |
| scalar & | rho () |
| Return access to density. | |
| scalar | tTurb () const |
| Return const access to time spent in turbulent eddy. | |
| scalar & | tTurb () |
| Return access to time spent in turbulent eddy. | |
| const vector & | UTurb () const |
| Return const access to turbulent velocity fluctuation. | |
| vector & | UTurb () |
| Return access to turbulent velocity fluctuation. | |
| scalar | wallImpactDistance (const vector &n) const |
| The nearest distance to a wall that. | |
| label | faceInterpolation () const |
| Return the index of the face to be used in the interpolation. | |
| scalar | massCell (const label cellI) const |
| Cell owner mass. | |
| scalar | mass () const |
| Particle mass. | |
| scalar | volume () const |
| Particle volume. | |
| scalar | volume (const scalar d) const |
| Particle volume for a given diameter. | |
| scalar | areaP () const |
| Particle projected area. | |
| scalar | areaP (const scalar d) const |
| Projected area for given diameter. | |
| scalar | areaS () const |
| Particle surface area. | |
| scalar | areaS (const scalar d) const |
| Surface area for given diameter. | |
| scalar | Re (const vector &U, const scalar d, const scalar rhoc, const scalar muc) const |
| Reynolds number. | |
| void | setCellValues (TrackData &td, const scalar dt, const label cellI) |
| Set cell values. | |
| void | cellValueSourceCorrection (TrackData &td, const scalar dt, const label cellI) |
| Correct cell values using latest transfer information. | |
| void | calc (TrackData &td, const scalar dt, const label cellI) |
| Update parcel properties over the time interval. | |
| bool | move (TrackData &td) |
| Move the parcel. | |
| bool | hitPatch (const polyPatch &p, TrackData &td, const label patchI) |
| Overridable function to handle the particle hitting a patch. | |
| bool | hitPatch (const polyPatch &p, int &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 polyPatch. | |
| void | hitPatch (const polyPatch &, int &) |
| void | hitProcessorPatch (const processorPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a. | |
| void | hitProcessorPatch (const processorPolyPatch &, int &) |
| Overridable function to handle the particle hitting a. | |
| void | hitWallPatch (const wallPolyPatch &, TrackData &td) |
| Overridable function to handle the particle hitting a wallPatch. | |
| void | hitWallPatch (const wallPolyPatch &, int &) |
| Overridable function to handle the particle hitting a wallPatch. | |
| void | transformProperties (const tensor &T) |
| Transform the physical properties of the particle. | |
| void | transformProperties (const vector &separation) |
| Transform the physical properties of the particle. | |
| Public Member Functions inherited from Particle< basicKinematicParcel > | |
| TypeName ("Particle") | |
| Runtime type information. | |
| Particle (const Cloud< basicKinematicParcel > &, const vector &position, const label celli) | |
| Construct from components. | |
| Particle (const Cloud< basicKinematicParcel > &, 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 < basicKinematicParcel > & | 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 & | 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. | |
| void | write (Ostream &os, bool writeFields) const |
| Write the particle data. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from KinematicParcel< basicKinematicParcel > | |
| static void | readFields (Cloud< basicKinematicParcel > &c) |
| Read. | |
| static void | writeFields (const Cloud< basicKinematicParcel > &c) |
| Write. | |
| Static Public Attributes inherited from KinematicParcel< basicKinematicParcel > | |
| static string | propHeader |
| String representation of properties. | |
| Static Public Attributes inherited from Particle< basicKinematicParcel > | |
| Protected Member Functions inherited from KinematicParcel< basicKinematicParcel > | |
| const vector | calcVelocity (TrackData &td, const scalar dt, const label cellI, const scalar Re, const scalar mu, const scalar d, const vector &U, const scalar rho, const scalar mass, const vector &Su, vector &dUTrans) const |
| Calculate new particle velocity. | |
| Protected Member Functions inherited from Particle< basicKinematicParcel > | |
| 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. | |
| 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. | |
| virtual void | transformPosition (const tensor &T) |
| Transform the position 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 KinematicParcel< basicKinematicParcel > | |
| bool | active_ |
| Active flag - tracking inactive when active = false. | |
| label | typeId_ |
| Parcel type id. | |
| scalar | nParticle_ |
| Number of particles in Parcel. | |
| scalar | d_ |
| Diameter [m]. | |
| vector | U_ |
| Velocity of Parcel [m/s]. | |
| scalar | rho_ |
| Density [kg/m3]. | |
| scalar | tTurb_ |
| Time spent in turbulent eddy [s]. | |
| vector | UTurb_ |
| Turbulent velocity fluctuation [m/s]. | |
| scalar | rhoc_ |
| Density [kg/m3]. | |
| vector | Uc_ |
| Velocity [m/s]. | |
| scalar | muc_ |
| Viscosity [Pa.s]. | |
| Protected Attributes inherited from Particle< basicKinematicParcel > | |
| const Cloud < basicKinematicParcel > & | 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. | |
| basicKinematicParcel | ( | KinematicCloud< basicKinematicParcel > & | owner, |
| const vector & | position, | ||
| const label | cellI | ||
| ) |
Construct from owner, position, and cloud owner.
Other properties initialised as null
Definition at line 41 of file basicKinematicParcel.C.
Referenced by basicKinematicParcel::clone().
| basicKinematicParcel | ( | KinematicCloud< basicKinematicParcel > & | owner, |
| const vector & | position, | ||
| const label | cellI, | ||
| const label | typeId, | ||
| const scalar | nParticle0, | ||
| const scalar | d0, | ||
| const vector & | U0, | ||
| const constantProperties & | constProps | ||
| ) |
Construct from components.
Definition at line 52 of file basicKinematicParcel.C.
| basicKinematicParcel | ( | const Cloud< basicKinematicParcel > & | c, |
| Istream & | is, | ||
| bool | readFields = true |
||
| ) |
Construct from Istream.
Definition at line 78 of file basicKinematicParcel.C.
| basicKinematicParcel | ( | const basicKinematicParcel & | p | ) |
Construct as a copy.
Definition at line 89 of file basicKinematicParcel.C.
|
virtual |
Destructor.
Definition at line 99 of file basicKinematicParcel.C.
| TypeName | ( | "basicKinematicParcel" | ) |
Run-time type information.
|
inline |
Construct and return a clone.
Reimplemented from KinematicParcel< basicKinematicParcel >.
Definition at line 96 of file basicKinematicParcel.H.
References basicKinematicParcel::basicKinematicParcel().
