This document is archived and information here might be outdated.  Recommended version.


IGroundwaterOp.PorousPuff Method (ArcObjects .NET 10.4 SDK)
ArcObjects namespaces > SpatialAnalyst > ESRI.ArcGIS.SpatialAnalyst > Interfaces > IG > IGroundwaterOp Interface > IGroundwaterOp.PorousPuff Method (ArcObjects .NET 10.4 SDK)
ArcObjects Library Reference (SpatialAnalyst)  

IGroundwaterOp.PorousPuff Method

Calculates the time-dependent, two-dimensional concentration distribution in mass per volume of a solute introduced instantaneously and at a discrete point into a vertically mixed aquifer.

[Visual Basic .NET]
Public Function PorousPuff ( _
    ByVal trackFile As String, _
    ByVal porosityRaster As IGeoDataset, _
    ByVal thicknessRaster As IGeoDataset, _
    ByVal mass As Double, _
    [ByVal dispersionTime As Object], _
    [ByVal longitudinalDispersivity As Object], _
    [ByVal dispersivityRatio As Object], _
    [ByVal retardationFactor As Object], _
    [ByVal decayCoefficient As Object] _
) As IGeoDataset

[C#]
public IGeoDataset PorousPuff (
    string trackFile,
    IGeoDataset porosityRaster,
    IGeoDataset thicknessRaster,
    double mass,
    object dispersionTime,
    object longitudinalDispersivity,
    object dispersivityRatio,
    object retardationFactor,
    object decayCoefficient
);
[C#]

Optional Values

dispersionTime   To indicate that this parameter is undefined, pass in Type.Missing.
longitudinalDispersivity   To indicate that this parameter is undefined, pass in Type.Missing.
dispersivityRatio   To indicate that this parameter is undefined, pass in Type.Missing.
retardationFactor   To indicate that this parameter is undefined, pass in Type.Missing.
decayCoefficient   To indicate that this parameter is undefined, pass in Type.Missing. 
[C++]
HRESULT PorousPuff(
  BSTR trackFile,
  IGeoDataset* porosityRaster,
  IGeoDataset* thicknessRaster,
  double mass,
  VARIANT dispersionTime,
  VARIANT longitudinalDispersivity,
  VARIANT dispersivityRatio,
  VARIANT retardationFactor,
  VARIANT decayCoefficient,
  IGeoDataset** flowDataset
);

[C++]

Parameters
trackFile [in]
  trackFile is a parameter of type BSTR
porosityRaster [in]

  porosityRaster is a parameter of type IGeoDataset
thicknessRaster [in]

  thicknessRaster is a parameter of type IGeoDataset
mass [in]
  mass is a parameter of type double
dispersionTime [optional]
  dispersionTime 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.
longitudinalDispersivity [optional]
  longitudinalDispersivity 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.
dispersivityRatio [optional]
  dispersivityRatio 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.
retardationFactor [optional]
  retardationFactor 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.
decayCoefficient [optional]
  decayCoefficient 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.
flowDataset [out, retval]

  flowDataset is a parameter of type IGeoDataset

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Spatial Analyst Extension.

Remarks

trackFile

The path file required by this method is an ASCII text file containing information about the position, the local velocity vector, and the cumulative length and time of travel along the path.

This file is generated using the ParticleTrack method

porosityRaster

An input Raster, RasterDataset, RasterBand, or RasterDescriptor containing values of effective formation porosity for each cell in the Raster.

thicknessRaster

An input Raster, RasterDataset, RasterBand, or RasterDescriptor containing values of saturated thickness for each cell in the Raster.

mass

Value representing the amount of mass released instantaneously at the source point, in units of mass

[dispersionTime]

Value representing the time horizon for dispersion of the solute, with units of time

The time must be less than or equal to the maximum time in the track file. If the requested time exceeds the available times from the track file, the function is aborted. The default time is the latest time (corresponding to the terminal point) in the track file.

[longitudinalDispersivity]

Value representing the dispersivity parallel to the flow direction, with units of length.

[dispersivityRatio]

Value representing the ratio of longitudinal dispersivity over transverse dispersivity. Transverse dispersivity is perpendicular to the flow direction in the same horizontal plane

The default value is 3.

[retardationFactor]

A dimensionless value representing the retardation of the solute in the aquifer

Retardation varies between 1 and infinity, with 1 corresponding to no retardation. The default value is 1.

[decayCoefficient]

Decay coefficient for solutes undergoing first-order exponential decay (e.g., radionuclides) in units of inverse time

The default is zero, corresponding to no decay.

 

See Also

IGroundwaterOp Interface