Input Instructions AG
Input Instructions AG
The AG Package is activated by specifying a file type of “AG” within the MODFLOW-NWT Name file. The AG
input file contains 4 different blocks of data, including 1) Options, 2) Time series, 3) Segment and Well Lists, and 4)
Stress Period. Stress period data is used to vary agricultural practices during a simulation represented mechanically
as the connectivity between segments and irrigation cells, supplemental wells and diversion segments, and wells and
irrigation cells, as well as other input values that control agricultural water use.
Item 1: OPTIONS
Item 2: [NOPRINT]
[IRRIGATION_DIVERSION Numirrdiversions Maxcellsdiversion]
[IRRIGATION_WELL Numirrwells Maxcellswell]
[IRRIGATION_POND Numirrponds Maxcellspond]
[SUPPLEMENTAL_WELL Numsupwells Maxdiversions]
[MAXWELL Nummaxwell]
[MAXPOND Nummaxpond]
[TABFILESWELL Numtabwell Maxvalwell]
[TABFILESPOND Numtabpond Maxvalpond]
[PHIRAMP]
[ETDEMAND Accel]
[CHECKCONVERGE Agtol Maxagiter]
[TRIGGER]
[TIMESERIES_DIVERSION]
[TIMESERIES_WELL]
[TIMESERIES_POND]
[TIMESERIES_DIVERSIONET]
[TIMESERIES_WELLET]
[TIMESERIES_PONDET]
[DIVERSIONLIST Unit_diversionlist]
[WELLLIST Unit_welllist]
[WELLIRRLIST Unit_wellirrlist]
[PONDLIST Unit_pondlist]
[PONDIRRLIST Unit_pondirrlist]
[DIVERSIONIRRLIST Unit_diversionirrlist]
[WELLCBC Unitcbc ISUPWEL]
Item 3: END
1
OPTIONS Character variable specified to indicate the beginning of the key word options.
2
Nummaxwell The maximum number of unique supplemental and irrigation wells used during a
simulation.
Nummaxpond The maximum number of unique supplemental and irrigation wells used during a
simulation.
TABFILESWELL An optional character variable. TABFILESWELL is included in order set pumping rates
using time series input files.
Numtabwell An integer variable equal to the number of individual TABFILES used to set pumping
rates. Numtabwell can be less than MAXWELL when using a single TABFILE for
multiple wells.
Maxvalwell An integer variable equal to the maximum number of values specified for any TABFILE.
TABFILESPOND An optional character variable. TABFILESPOND is included in order set pond maximum
withdrawal rates using time series input files.
Numtabpond An integer variable equal to the number of individual TABFILES used to set withdrawal
rates. Numtabpond can be less than MAXPOND when using a single TABFILE for
multiple ponds.
Maxvalpond An integer variable equal to the maximum number of values specified for any TABFILE.
PHIRAMP An optional character variable. PHIRAMP is included to specify the smoothing interval
used to change negative pumping rates to zero when the groundwater cell dewaters. This
variable only is used when the Newton Solver is active.
Accel An real variable that controls the maximum change in the irrigation diversion or pumped
amount between iterations. Values between 0.5 and 10 work well.
Agtol An real variable that equal to the maximum change in applied irrigation for each
irrigation source feature between nonlinear (outer) iterations for model convergence. If
Agtol is not reached between outer iterations then the model will continue iterating until
Maxagiter is reached, at which point the model will move on to the next time step.
Maxagiter An integer variable that controls the maximum number of iterations taken by the model to
reach convergence in the applied irrigation. If the model converges and Macagiter is
reached then the model will continue onto the next time step.
3
TRIGGER An optional character variable. TRIGGER is included to activate the irrigation trigger
option. TRIGGER and ETDEMAND cannot be used in the same simulation.
TIMESERIES_DIVERSION An optional character variable that activates the option for outputting diversions
flow rates for specified SFR2 segments used for irrigation. Additional details are
specified in the time series data input.
TIMESERIES_WELL An optional character variable for outputting well pumping rates for specified wells used
for irrigation. Additional details are specified in the time series data input.
TIMESERIES_POND An optional character variable for outputting detention reservoir diversion rates for
specified ponds used for irrigation. Additional details are specified in the time series data
input.
TIMESERIES_DIVERSIONET An optional character variable for outputting irrigation applied to all cells/HRUs
supplied by 1 or more specified diversion segments. Additional details are specified in
the time series data input.
TIMESERIES_WELLET An optional character variable for outputting irrigation applied to all cells/HRUs supplied
by 1 or more specified wells. Additional details are specified in the time series data input.
TIMESERIES_PONDET An optional character variable for outputting irrigation applied to all HRUs supplied by 1
or more specified ponds. Additional details are specified in the time series data input.
DIVERSIONLIST An optional character variable for outputting a list of all diversion segments and
diversion amounts used for irrigation in the AG Package when "SAVE BUDGET" or a
non-zero value for ICBCFL is specified in Output Control.
Unit_diversionlist An optional integer variable that is the file unit number to which DIVERSIONLIST
output is written. This unit number must correspond to a file of type Data specified in the
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
WELLLIST An optional character variable for outputting a list of all active wells in the AG Package
and pumped amounts when "SAVE BUDGET" or a non-zero value for ICBCFL is
specified in Output Control.
Unit_welllist An optional integer variable that is the file unit number to which WELLLIST output is
written. This unit number must correspond to a file of type Data specified in the
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
PONDLIST An optional character variable for outputting a list of all active PRMS detention
reservoirs used for irrigation in the AG Package and diverted amounts when "SAVE
BUDGET" or a non-zero value for ICBCFL is specified in Output Control.
Unit_pondlist An optional integer variable that is the file unit number to which PONDLIST output is
written. This unit number must correspond to a file of type Data specified in the
4
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
WELLIRRLIST An optional character variable for outputting a list of MODFLOW cells or PRMS HRUs
that are irrigated by AG wells and the irrigated amounts when "SAVE BUDGET" or a
non-zero value for ICBCFL is specified in Output Control.
Unit_wellirrlist An optional integer variable that is the file unit number to which WELLIRRLIST output
is written. This unit number must correspond to a file of type Data specified in the
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
PONDIRRLIST An optional character variable for outputting a list of PRMS HRUs that are irrigated by
PRMS detention reservoirs and the irrigated amounts when "SAVE BUDGET" or a non-
zero value for ICBCFL is specified in Output Control.
Unit_pondirrlist An optional integer variable that is the file unit number to which PONDIRRLIST output
is written. This unit number must correspond to a file of type Data specified in the
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
DIVERSIONIRRLIST An optional character variable for outputting a list of MODFLOW cells or PRMS HRUs
irrigated by irrigation segments and the irrigated amounts when "SAVE BUDGET" or a
non-zero value for ICBCFL is specified in Output Control.
Unit_diversionirrlist An optional integer variable that is the file unit number to which DIVERSIONIRRLIST
output is written. This unit number must correspond to a file of type Data specified in the
MODFLOW Name file. A negative value indicates output will be written to the LIST
file.
WELLCBC An optional character variable for outputting cell-by-cell flow terms when "SAVE
BUDGET" or a non-zero value for ICBCFL is specified in Output Control.
Unit_cbc An optional integer variable that is the file unit number to which cell-by-cell unformatted
list output is written. This unit number must correspond to a file of type Data(binary)
specified in the MODFLOW Name file.
ISUPWEL An optional integer variable that is a flag for outputting cell by cell flows for all
agricultural wells (ISUPWEL=0) or for outputting cell by cell flows only for SUP wells
(ISUPWEL=1).
END Character variable specified to indicate the end of the character options.
5
.
.
.
[DIVERSION Segmentnumnumtimeseriesdiversion Unit_diversionnumtimeseriesdiversion]
TIME SERIES Character variable specified to indicate the beginning of the time series data block.
DIVERSION Character variable indicating that irrigation information for a diversion will be written to a time
series output file.
6
Segmentnum Integer variable that is the SFR2 segment number.
Unitdiversion Integer variable that is the formatted output file unit number.
DIVERSIONET Character variable indicating that crop ET for all cells/HRUs irrigated by a diversion will be
written to a time series output file.
Unitdiversionet Integer variable that is the formatted output file unit number.
WELL Character variable indicating that irrigation information for a well will be written to a time series output
file.
Unitwell Integer variable that is the formatted output file unit number. This file is of type “Data” and is
included in the MODFLOW Name file.
WELLET Character variable indicating that evapotranspiration information for a well will be written to a
time series output file.
Unitwellet Integer variable that is the formatted output file unit number. This file is of type “Data” and is
included in the MODFLOW Name file.
WELLETALL Character variable indicating that evapotranspiration information summed for all wells will be
written to a time series output file.
Unitwelletall Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
WELLALL Character variable indicating that irrigation information summed for all wells will be written to a
time series output file.
Unitwellall Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
POND Character variable indicating that irrigation information for a pond will be written to a time series output
file.
Pondnum Integer variable that is the HRU ID for the PRMS open detention reservoir for timeseries output.
Unitpond Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
PONDET Character variable indicating that evapotranspiration information for a PRMS open detention
reservoir will be written to a time series output file.
Pondetnum Integer variable that is the HRU ID number that contains the PRMS open detention reservoir.
Unitpondet Integer variable that is the formatted output file unit number. This file is of type “Data” and is
included in the MODFLOW Name file.
7
PONDETALL Character variable indicating that evapotranspiration information summed for all open detention
reservoirs will be written to a time series output file.
Unitpondetall Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
PONDALL Character variable indicating that irrigation information summed for all open detention reservoirs
will be written to a time series output file.
Unitpondall Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
DIVERSIONALL Character variable indicating that irrigation information summed for all irrigation
segment diversions will be written to a time series output file.
Unitdiversionall Integer variable that is the formatted output file unit number. This file is of type “Data”
and is included in the MODFLOW Name file.
DIVERSIONETALL Character variable indicating that evapotranspiration information summed for all
irrigation diversion segments will be written to a time series output file.
Unitdiversionetall Integer variable that is the formatted output file unit number. This file is of type
“Data” and is included in the MODFLOW Name file.
END Character variable specified to indicate the end of the time series data block.
SEGMEMNT LIST Character variable specified to indicate irrigation diversion segments will be included in
simulation. All irrigation segments used in a simulation must be listed.
SEGMENTNUMBER1 Integer value equal to the first irrigation segment used in a simulation.
SEGMENTNUMBERMAXNUMSEGS Integer value equal to the last irrigation segment used in a simulation.
END Character variable specified to indicate the end segment list data block.
Wells used for irrigation, including those used to supplement surface water diversions, are defined within the WELL
LIST. Well numbering is implicitly defined according to the order of wells in the WELL LIST, the first entry is well
8
1, numbered consecutively to the total number of wells used during a simulation. There are 2 options for specifying
information in the WELL LIST. The first option uses TABFILES to vary the maximum pumping rate during a
simulation, and the second option uses a single specified value for the maximum pumping rate that does not vary
during the simulation.
Input instructions for AG Package TABFILES are included at the end of this document.
If character variable TABFILESWELL is specified in the OPTIONS block, then item 16a is read as a space
delimited list in free format. Otherwise, item 16b is read.
WELL LIST Character variable specified to indicate that AG wells will be included in a simulation.
TABWELLUNIT Integer variable equal to the unit number for the TABFILE used to specify pumping rates
for a well.
TABWELLVAL Integer variable equal to the maximum number of rows to be read from a TABFILE.
TABWELLLAY Integer variable equal to the layer number of the cell containing a well set using
TABFILES.
TABWELLROW Integer variable equal to the row number of the cell containing a well set using
TABFILES.
.
TABWELLCOL Integer variable equal to the column number of the cell containing a well set using
TABFILES.
WELLLAY Integer variable equal to the layer number of the cell containing a well.
WELLROW Integer variable equal to the row number of the cell containing a well.
WELLCOL Integer variable equal to the column number of the cell containing a well.
Q Real variable equal to the maximum pumping rate or applied pumping rate.
9
END Character variable specified to indicate the end of the well list data block.
PRMS open depression storage ponds used for irrigation are defined within the POND LIST. Pond identification
numbers are equal to the HRU_ID. There are 2 options for specifying information in the POND LIST. The first
option uses TABFILES to vary the maximum pond irrigation rates during a simulation, and the second option uses a
single specified value for the maximum pond irrigation rate that does not vary during the simulation.
Input instructions for AG Package TABFILES are included at the end of this document.
If character variable TABFILESPOND is specified in the OPTIONS block, then item 19a is read as a space
delimited list in free format. Otherwise, item 19b is read.
POND LIST Character variable specified to indicate that AG ponds will be included in a simulation.
TABPONDUNIT Integer variable equal to the unit number for the TABFILE used to specify maximum
pond irrigation rates.
TABPONDVAL Integer variable equal to the maximum number of rows to be read from a TABFILE.
TABPONDHRU Integer variable equal to the HRU_ID that contains an open detention reservoir (pond)
used for irrigation.
TABPONDSEG SFR segment diversion number that supplies inflow to pond. TABPONDSEG is specified
when using TABFILES to set maximum pond irrigation amounts. This segment number
should not be included in the AG Package SEGMENT LIST. A value of zero
indicates that there is no segment inflow to pond during a simulation.
TABPONDFRAC Real variable equal to the fraction of diverted water supplied to TABPONDHRU. The
sum of fractions specified for a segment used to fill ponds should equal 1.
PONDHRU Integer variable equal to the HRU_ID that contains an open detention reservoir (pond)
used for irrigation.
10
QPOND Real variable equal to the maximum irrigation rate provided by a pond.
PONDSEG SFR segment diversion number that supplies inflow to the pond. PONDSEG is specified
when TABFILES are NOT used to set maximum pond irrigation amounts. This segment
number should not be included in the AG Package SEGMENT LIST. A value of zero
indicates that there is no segment inflow to pond during a simulation.
PONDFRAC Real variable equal to the fraction of diverted water supplied to PONDHRU. The sum of
fractions specified for a segment used to fill ponds should equal 1.
END Character variable specified to indicate the end of the well list data block.
Items 21a and 25a are specified for MODFLOW simulations; items 21b and 25b are specified for GSFLOW
simulations. Some values are not used for a simulation due to specifications in the OPTIONS block; dummy values
must be specified for unused input variables.
STRESS PERIOD
11
Item 23: [NUMIRRWELLSP]
END
12
IRRDIVERSION An optional character variable. IRRDIVERSION can be specified if character variable
IRRIGATION_DIVERSION is specified in the OPTIONS block.
NUMIRRSEGSP An integer variable equal to the number of SFR2 segments active during a stress period
that will divert water to cells. If NUMIRRSEGSP < 0, irrigation segment data from the previous stress period will
be used. If NUMIRRSEGSP =0, all irrigation segments will be set to inactive.
SEGID An integer variable equal to the SFR2 segment number for the diversion used for
irrigation.
NUMCELLSEG An integer variable equal to the total number of MODFLOW cells or PRMS HRUs that
will be irrigated by SFR2 diversion segment SEGID.
IRRPERIODSEG A real variable equal to the length of time water will be diverted for a single irrigation
event. Although this variable is specified for each SEGID, it only is used if the character variable TRIGGER is
specified in the options block. Units for this variable are determined from the DIS file input variable ITMUNI.
Values should be greater than or equal to the length of the largest model time step during irrigation periods.
TRIGGERFACTSEG A real variable between 0 and 1 that triggers an irrigation event. If TRIGGERFACTSEG
is set to 0.5 then an irrigation event will start when ETa/ETo = 0.5. Although this variable is specified for each
SEGID, it only is used if the character variable TRIGGER is specified in the options block.
IRRROW_DIVERSION An integer variable equal to the cell row number that will be irrigated by segment
SEGID. This variable only is specified for MODFLOW-only simulations.
IRRCOL_ DIVERSION An integer variable equal to the cell column number that will be irrigated by segment
SEGID. This variable only is specified for MODFLOW-only simulations.
HRU_ID_ DIVERSION An integer variable equal to the HRU ID number that will be irrigated by segment
SEGID. This variable only is specified for PRMS-only and GSFLOW simulations.
DUM_ DIVERSION An integer variable that must be specified but is not used and can be set to zero.
EFF_FACT_ DIVERSION A real variable equal to the fraction of surface water applied to a cell that can be
used to represent crop evapotranspiration and other field losses. If evapotranspiration is being simulated explicitly
then set EFF_FACT_ DIVERSION to zero.
FIELD_FACT_ DIVERSION A real variable equal to the fraction of the diverted water applied to a cell that is
used to distribute a diversion among multiple cells. The sum of all FIELD_FACT_ DIVERSION values for a
diversion should sum to 1.
NUMIRRWELLSP An integer variable equal to the number of AG wells active during a stress period that
will pump water for irrigation on MODFLOW cells or PRMS HRUs. If NUMIRRWELLSP < 0, irrigation well data
from the previous stress period will be used. If NUMIRRWELLSP =0, all irrigation wells will be set to inactive.
IRRWELLID An integer variable equal to the well identification number used to pump groundwater for
irrigation.
NUMCELLWELL An integer variable equal to the total number of MODFLOW cells or PRMS HRUs that
receive water from a well.
IRRPERIODWELL A real variable equal to the length of time water will be pumped for a single
irrigation event. Although this variable is specified for each WELL, it only is used if the character variable
13
TRIGGER is specified in the options block and for wells that are not SUP wells. Units for this variable are
determined from the DIS file input variable ITMUNI. Values should be greater than or equal to the length of the
largest model time step during irrigation periods.
TRIGGERFACTORWELL A real variable between 0 and 1.0 that triggers an irrigation event. If
TRIGGERFACTORWELL is set to 0.5 then an irrigation event will start when ETa/ETo = 0.5. Although this
variable is specified for each WELL, it only is used if the character variable TRIGGER is specified in the options
block.
IRRROW_WELL An integer variable equal to the cell row number to which pumped water will be applied
as irrigation. This variable only is specified for MODFLOW-only simulations.
IRRCOL_WELL An integer variable equal to the cell column number to which pumped water will be
applied as irrigation. This variable only is specified for MODFLOW-only simulations.
HRU_ID_ WELL An integer variable equal to the HRU ID to which pumped water will be applied as
irrigation. An integer variable that must be specified but is not used and can be set to zero. This variable only is
specified for PRMS-only and GSFLOW simulations.
DUM_ DIVERSION An integer variable that must be specified but is not used and can be set to zero.
EFF_FACT_WELL A real variable equal to the fraction of groundwater applied to a cell that can be used to
represent crop evapotranspiration and other field losses. If evapotranspiration is being simulated explicitly then set
EFF_FACT_WELL to zero.
FIELD_FACT_WELL A real variable equal to the fraction of the groundwater applied to a cell that is used to
distribute water pumped from a well among multiple cells. The sum of all FIELD_FACT_WELL values for a well
should sum to 1.
SUPWELL An optional character variable indicating that supplemental well stress period data will be
specified.
NUMSUPWELLSP An integer variable equal to the number of active supplementary wells during a stress
period that will pump groundwater to meet the surface water shortfall for irrigation. If NUMSUPWELLSP < 0,
supplementary well data from the previous stress period will be used. If NUMSUPWELLSP =0, all supplementary
wells will be set to inactive.
SUPWELLNUM An integer variable equal to the AG well number that supplements one or more surface
water diversions.
NUMSEGWELL An integer variable equal to the number of SFR2 segments that will be supplemented by
a well.
SEGWELLID An integer variable equal to the SFR2 segment number that will be supplemented by a
well.
FRACSUP A real variable between 0 and 1 that is equal to the fraction of the surface water shortfall
for segment SEGWELLID that will be supplemented by a well.
FRACSUPMAX A real variable between 0 and 1 that is equal to the fraction of the surface water demand
that is used to calculate the net irrigation water requirement with supplemental groundwater pumping. Supplemental
groundwater pumping (Q ¿ ¿ will be calculated as Q ¿ =FRACSUP∗[ FRACSUPMAX∗Q demand −Q ¿ ], where
Qdemand is the specified surface water diversion rate for irrigation.
14
IRRPOND An optional character variable. IRRPOND can be specified if character variable
IRRIGATION_POND is specified in the OPTIONS block.
NUMIRRPONDSP An integer variable equal to the number of PRMS open detention reservoirs active during
a stress period that will supply water for irrigation on PRMS HRUs. If NUMIRRPONDSP < 0, irrigation pond data
from the previous stress period will be used. If NUMIRRPONDSP =0, all irrigation ponds will be set to inactive.
IRRPONDID An integer variable equal to the HRU_ID identification number for the HRU that contains an open
detention reservoir used for irrigation.
NUMCELLPOND An integer variable equal to the total number of HRUs that receive irrigation from a
pond.
IRRPERIODPOND A real variable equal to the length of time water will be supplied from a pond for
a single irrigation event. Although this variable is specified for each pond, it only is used if the character variable
TRIGGER is specified in the options block. Units for this variable are determined from the DIS file input variable
ITMUNI. Values should be greater than or equal to the length of the largest model time step during irrigation
periods.
TRIGGERFACTORPOND A real variable between 0 and 1.0 that triggers an irrigation event. If
TRIGGERFACTORPOND is set to 0.5 then an irrigation event will start when ETa/ETo = 0.5. Although this
variable is specified for each POND, it only is used if the character variable TRIGGER is specified in the options
block.
FLOWTHROUGHPOND An integer flag that is used to select an option for calculating segment inflow to
a pond. A value of zero means segment inflow to the pond is specified through the SFR variable “FLOW.” A value
of 1 means segment inflow to the pond will be calculated using the irrigation demand. Outflow from the pond will
be set equal to inflow minus shortfall and applied to fields for irrigation. A value of 1 only can be used if
ETDEMAND is specified in the Options block.
IRRROW_POND An integer variable equal to the cell row number to which pumped water will be applied
as irrigation. This variable only is specified for MODFLOW-only simulations.
IRRCOL_POND An integer variable equal to the cell column number to which pumped water will be
applied as irrigation. This variable only is specified for MODFLOW-only simulations.
HRU_ID_ POND An integer variable equal to the HRU ID to which pumped water will be applied as
irrigation. An integer variable that must be specified but is not used and can be set to zero. This variable only is
specified for PRMS-only and GSFLOW simulations.
DUM_ POND An integer variable that must be specified but is not used and can be set to zero.
EFF_FACT_POND A real variable equal to the fraction of groundwater applied to a cell that can be used to
represent crop evapotranspiration and other field losses. If evapotranspiration is being simulated explicitly then set
EFF_FACT_POND to zero.
FIELD_FACT_POND A real variable equal to the fraction of the groundwater applied to a cell that is used to
distribute water diverted from a pond among multiple cells. The sum of all FIELD_FACT_POND values for a pond
should sum to 1.
END Character variable specified to indicate the end of each stress period data block.
15
Item 1: [TIME1 Q1]
.
.
.
[TIME TABVAL Q TABVAL]
TIME A real variable equal to the simulation time that the pumping rate Q will be used to
interpolate the maximum or applied pumping rate for a time step. The pumping rate for a time step is calculated
using linear interpolation. The units for TIME must be consistent with the DIS Package input variable ITMUNI.
Q A real variable equal to the maximum pumping rate for supplementary wells or for
simulations that include the character variable ETDEMAND, otherwise Q is the applied pumping rate that can be
used for setting the irrigation demand for wells used for irrigation (IRRWELL). Pumping rates are set equal to the
pumping rate at the end of the time interval
Table 1: Water budget for agricultural water use package, where inflows (“IN”) are sources of groundwater from
wells (“AG WELLS”) and surface water diversions (“DIVERSION SEGMENTS”) used for irrigation, and outflows
(“OUT”) are consumptive use of groundwater (“GW IRRIGATION”) and surface water (“SW IRRIGATION”),
groundwater return flows (“SYSTEM LOSSES GW”) and surface water return flows (“SYSTEM LOSSES SW”).
16