molecule::trackingData Class Reference

Class used to pass tracking data to the trackToFace function. More...

Inheritance diagram for molecule::trackingData:
Collaboration diagram for molecule::trackingData:

Public Types

enum  trackPart { tpVelocityHalfStep0 , tpLinearTrack , tpRotationalTrack , tpVelocityHalfStep1 }
 

Public Member Functions

 trackingData (const moleculeCloud &cloud)
 Construct from components. More...
 
trackPart part () const
 Return the part of the tracking operation taking place. More...
 
trackPartpart ()
 Access to the part of the tracking operation taking place. More...
 
- Public Member Functions inherited from particle::trackingData
template<class TrackCloudType >
 trackingData (const TrackCloudType &cloud)
 

Additional Inherited Members

- Public Attributes inherited from particle::trackingData
const polyMeshmesh
 Reference to the mesh. More...
 
bool keepParticle
 Flag to indicate whether to keep particle (false = delete) More...
 
label sendToProc
 Processor to send the particle to. -1 indicates that this. More...
 
label sendFromPatch
 Patch from which to send the particle. More...
 
label sendToPatch
 Patch to which to send the particle. More...
 
label sendToPatchFace
 Patch face to which to send the particle. More...
 

Detailed Description

Class used to pass tracking data to the trackToFace function.

Definition at line 166 of file molecule.H.

Member Enumeration Documentation

◆ trackPart

enum trackPart
Enumerator
tpVelocityHalfStep0 
tpLinearTrack 
tpRotationalTrack 
tpVelocityHalfStep1 

Definition at line 172 of file molecule.H.

Constructor & Destructor Documentation

◆ trackingData()

trackingData ( const moleculeCloud cloud)
inline

Construct from components.

Definition at line 194 of file molecule.H.

Member Function Documentation

◆ part() [1/2]

trackPart part ( ) const
inline

Return the part of the tracking operation taking place.

Definition at line 203 of file molecule.H.

Referenced by moleculeCloud::evolve(), and molecule::move().

Here is the caller graph for this function:

◆ part() [2/2]

trackPart& part ( )
inline

Access to the part of the tracking operation taking place.

Definition at line 209 of file molecule.H.


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