com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class DarcyFlow

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.DarcyFlow

All Implemented Interfaces:

GPTool

public class DarcyFlow
extends AbstractGPTool

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.
Learn more about how Darcy Flow and Darcy Velocity work

Software restrictions: none

Usage tips:

• The differences between Darcy Flow and Darcy Velocity are:
• All input rasters must have the same extent and cell size.
• All input rasters must be floating point.
• The direction of the velocity vector is recorded in compass coordinates (degrees clockwise from north), the magnitude in units of length over time.
• No particular system of units is specified by this function. Data should be consistent, using the same unit for time (seconds, days, years) and length (feet, meters) for all data.
• The head raster can come from a variety of sources. It can be interpolated from well observation data by using one of the surface interpolation functions, such as Kriging or Spline. The head values can also be obtained from the results of a separate modeling program.
• However the head elevation raster is obtained, the head must be consistent with the transmissivity raster. That is, the head must reflect the flow through the transmissivity field. It is not sufficient to use values obtained by measurement and testing in the fieldthe gridded values must be analyzed for consistency with the aid of a proper porous medium flow program. Consistency implies that the heads would actually be produced by the modeled transmissivity field. Since the true and modeled transmissivity fields often differ in practice, the true and modeled head fields differ as well. Check the heads for consistency by examining the residual raster produced by Darcy Flow. The residual will reflect the consistency of the dataset. Any analysis using Darcy Flow on inconsistent datasets will produce meaningless results.
• The effective porosity field, a physical property of the aquifer, is generally estimated from geological data. It is defined as the volume of void space that contributes to fluid flow divided by the entire volume. Porosity is expressed as a number between 0 and 1, with typical values around 0.35, and is dimensionless. A value of effective porosity of 0.35 means that 35 percent of the volume of the porous medium contributes to fluid flow. The remaining 65 percent, consisting of solid matrix and unconnected pores, does not contribute to fluid flow.
• The saturated thickness, measured in units of length, is interpreted from geological information. For a confined aquifer, this measure is the thickness of the formation between the upper and lower confining layers. For an unconfined aquifer, the saturated thickness is the distance between the water table and the lower confining layer.

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

DarcyFlow

public DarcyFlow()

Creates the Darcy Flow tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

DarcyFlow

public DarcyFlow(Object inHeadRaster,
                 Object inPorosityRaster,
                 Object inThicknessRaster,
                 Object inTransmissivityRaster,
                 Object outVolumeRaster)

Creates the Darcy Flow tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inHeadRaster - Composite Geodataset, the head is typically an elevation above some datum, such as mean sea level.

inPorosityRaster - Composite Geodataset, the input raster where each cell value represents the effective formation porosity at that location.

inThicknessRaster - Composite Geodataset, the value for the thickness is interpreted from geological properties of the aquifer.

inTransmissivityRaster - Composite Geodataset, list ranges of hydraulic conductivities for some generalized geologic materials.

outVolumeRaster - Raster Dataset, the output raster where each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law.

Method Detail

getInHeadRaster

public Object getInHeadRaster()

Returns the Input groundwater head elevation raster parameter of this tool . This parameter is Composite Geodataset, the head is typically an elevation above some datum, such as mean sea level. This is a required parameter.

Returns:

the Input groundwater head elevation raster

setInHeadRaster

public void setInHeadRaster(Object inHeadRaster)

Sets the Input groundwater head elevation raster parameter of this tool . This parameter is Composite Geodataset, the head is typically an elevation above some datum, such as mean sea level. This is a required parameter.

Parameters:

inHeadRaster - Composite Geodataset, the head is typically an elevation above some datum, such as mean sea level.

getInPorosityRaster

public Object getInPorosityRaster()

Returns the Input effective formation porosity raster parameter of this tool . This parameter is Composite Geodataset, the input raster where each cell value represents the effective formation porosity at that location. This is a required parameter.

Returns:

the Input effective formation porosity raster

setInPorosityRaster

public void setInPorosityRaster(Object inPorosityRaster)

Sets the Input effective formation porosity raster parameter of this tool . This parameter is Composite Geodataset, the input raster where each cell value represents the effective formation porosity at that location. This is a required parameter.

Parameters:

inPorosityRaster - Composite Geodataset, the input raster where each cell value represents the effective formation porosity at that location.

getInThicknessRaster

public Object getInThicknessRaster()

Returns the Input saturated thickness raster parameter of this tool . This parameter is Composite Geodataset, the value for the thickness is interpreted from geological properties of the aquifer. This is a required parameter.

Returns:

the Input saturated thickness raster

setInThicknessRaster

public void setInThicknessRaster(Object inThicknessRaster)

Sets the Input saturated thickness raster parameter of this tool . This parameter is Composite Geodataset, the value for the thickness is interpreted from geological properties of the aquifer. This is a required parameter.

Parameters:

inThicknessRaster - Composite Geodataset, the value for the thickness is interpreted from geological properties of the aquifer.

getInTransmissivityRaster

public Object getInTransmissivityRaster()

Returns the Input formation transmissivity raster parameter of this tool . This parameter is Composite Geodataset, list ranges of hydraulic conductivities for some generalized geologic materials. This is a required parameter.

Returns:

the Input formation transmissivity raster

setInTransmissivityRaster

public void setInTransmissivityRaster(Object inTransmissivityRaster)

Sets the Input formation transmissivity raster parameter of this tool . This parameter is Composite Geodataset, list ranges of hydraulic conductivities for some generalized geologic materials. This is a required parameter.

Parameters:

inTransmissivityRaster - Composite Geodataset, list ranges of hydraulic conductivities for some generalized geologic materials.

getOutVolumeRaster

public Object getOutVolumeRaster()

Returns the Output groundwater volume balance residual raster parameter of this tool . This parameter is Raster Dataset, the output raster where each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law. This is a required parameter.

Returns:

the Output groundwater volume balance residual raster

setOutVolumeRaster

public void setOutVolumeRaster(Object outVolumeRaster)

Sets the Output groundwater volume balance residual raster parameter of this tool . This parameter is Raster Dataset, the output raster where each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law. This is a required parameter.

Parameters:

outVolumeRaster - Raster Dataset, the output raster where each cell value represents the groundwater volume balance residual for steady flow in an aquifer, as determined by Darcy's Law.

getOutDirectionRaster

public Object getOutDirectionRaster()

Returns the Output direction raster parameter of this tool . This parameter is Raster Dataset, it is used with the {out_magnitude_raster} to describe the flow vector. This is an optional parameter.

Returns:

the Output direction raster

setOutDirectionRaster

public void setOutDirectionRaster(Object outDirectionRaster)

Sets the Output direction raster parameter of this tool . This parameter is Raster Dataset, it is used with the {out_magnitude_raster} to describe the flow vector. This is an optional parameter.

Parameters:

outDirectionRaster - Raster Dataset, it is used with the {out_magnitude_raster} to describe the flow vector.

getOutMagnitudeRaster

public Object getOutMagnitudeRaster()

Returns the Output magnitude raster parameter of this tool . This parameter is Raster Dataset, it is used with the {out_direction_raster} to describe the flow vector. This is an optional parameter.

Returns:

the Output magnitude raster

setOutMagnitudeRaster

public void setOutMagnitudeRaster(Object outMagnitudeRaster)

Sets the Output magnitude raster parameter of this tool . This parameter is Raster Dataset, it is used with the {out_direction_raster} to describe the flow vector. This is an optional parameter.

Parameters:

outMagnitudeRaster - Raster Dataset, it is used with the {out_direction_raster} to describe the flow vector.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias