solidParticle Class Reference

Simple solid spherical particle class with one-way coupling with the continuous phase. More...

Inheritance diagram for solidParticle:
Collaboration diagram for solidParticle:

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

 solidParticle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti, const scalar d, const vector &U)
 Construct from components. More...
 
 solidParticle (const polyMesh &mesh, Istream &is, bool readFields=true)
 Construct from Istream. More...
 
virtual autoPtr< particleclone () const
 Construct and return a clone. More...
 
scalar d () const
 Return diameter. More...
 
const vectorU () const
 Return velocity. More...
 
bool move (solidParticleCloud &, trackingData &, const scalar)
 Move. More...
 
bool hitPatch (solidParticleCloud &cloud, trackingData &td)
 Overridable function to handle the particle hitting a patch. More...
 
void hitProcessorPatch (solidParticleCloud &cloud, trackingData &td)
 Overridable function to handle the particle hitting a. More...
 
void hitWallPatch (solidParticleCloud &cloud, trackingData &td)
 Overridable function to handle the particle hitting a wallPatch. More...
 
virtual void transformProperties (const transformer &)
 Transform the physical properties of the particle. More...
 
- Public Member Functions inherited from particle< Type >
 TypeName ("particle")
 Runtime type information. More...
 
 particle (const polyMesh &mesh, const barycentric &coordinates, const label celli, const label tetFacei, const label tetPti)
 Construct from components. More...
 
 particle (const polyMesh &mesh, const vector &position, const label celli)
 Construct from a position and a cell, searching for the rest of the. 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 references 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 barycentriccoordinates () 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...
 
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...
 
labelorigProc ()
 Return the originating processor ID. More...
 
label origId () const
 Return the particle ID on the originating processor. More...
 
labelorigId ()
 Return the particle ID on the originating processor. More...
 
Pair< scalar > stepFractionSpan () const
 Return the step fraction change within the overall time-step. More...
 
scalar currentTimeFraction () const
 Return the current fraction within the timestep. This differs. More...
 
tetIndices currentTetIndices () const
 Return the indices of the current tet that the. More...
 
barycentricTensor currentTetTransform () const
 Return the current tet transformation tensor. More...
 
vector normal () 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
 Is the particle on an internal face? More...
 
bool onBoundaryFace () const
 Is the particle on a boundary face? More...
 
label patch () const
 Return the index of patch that the particle is on. More...
 
vector position () const
 Return current particle position. More...
 
void reset ()
 Set step fraction and behind data to zero in preparation for a new. More...
 
scalar track (const vector &displacement, const scalar fraction)
 Track along the displacement for a given fraction of the overall. More...
 
scalar trackToCell (const vector &displacement, const scalar fraction)
 As particle::track, but stops when a new cell is reached. More...
 
scalar trackToFace (const vector &displacement, const scalar fraction)
 As particle::track, but stops when a face is hit. More...
 
scalar trackToTri (const vector &displacement, const scalar fraction, label &tetTriI)
 As particle::trackToFace, but stops when a tet triangle is hit. On. More...
 
scalar trackToStationaryTri (const vector &displacement, const scalar fraction, label &tetTriI)
 As particle::trackToTri, but for stationary meshes. More...
 
scalar trackToMovingTri (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 >
void hitFaceNoChangeToMasterPatch (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td)
 As above, but does not change the master patch. Needed in order for. 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
 Get the displacement from the mesh centre. Used to correct the. More...
 
void patchData (vector &normal, vector &displacement) const
 Get the normal and displacement of the current patch location. More...
 
void prepareForParallelTransfer ()
 Convert global addressing to the processor patch local equivalents. More...
 
void correctAfterParallelTransfer (const label patchi, trackingData &td)
 Convert processor patch addressing to the global equivalents. More...
 
void prepareForInteractionListReferral (const transformer &transform)
 Break the topology and store the particle position so that the. More...
 
void correctAfterInteractionListReferral (const label celli)
 Correct the topology after referral. The particle may still be. More...
 
label procTetPt (const polyMesh &procMesh, const label procCell, const label procTetFace) const
 Return the tet point appropriate for decomposition or reconstruction. More...
 
void autoMap (const vector &position, const mapPolyMesh &mapper)
 Map after a topology change. 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 void readFields (Cloud< solidParticle > &c)
 
static void writeFields (const Cloud< solidParticle > &c)
 
- Static Public Member Functions inherited from particle< Type >
static string propertyList ()
 
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< solidParticle >
 
Ostreamoperator<< (Ostream &, const solidParticle &)
 

Additional Inherited Members

- 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 provide unique ID. More...
 
- Protected Member Functions inherited from particle< Type >
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 symmetryPatch. More...
 
template<class TrackCloudType >
void hitCyclicPatch (TrackCloudType &, trackingData &)
 Overridable function to handle the particle hitting a cyclicPatch. More...
 
template<class TrackCloudType >
void hitCyclicAMIPatch (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td)
 Overridable function to handle the particle hitting a cyclicAMIPatch. More...
 
template<class TrackCloudType >
void hitCyclicACMIPatch (const vector &displacement, const scalar fraction, TrackCloudType &cloud, trackingData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackCloudType >
void hitCyclicRepeatAMIPatch (const vector &displacement, const scalar fraction, 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 processorPatch. More...
 
template<class TrackCloudType >
void hitWallPatch (TrackCloudType &, trackingData &)
 Overridable function to handle the particle hitting a wallPatch. More...
 

Detailed Description

Simple solid spherical particle class with one-way coupling with the continuous phase.

Source files

Definition at line 65 of file solidParticle.H.

Constructor & Destructor Documentation

◆ solidParticle() [1/2]

solidParticle ( const polyMesh mesh,
const barycentric coordinates,
const label  celli,
const label  tetFacei,
const label  tetPti,
const scalar  d,
const vector U 
)
inline

Construct from components.

Definition at line 46 of file solidParticleI.H.

Referenced by solidParticle::clone(), solidParticle::iNew::operator()(), and solidParticle::trackingData::trackingData().

Here is the caller graph for this function:

◆ solidParticle() [2/2]

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

Construct from Istream.

Definition at line 40 of file solidParticleIO.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ clone()

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 149 of file solidParticle.H.

References solidParticle::solidParticle().

Here is the call graph for this function:

◆ d()

Foam::scalar d ( ) const
inline

Return diameter.

Definition at line 90 of file solidParticleI.H.

Referenced by solidParticle::iNew::operator()(), solidParticle::readFields(), and solidParticle::writeFields().

Here is the caller graph for this function:

◆ U()

const Foam::vector & U ( ) const
inline

Return velocity.

Definition at line 96 of file solidParticleI.H.

Referenced by solidParticle::iNew::operator()(), solidParticle::readFields(), and solidParticle::writeFields().

Here is the caller graph for this function:

◆ move()

◆ hitPatch()

bool hitPatch ( solidParticleCloud cloud,
trackingData td 
)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 89 of file solidParticle.C.

References solidParticle::hitProcessorPatch().

Referenced by solidParticle::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ hitProcessorPatch()

void hitProcessorPatch ( solidParticleCloud cloud,
trackingData td 
)

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 96 of file solidParticle.C.

References particle< Type >::trackingData::switchProcessor.

Referenced by solidParticle::hitPatch(), and solidParticle::iNew::operator()().

Here is the caller graph for this function:

◆ hitWallPatch()

void hitWallPatch ( solidParticleCloud cloud,
trackingData td 
)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 105 of file solidParticle.C.

References solidParticleCloud::e(), solidParticleCloud::mu(), and nw.

Referenced by solidParticle::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ transformProperties()

void transformProperties ( const transformer transform)
virtual

Transform the physical properties of the particle.

according to the given transformation

Reimplemented from particle< Type >.

Definition at line 121 of file solidParticle.C.

References transformer::transform(), and particle< Type >::transformProperties().

Referenced by solidParticle::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readFields()

void readFields ( Cloud< solidParticle > &  c)
static

◆ writeFields()

void writeFields ( const Cloud< solidParticle > &  c)
static

Definition at line 90 of file solidParticleIO.C.

References solidParticle::d(), Cloud< ParticleType >::fieldIOobject(), forAllConstIter(), IOobject::NO_READ, p, Cloud< ParticleType >::size(), solidParticle::U(), and particle< Type >::writeFields().

Referenced by solidParticle::iNew::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

Friends And Related Function Documentation

◆ Cloud< solidParticle >

friend class Cloud< solidParticle >
friend

Definition at line 83 of file solidParticle.H.

◆ operator<<

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

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