This document is archived and information here might be outdated. Recommended version. |
Calculates the path of a particle through a velocity field.
[Visual Basic .NET] Public Function ParticleTrack ( _ ByVal directionRaster As IGeoDataset, _ ByVal magnitudeRaster As IGeoDataset, _ ByVal sourcePoint As IPoint, _ ByVal trackFile As String, _ [ByVal stepLength As Object], _ [ByVal trackingTime As Object] _ ) As IGeoDataset
[C#] public IGeoDataset ParticleTrack ( IGeoDataset directionRaster, IGeoDataset magnitudeRaster, IPoint sourcePoint, string trackFile, object stepLength, object trackingTime );
[C++]
HRESULT ParticleTrack(
IGeoDataset* directionRaster,
IGeoDataset* magnitudeRaster,
IPoint* sourcePoint,
BSTR trackFile,
VARIANT stepLength,
VARIANT trackingTime
);
[C++] Parameters directionRaster [in]
directionRaster is a parameter of type IGeoDataset* magnitudeRaster [in]
magnitudeRaster is a parameter of type IGeoDataset* sourcePoint [in]
sourcePoint is a parameter of type IPoint* trackFile [in]
trackFile is a parameter of type BSTR stepLength [in, optional]
stepLength is a parameter of type VARIANT
To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND. trackingTime [in, optional]
trackingTime is a parameter of type VARIANT
To indicate this parameter is undefined pass in a VARIANT with type VT_ERROR and scode value of DISP_E_PARAMNOTFOUND.
directionRaster |
Raster containing values of direction of the velocity; associated with the magnitude Raster Directions are expressed in compass coordinates, in degrees clockwise from north. This may be created by the IGroundwaterOp::DarcyFlow method or IGroundwaterOp::DarcyVelocy method. |
magnitudeRaster |
Raster containing values of the magnitude of the velocity; associated with the direction Raster Units are length/time. This may be created by the IGroundwaterOp::DarcyFlow methods or IGroundwaterOp::DarcyVelocy method. |
sourcePoint |
location of the source point from which to begin the particle tracking This is entered as numbers identifying the position in map units. |
trackFile |
the name of the ASCII trackfile which will be created by the method |
[stepLength] |
user-defined value for a characteristic step length used for calculating the particle track If none is specified the stepLength will be one half the cell size. Units are length. |
[trackingTime] |
maximum elapsed time for particle tracking ParticleTrack will follow the track until either this time is met or the particle migrates off the Raster or into a depression. If no trackingTime is specified the value will be infinity. Units are time. |