|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.spatialanalysttools.DarcyFlow
public class DarcyFlow
Calculates the groundwater volume balance residual and other outputs for steady flow in an aquifer. The Darcy Flow tool is contained in the Spatial Analyst Tools tool box.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
DarcyFlow()
Creates the Darcy Flow tool with defaults. |
|
DarcyFlow(Object inHeadRaster,
Object inPorosityRaster,
Object inThicknessRaster,
Object inTransmissivityRaster,
Object outVolumeRaster)
Creates the Darcy Flow tool with the required parameters. |
Method Summary | |
---|---|
Object |
getInHeadRaster()
Returns the Input groundwater head elevation raster parameter of this tool . |
Object |
getInPorosityRaster()
Returns the Input effective formation porosity raster parameter of this tool . |
Object |
getInThicknessRaster()
Returns the Input saturated thickness raster parameter of this tool . |
Object |
getInTransmissivityRaster()
Returns the Input formation transmissivity raster parameter of this tool . |
Object |
getOutDirectionRaster()
Returns the Output direction raster parameter of this tool . |
Object |
getOutMagnitudeRaster()
Returns the Output magnitude raster parameter of this tool . |
Object |
getOutVolumeRaster()
Returns the Output groundwater volume balance residual raster parameter of this tool . |
String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
String |
getToolboxName()
Returns the name of the tool box containing this tool. |
String |
getToolName()
Returns the name of this tool. |
void |
setInHeadRaster(Object inHeadRaster)
Sets the Input groundwater head elevation raster parameter of this tool . |
void |
setInPorosityRaster(Object inPorosityRaster)
Sets the Input effective formation porosity raster parameter of this tool . |
void |
setInThicknessRaster(Object inThicknessRaster)
Sets the Input saturated thickness raster parameter of this tool . |
void |
setInTransmissivityRaster(Object inTransmissivityRaster)
Sets the Input formation transmissivity raster parameter of this tool . |
void |
setOutDirectionRaster(Object outDirectionRaster)
Sets the Output direction raster parameter of this tool . |
void |
setOutMagnitudeRaster(Object outMagnitudeRaster)
Sets the Output magnitude raster parameter of this tool . |
void |
setOutVolumeRaster(Object outVolumeRaster)
Sets the Output groundwater volume balance residual raster parameter of this tool . |
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
getParameterValues, toString |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public DarcyFlow()
Initializes the array of tool parameters with the default values specified when the tool was created.
public DarcyFlow(Object inHeadRaster, Object inPorosityRaster, Object inThicknessRaster, Object inTransmissivityRaster, Object outVolumeRaster)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.
inHeadRaster
- the input raster where each cell value represents the groundwater head elevation at that location. the head is typically an elevation above some datum, such as mean sea level.inPorosityRaster
- the input raster where each cell value represents the effective formation porosity at that location.inThicknessRaster
- the input raster where each cell value represents the saturated thickness at that location. the value for the thickness is interpreted from geological properties of the aquifer.inTransmissivityRaster
- the input raster where each cell value represents the formation transmissivity at that location. the transmissivity of an aquifer is defined as the hydraulic conductivity K times the saturated aquifer thickness b, as units of length squared over time. This property is generally estimated from field experimental data such as pumping tests. Tables 1 and 2 in How Darcy Flow and Darcy Velocity work list ranges of hydraulic conductivities for some generalized geologic materials.outVolumeRaster
- the output volume balance residual raster. each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law.Method Detail |
---|
public Object getInHeadRaster()
public void setInHeadRaster(Object inHeadRaster)
inHeadRaster
- the input raster where each cell value represents the groundwater head elevation at that location. the head is typically an elevation above some datum, such as mean sea level.public Object getInPorosityRaster()
public void setInPorosityRaster(Object inPorosityRaster)
inPorosityRaster
- the input raster where each cell value represents the effective formation porosity at that location.public Object getInThicknessRaster()
public void setInThicknessRaster(Object inThicknessRaster)
inThicknessRaster
- the input raster where each cell value represents the saturated thickness at that location. the value for the thickness is interpreted from geological properties of the aquifer.public Object getInTransmissivityRaster()
public void setInTransmissivityRaster(Object inTransmissivityRaster)
inTransmissivityRaster
- the input raster where each cell value represents the formation transmissivity at that location. the transmissivity of an aquifer is defined as the hydraulic conductivity K times the saturated aquifer thickness b, as units of length squared over time. This property is generally estimated from field experimental data such as pumping tests. Tables 1 and 2 in How Darcy Flow and Darcy Velocity work list ranges of hydraulic conductivities for some generalized geologic materials.public Object getOutVolumeRaster()
public void setOutVolumeRaster(Object outVolumeRaster)
outVolumeRaster
- the output volume balance residual raster. each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law.public Object getOutDirectionRaster()
public void setOutDirectionRaster(Object outDirectionRaster)
outDirectionRaster
- the output flow direction raster. each cell value represents the direction of the seepage velocity vector (average linear velocity) at the center of the cell, calculated as the average value of the seepage velocity through the four faces of the cell. it is used with the output magnitude raster to describe the flow vector.public Object getOutMagnitudeRaster()
public void setOutMagnitudeRaster(Object outMagnitudeRaster)
outMagnitudeRaster
- an optional output raster where each cell value represents the magnitude of the seepage velocity vector (average linear velocity) at the center of the cell, calculated as the average value of the seepage velocity through the four faces of the cell. it is used with the output direction raster to describe the flow vector.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |