Simple solid spherical particle class with one-way coupling with the continuous phase. More...
#include <solidParticle/solidParticle.H>
Simple solid spherical particle class with one-way coupling with the continuous phase.
Definition at line 58 of file solidParticle.H.
Classes | |
class | trackData |
Class used to pass tracking data to the trackToFace function. More... |
Public Member Functions | |
solidParticle (const Cloud< solidParticle > &c, const vector &position, const label celli, const scalar m, const vector &U) | |
Construct from components. | |
solidParticle (const Cloud< solidParticle > &c, Istream &is, bool readFields=true) | |
Construct from Istream. | |
autoPtr< solidParticle > | clone () const |
Construct and return a clone. | |
scalar | d () const |
Return diameter. | |
const vector & | U () const |
Return velocity. | |
scalar | wallImpactDistance (const vector &n) const |
The nearest distance to a wall that. | |
bool | move (trackData &) |
Move. | |
bool | hitPatch (const polyPatch &, solidParticle::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 | hitProcessorPatch (const processorPolyPatch &, solidParticle::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 &, solidParticle::trackData &td) |
Overridable function to handle the particle hitting a wallPatch. | |
void | hitWallPatch (const wallPolyPatch &, int &) |
void | hitPatch (const polyPatch &, solidParticle::trackData &td) |
Overridable function to handle the particle hitting a polyPatch. | |
void | hitPatch (const polyPatch &, int &) |
void | transformProperties (const tensor &T) |
Transform the physical properties of the particle. | |
void | transformProperties (const vector &separation) |
Transform the physical properties of the particle. | |
![]() | |
TypeName ("Particle") | |
Runtime type information. | |
Particle (const Cloud< solidParticle > &, const vector &position, const label celli) | |
Construct from components. | |
Particle (const Cloud< solidParticle > &, 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< solidParticle > & | 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. | |
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. |
Static Public Member Functions | |
static void | readFields (Cloud< solidParticle > &c) |
Read the fields associated with the owner cloud. | |
static void | writeFields (const Cloud< solidParticle > &c) |
Write the fields associated with the owner cloud. |
Friends | |
class | Cloud< solidParticle > |
Ostream & | operator<< (Ostream &, const solidParticle &) |
Additional Inherited Members | |
![]() | |
static string | propHeader |
String representation of properties. | |
![]() | |
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. | |
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. | |
![]() | |
const Cloud< solidParticle > & | 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 46 of file solidParticleI.H.
Referenced by solidParticle::clone().
solidParticle | ( | const Cloud< solidParticle > & | c, |
Istream & | is, | ||
bool | readFields = true |
||
) |
|
inline |
Construct and return a clone.
Reimplemented from Particle< solidParticle >.
Definition at line 144 of file solidParticle.H.
References solidParticle::solidParticle().
|
inline |
Return diameter.
Definition at line 91 of file solidParticleI.H.
Referenced by solidParticle::readFields().
|
inline |
Return velocity.
Definition at line 101 of file solidParticleI.H.
Referenced by solidParticle::readFields().
|
inline |
The nearest distance to a wall that.
the particle can be in the n direction
Reimplemented from Particle< solidParticle >.
Definition at line 96 of file solidParticleI.H.
bool move | ( | solidParticle::trackData & | td | ) |
Move.
Definition at line 30 of file solidParticle.C.
References polyMesh::boundaryMesh(), Particle< solidParticle >::cell(), Particle< solidParticle >::cloud(), TimeState::deltaT(), Foam::endl(), Particle< solidParticle >::face(), solidParticle::trackData::g(), Foam::Info, interpolationCellPoint< Type >::interpolate(), solidParticle::trackData::keepParticle, Foam::mag(), magUr, mesh, Foam::min(), solidParticle::trackData::nuInterp(), Particle< solidParticle >::onBoundary(), Particle< solidParticle >::patch(), Cloud< ParticleType >::pMesh(), Particle< solidParticle >::position(), Foam::pow(), Foam::Re(), solidParticle::trackData::rhoInterp(), solidParticleCloud::rhop(), solidParticle::trackData::spc(), Particle< solidParticle >::stepFraction(), solidParticle::trackData::switchProcessor, objectRegistry::time(), Time::timeName(), Particle< solidParticle >::trackToFace(), solidParticle::trackData::UInterp(), and dimensioned< Type >::value().
bool hitPatch | ( | const polyPatch & | , |
solidParticle::trackData & | td, | ||
const label | patchI | ||
) |
Overridable function to handle the particle hitting a patch.
Executed before other patch-hitting functions
Definition at line 98 of file solidParticle.C.
bool hitPatch | ( | const polyPatch & | p, |
int & | td, | ||
const label | patchI | ||
) |
Overridable function to handle the particle hitting a patch.
Executed before other patch-hitting functions without trackData
Definition at line 109 of file solidParticle.C.
void hitProcessorPatch | ( | const processorPolyPatch & | , |
solidParticle::trackData & | td | ||
) |
Overridable function to handle the particle hitting a.
processorPatch
Definition at line 120 of file solidParticle.C.
References solidParticle::trackData::switchProcessor.
void hitProcessorPatch | ( | const processorPolyPatch & | , |
int & | |||
) |
Overridable function to handle the particle hitting a.
processorPatch without trackData
Definition at line 130 of file solidParticle.C.
void hitWallPatch | ( | const wallPolyPatch & | wpp, |
solidParticle::trackData & | td | ||
) |
Overridable function to handle the particle hitting a wallPatch.
Definition at line 138 of file solidParticle.C.
References solidParticleCloud::e(), polyPatch::faceAreas(), Foam::mag(), solidParticleCloud::mu(), solidParticle::trackData::spc(), and polyPatch::whichFace().
void hitWallPatch | ( | const wallPolyPatch & | , |
int & | |||
) |
Overridable function to handle the particle hitting a wallPatch without trackData
Definition at line 159 of file solidParticle.C.
void hitPatch | ( | const polyPatch & | , |
solidParticle::trackData & | td | ||
) |
Overridable function to handle the particle hitting a polyPatch.
Definition at line 167 of file solidParticle.C.
References solidParticle::trackData::keepParticle.
void hitPatch | ( | const polyPatch & | , |
int & | |||
) |
Overridable function to handle the particle hitting a polyPatch without trackData
Definition at line 177 of file solidParticle.C.
|
virtual |
Transform the physical properties of the particle.
according to the given transformation tensor
Reimplemented from Particle< solidParticle >.
Definition at line 184 of file solidParticle.C.
References Foam::transform(), and Particle< ParticleType >::transformProperties().
|
virtual |
Transform the physical properties of the particle.
according to the given separation vector
Reimplemented from Particle< solidParticle >.
Definition at line 191 of file solidParticle.C.
References Particle< ParticleType >::transformProperties().
|
static |
Read the fields associated with the owner cloud.
Reimplemented from Particle< solidParticle >.
Definition at line 62 of file solidParticleIO.C.
References Cloud< ParticleType >::checkFieldIOobject(), solidParticle::d(), Cloud< ParticleType >::fieldIOobject(), forAllIter, IOobject::MUST_READ, p, Cloud< ParticleType >::size(), and solidParticle::U().
|
static |
Write the fields associated with the owner cloud.
Reimplemented from Particle< solidParticle >.
Definition at line 86 of file solidParticleIO.C.
References d, Cloud< ParticleType >::fieldIOobject(), forAllConstIter, IOobject::NO_READ, p, Cloud< ParticleType >::size(), U, and Particle< ParticleType >::writeFields().
|
friend |
Definition at line 73 of file solidParticle.H.
|
friend |