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 vector &position, 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 (trackingData &, const scalar)
 Move. More...
 
bool hitPatch (const polyPatch &, trackingData &td, const label patchI, const scalar trackFraction, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a patch. More...
 
void hitProcessorPatch (const processorPolyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a. More...
 
void hitWallPatch (const wallPolyPatch &, trackingData &td, const tetIndices &)
 Overridable function to handle the particle hitting a wallPatch. More...
 
void hitPatch (const polyPatch &, trackingData &td)
 Overridable function to handle the particle hitting a polyPatch. More...
 
virtual void transformProperties (const tensor &T)
 Transform the physical properties of the particle. More...
 
virtual void transformProperties (const vector &separation)
 Transform the physical properties of the particle. More...
 
virtual scalar wallImpactDistance (const vector &n) const
 The nearest distance to a wall that. More...
 
- Public Member Functions inherited from particle< Type >
 TypeName ("particle")
 Runtime type information. More...
 
 particle (const polyMesh &mesh, const vector &position, const label cellI, const label tetFaceI, const label tetPtI)
 Construct from components. More...
 
 particle (const polyMesh &mesh, const vector &position, const label cellI, bool doCellFacePt=true)
 Construct from components, tetFaceI_ and tetPtI_ are not. 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 refernce 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 vectorposition () const
 Return current particle position. More...
 
vectorposition ()
 Return current particle position. More...
 
labelcell ()
 Return current cell particle is in. More...
 
label cell () const
 Return current cell particle is in. More...
 
labeltetFace ()
 Return current tet face particle is in. More...
 
label tetFace () const
 Return current tet face particle is in. More...
 
labeltetPt ()
 Return current tet face particle is in. More...
 
label tetPt () const
 Return current tet face particle is in. More...
 
tetIndices currentTetIndices () const
 Return the indices of the current tet that the. More...
 
tetPointRef currentTet () const
 Return the geometry of the current tet that the. More...
 
vector normal () const
 Return the normal of the tri on tetFaceI_ for the. More...
 
vector oldNormal () const
 Return the normal of the tri on tetFaceI_ for the. More...
 
labelface ()
 Return current face particle is on otherwise -1. More...
 
label face () const
 Return current face particle is on otherwise -1. More...
 
bool softImpact () const
 Return the impact model to be used, soft or hard (default). More...
 
scalar currentTime () const
 Return the particle current time. More...
 
void initCellFacePt ()
 Check the stored cell value (setting if necessary) and. More...
 
bool onBoundary () const
 Is the particle on the boundary/(or outside the domain)? More...
 
bool internalFace (const label faceI) const
 Is this global face an internal face? More...
 
bool boundaryFace (const label faceI) const
 Is this global face a boundary face? More...
 
label patch (const label faceI) const
 Which patch is particle on. More...
 
label patchFace (const label patchI, const label faceI) const
 Which face of this patch is this particle on. More...
 
scalar & stepFraction ()
 Return the fraction of time-step completed. More...
 
scalar stepFraction () const
 Return the fraction of time-step completed. More...
 
label origProc () const
 Return const access to the originating processor id. More...
 
labelorigProc ()
 Return the originating processor id for manipulation. More...
 
label origId () const
 Return const access to the particle id on originating processor. More...
 
labelorigId ()
 Return the particle id on originating processor for manipulation. More...
 
template<class TrackData >
label track (const vector &endPosition, TrackData &td)
 Track particle to end of trajectory. More...
 
template<class TrackData >
scalar trackToFace (const vector &endPosition, TrackData &td)
 Track particle to a given position and returns 1.0 if the. More...
 
label faceInterpolation () const
 Return the index of the face to be used in the interpolation. More...
 
template<class TrackData >
void prepareForParallelTransfer (const label patchI, TrackData &td)
 Convert global addressing to the processor patch. More...
 
template<class TrackData >
void correctAfterParallelTransfer (const label patchI, TrackData &td)
 Convert processor patch addressing to the global equivalents. More...
 
void writePosition (Ostream &) const
 Write the particle position and cell. More...
 
template<class TrackData >
Foam::label track (const vector &endPosition, TrackData &td)
 
template<class TrackData >
Foam::scalar trackToFace (const vector &endPosition, TrackData &td)
 
- Public Member Functions inherited from DLListBase::link
 link ()
 Null construct. More...
 
bool registered () const
 Check if the link is registered with the DLListBase. More...
 
void deregister ()
 Deregister the link after removal. More...
 

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 CloudType >
static void readFields (CloudType &c)
 Read the fields associated with the owner cloud. More...
 
template<class CloudType >
static void writeFields (const CloudType &c)
 Write the fields associated with the owner cloud. More...
 

Friends

class Cloud< solidParticle >
 
Ostreamoperator<< (Ostream &, const solidParticle &)
 

Additional Inherited Members

- Public Attributes inherited from DLListBase::link
linkprev_
 Pointer to next entry in list. More...
 
linknext_
 
- 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 provode unique ID. More...
 
static const scalar trackingCorrectionTol = 1e-5
 Fraction of distance to tet centre to move a particle to. More...
 
static const scalar lambdaDistanceToleranceCoeff = 1e3*SMALL
 Fraction of the cell volume to use in determining tolerance values. More...
 
static const scalar minStepFractionTol = 1e5*SMALL
 Minimum stepFraction tolerance. More...
 
- Protected Member Functions inherited from particle< Type >
void findTris (const vector &position, DynamicList< label > &faceList, const tetPointRef &tet, const FixedList< vector, 4 > &tetAreas, const FixedList< label, 4 > &tetPlaneBasePtIs, const scalar tol) const
 Find the tet tri faces between position and tet centre. More...
 
scalar tetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
 Find the lambda value for the line to-from across the. More...
 
scalar movingTetLambda (const vector &from, const vector &to, const label triI, const vector &tetArea, const label tetPlaneBasePtI, const label cellI, const label tetFaceI, const label tetPtI, const scalar tol) const
 Find the lambda value for a moving tri face. More...
 
void tetNeighbour (label triI)
 Modify the tet owner data by crossing triI. More...
 
void crossEdgeConnectedFace (const label &cellI, label &tetFaceI, label &tetPtI, const edge &e)
 Cross the from the given face across the given edge of the. More...
 
template<class CloudType >
void hitWallFaces (const CloudType &td, const vector &from, const vector &to, scalar &lambdaMin, tetIndices &closestTetIs)
 
template<class TrackData >
void hitFace (TrackData &td)
 Overridable function to handle the particle hitting a face. More...
 
template<class TrackData >
bool hitPatch (const polyPatch &, TrackData &td, const label patchI, const scalar trackFraction, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitWedgePatch (const wedgePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a wedgePatch. More...
 
template<class TrackData >
void hitSymmetryPlanePatch (const symmetryPlanePolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitSymmetryPatch (const symmetryPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitCyclicPatch (const cyclicPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a cyclicPatch. More...
 
template<class TrackData >
void hitCyclicAMIPatch (const cyclicAMIPolyPatch &, TrackData &td, const vector &direction)
 Overridable function to handle the particle hitting a cyclicAMIPatch. More...
 
template<class TrackData >
void hitProcessorPatch (const processorPolyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
template<class TrackData >
void hitWallPatch (const wallPolyPatch &, TrackData &td, const tetIndices &tetIs)
 Overridable function to handle the particle hitting a wallPatch. More...
 
template<class TrackData >
void hitPatch (const polyPatch &, TrackData &td)
 Overridable function to handle the particle hitting a. More...
 
- Protected Attributes inherited from particle< Type >
const polyMeshmesh_
 Reference to the polyMesh database. More...
 
vector position_
 Position of particle. More...
 
label cellI_
 Index of the cell it is in. More...
 
label faceI_
 Face index if the particle is on a face otherwise -1. More...
 
scalar stepFraction_
 Fraction of time-step completed. More...
 
label tetFaceI_
 Index of the face that owns the decomposed tet that the. More...
 
label tetPtI_
 Index of the point on the face that defines the decomposed. More...
 
label origProc_
 Originating processor id. More...
 
label origId_
 Local particle id on originating processor. More...
 

Detailed Description

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

Source files

Definition at line 57 of file solidParticle.H.

Constructor & Destructor Documentation

solidParticle ( const polyMesh mesh,
const vector position,
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(), and solidParticle::iNew::operator()().

Here is the caller graph for this function:

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

virtual autoPtr<particle> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from particle< Type >.

Definition at line 141 of file solidParticle.H.

References solidParticle::solidParticle().

Here is the call graph for this function:

Foam::scalar d ( ) const
inline

Return diameter.

Definition at line 90 of file solidParticleI.H.

Referenced by solidParticle::readFields().

Here is the caller graph for this function:

const Foam::vector & U ( ) const
inline

Return velocity.

Definition at line 96 of file solidParticleI.H.

Referenced by solidParticle::readFields().

Here is the caller graph for this function:

bool hitPatch ( const polyPatch ,
trackingData td,
const label  patchI,
const scalar  trackFraction,
const tetIndices tetIs 
)

Overridable function to handle the particle hitting a patch.

Executed before other patch-hitting functions

Definition at line 107 of file solidParticle.C.

void hitProcessorPatch ( const processorPolyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a.

processorPatch

Definition at line 120 of file solidParticle.C.

References particle< Type >::TrackingData< CloudType >::switchProcessor.

void hitWallPatch ( const wallPolyPatch wpp,
trackingData td,
const tetIndices tetIs 
)

Overridable function to handle the particle hitting a wallPatch.

Definition at line 130 of file solidParticle.C.

References particle< Type >::TrackingData< CloudType >::cloud(), solidParticleCloud::e(), tetIndices::faceTri(), Foam::mag(), solidParticleCloud::mu(), triangle< Point, PointRef >::normal(), and nw.

Here is the call graph for this function:

void hitPatch ( const polyPatch ,
trackingData td 
)

Overridable function to handle the particle hitting a polyPatch.

Definition at line 152 of file solidParticle.C.

References particle< Type >::TrackingData< CloudType >::keepParticle.

void transformProperties ( const tensor T)
virtual

Transform the physical properties of the particle.

according to the given transformation tensor

Reimplemented from particle< Type >.

Definition at line 161 of file solidParticle.C.

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

Here is the call graph for this function:

void transformProperties ( const vector separation)
virtual

Transform the physical properties of the particle.

according to the given separation vector

Reimplemented from particle< Type >.

Definition at line 168 of file solidParticle.C.

References particle< Type >::transformProperties().

Here is the call graph for this function:

Foam::scalar wallImpactDistance ( const vector n) const
virtual

The nearest distance to a wall that.

the particle can be in the n direction

Reimplemented from particle< Type >.

Definition at line 174 of file solidParticle.C.

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

Friends And Related Function Documentation

friend class Cloud< solidParticle >
friend

Definition at line 75 of file solidParticle.H.

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

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