com.esri.arcgis.spatialanalyst
Interface IGroundwaterOp

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
IGroundwaterOpProxy, RasterGroundwaterOp

public interface IGroundwaterOp
extends java.io.Serializable

COM Interface 'IGroundwaterOp'. Generated 3/19/2015 1:21:00 PM from 'C:\ArcGIS\COM\esriSpatialAnalyst.olb'

Description: 'Provides access to members that perform groundwater analysis on raster data.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID3c0ed7fb_b5c6_47cc_b708_081a5aa7a742
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 IGeoDataset darcyFlow(IGeoDataset headRaster, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, IGeoDataset transmissivityRaster, boolean createDirection, boolean createMagnitude)
          Calculates the groundwater volume balance residual and other outputs for steady flow in an aquifer.
 IGeoDataset darcyVelocity(IGeoDataset headRaster, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, IGeoDataset transmissivityRaster)
          Calculates the groundwater seepage velocity vector (direction and magnitude) for steady flow in an aquifer.
 IGeoDataset particleTrack(IGeoDataset directionRaster, IGeoDataset magnitudeRaster, IPoint sourcePoint, java.lang.String trackFile, java.lang.Object stepLength, java.lang.Object trackingTime)
          Calculates the path of a particle through a velocity field.
 IGeoDataset porousPuff(java.lang.String trackFile, IGeoDataset porosityRaster, IGeoDataset thicknessRaster, double mass, java.lang.Object dispersionTime, java.lang.Object longitudinalDispersivity, java.lang.Object dispersivityRatio, java.lang.Object retardationFactor, java.lang.Object decayCoefficient)
          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.
 

Field Detail

IID3c0ed7fb_b5c6_47cc_b708_081a5aa7a742

static final int IID3c0ed7fb_b5c6_47cc_b708_081a5aa7a742
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

darcyFlow

IGeoDataset darcyFlow(IGeoDataset headRaster,
                      IGeoDataset porosityRaster,
                      IGeoDataset thicknessRaster,
                      IGeoDataset transmissivityRaster,
                      boolean createDirection,
                      boolean createMagnitude)
                      throws java.io.IOException,
                             AutomationException
Calculates the groundwater volume balance residual and other outputs for steady flow in an aquifer.

Parameters:
headRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
porosityRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
thicknessRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
transmissivityRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
createDirection - The createDirection (in)
createMagnitude - The createMagnitude (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

darcyVelocity

IGeoDataset darcyVelocity(IGeoDataset headRaster,
                          IGeoDataset porosityRaster,
                          IGeoDataset thicknessRaster,
                          IGeoDataset transmissivityRaster)
                          throws java.io.IOException,
                                 AutomationException
Calculates the groundwater seepage velocity vector (direction and magnitude) for steady flow in an aquifer.

Parameters:
headRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
porosityRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
thicknessRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
transmissivityRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

particleTrack

IGeoDataset particleTrack(IGeoDataset directionRaster,
                          IGeoDataset magnitudeRaster,
                          IPoint sourcePoint,
                          java.lang.String trackFile,
                          java.lang.Object stepLength,
                          java.lang.Object trackingTime)
                          throws java.io.IOException,
                                 AutomationException
Calculates the path of a particle through a velocity field.

Parameters:
directionRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
magnitudeRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
sourcePoint - A reference to a com.esri.arcgis.geometry.IPoint (in)
trackFile - The trackFile (in)
stepLength - A Variant (in, optional, pass null if not required)
trackingTime - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

porousPuff

IGeoDataset porousPuff(java.lang.String trackFile,
                       IGeoDataset porosityRaster,
                       IGeoDataset thicknessRaster,
                       double mass,
                       java.lang.Object dispersionTime,
                       java.lang.Object longitudinalDispersivity,
                       java.lang.Object dispersivityRatio,
                       java.lang.Object retardationFactor,
                       java.lang.Object decayCoefficient)
                       throws java.io.IOException,
                              AutomationException
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.

Parameters:
trackFile - The trackFile (in)
porosityRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
thicknessRaster - A reference to a com.esri.arcgis.geodatabase.IGeoDataset (in)
mass - The mass (in)
dispersionTime - A Variant (in, optional, pass null if not required)
longitudinalDispersivity - A Variant (in, optional, pass null if not required)
dispersivityRatio - A Variant (in, optional, pass null if not required)
retardationFactor - A Variant (in, optional, pass null if not required)
decayCoefficient - A Variant (in, optional, pass null if not required)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGeoDataset
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.