Itasca C++ Interface
Loading...
Searching...
No Matches
zone::ICParticle Class Referenceabstract

A particle being tracked. More...

#include <icparticlelist.h>

Public Member Functions

virtual const IThing * getIThing () const =0
 Returns a const IThing pointer.
virtual IThing * getIThing ()=0
 Returns a IThing pointer.
virtual const ICParticle * getNext () const =0
virtual DVect3 getLocation () const =0
 Returns the current position of the particle.
virtual void setLastPt (const double &dTime, const DVect &dvCrd, const DVect &dvVel)=0
virtual void getLastPt (double *dTime, DVect *dvCrd, DVect *dvVel) const =0
virtual void getParticlePath (FArray< DVect > *path) const =0

Static Public Attributes

static const TType type_ = 0x4c815a0e
 The type identification number for this class, for use in convert_cast() and convert_getcast().

Detailed Description

A particle being tracked.

This class represents a single particle in the tracking system. ICParticleList contains all such particles current being tracked.

Member Function Documentation

◆ getLastPt()

virtual void zone::ICParticle::getLastPt ( double * dTime,
DVect * dvCrd,
DVect * dvVel ) const
pure virtual

This funcion gets the last position saved for the particle. This could have been set by a FISH function, or by the tracking logic.

  • dTime is the accumulated fluid time associated with this position.
  • dvCrd is the position of the particle.
  • dvVel is the velocity of the particle.

◆ getNext()

virtual const ICParticle * zone::ICParticle::getNext ( ) const
pure virtual

Returns a const pointer to the next IParticle object in the CParticle list, or 0 to indicate the end of the list. See ICParticleList::getFirst()

◆ getParticlePath()

virtual void zone::ICParticle::getParticlePath ( FArray< DVect > * path) const
pure virtual

This funcion populates a given vector with the positions of the trajectory of the particle in the fluid.

◆ setLastPt()

virtual void zone::ICParticle::setLastPt ( const double & dTime,
const DVect & dvCrd,
const DVect & dvVel )
pure virtual

This funcion sets the last position saved for the particle.

  • dTime is the accumulated fluid time associated with this position.
  • dvCrd is the position of the particle.
  • dvVel is the velocity of the particle.
The documentation for this class was generated from the following file: