DRT- Drain Return Package

  • Scroll to top of this topic Scroll to Top of Page

  • Print the current topic Print Topic

  • Expand/collapse expanding elements on page Show/Hide Expanders

Abbreviation in Name file

DRT

Purpose

The Drain Return Package allows simulation of drains in which some of the water from the drain is used to recharge the aquifer.

Documentation

•Banta, E.R., 2000, MODFLOW-2000, the U.S. Geological Survey Modular Ground-Water Model - Documentation of Packages for Simulating Evapotranspiration with a Segmented Function (ETS1) and Drains with Return Flow (DRT1): U.S. Geological Survey Open-File Report 00-466, 127 p.

•Time-varying-parameters.pdf

•release.txt

•modpath.txt

•Hanson, R.T., Boyce, S.E., Schmid, Wolfgang, Hughes, J.D., Mehl, S.M., Leake, S.A., Maddock, Thomas, III, and Niswonger, R.G., 2014, One-Water Hydrologic Flow Model (MODFLOW-OWHM): U.S. Geological Survey Techniques and Methods 6–A51, 120 p., http://dx.doi.org/10.3133/tm6A51.

Related Packages

•Head-Dependent Flux Boundary packages

•Drain Return Observation package

•Drain package

Supported in

•MODFLOW-2000

•MODFLOW-2005

•MODFLOW-LGR

•MODFLOW-CFP

•MODFLOW-NWT

•MODFLOW-OWHM

Other Notes

Special care must be taken when constructing the DRT package input file if the observations are used.  See discussion of "Observations at Cells Having More Than One Head-Dependent Boundary Feature Represented by the Same Package" in the DTOB (not included in MODFLOW-2005 or MODFLOW-LGR) input file.

Input Instructions

Input to the DRT1 Package is read from the file that has type “DRT” in the name file. Optional variables are shown in brackets. All variables are free format if the option “FREE” is specified in the Basic Package input file; otherwise, the non-optional variables have 10-character fields and the optional variables are free format.

FOR EACH SIMULATION

Data Set 0

[#Text]

Item 0 is optional -- “#” must be in column 1. Item 0 can be repeated as many times as desired.

Text—is a character variable (79 characters) that starts in column 2. Any characters can be included in Text. The “#” character must be in column 1. Lines beginning with “#” are restricted to these first lines of the input file. Text is written to the LIST output file when the input file is read.

Data Set 1

MXADRT IDRTCB NPDRT MXL [Option]

MXADRT—is the maximum number of drain-return cells in use during any stress period. MXADRT includes cells that are defined using parameters as well as cells that are defined without using parameters. Recipient cells are not included in MXADRT.

IDRTCB—is a flag and a unit number.

•If IDRTCB > 0, it is the unit number to which DRT1-Package cell-by-cell flow terms will be written when “SAVE BUDGET” or a non-zero value for ICBCFL is specified in Output Control (Harbaugh and others, 2000). IDRTCB must be a unit number associated with a file listed with type “DATA(BINARY)” or “DATAGLO(BINARY)” in the name file.

•If IDRTCB = 0, DRT1-Package cell-by-cell flow terms will not be written.

•If IDRTCB < 0, drain leakage for each drain-return cell and return flow to each recipient cell will be written to the LIST file when “SAVE BUDGET” or a non-zero value for ICBCFL is specified in Output Control.

NPDRT—is the number of drain-return parameters.

In MODFLOW-2000, the maximum number of allowed parameters is 999.  In MODFLOW-2005,-LGR, and -CFP the maximum number of allowed parametersis 2000. In MODFLOW-OWHM, the maximum number of allowed parameters is specified in the Basic package.

MXL—is the maximum number of drain-return cells that will be defined using parameters. Recipient cells are not included in MXL. MXL must equal or exceed the sum of NLST×N for all parameters, where N is the greater of 1 and NUMINST.

Option—is an optional list of character values.

•“AUXILIARY abc” or “AUX abc” – defines an auxiliary variable (Harbaugh and McDonald, 1996a, p. 9, Item 4), named "abc," which will be read for each drain as part of Items 3 and 5. Up to 20 variables can be specified, each of which must be preceded by "AUXILIARY" or "AUX." These variables will not be used by the Groundwater Flow Process, but they will be available for use by other processes. The auxiliary variable values will be read after the Rfprop variable.

Auxiliary parameters are used with MODPATH and the Groundwater Transport process.  In MODPATH, the variable IFACE is specified with an auxiliary parameter.  In the Groundwater Transport process, concentration is specified with an auxiliary parameter.  The option COMPACT BUDGET AUXILIARY must be used in the Output Control when IFACE is used for MODPATH.

•“CBCALLOCATE” or “CBC”—indicates that memory should be allocated to store cell-by-cell flow for each drain in order to make these flows available for use in other packages. (This option is only available in MODFLOW-2000.)

•“RETURNFLOW”—activates the return-flow option of the DRT1 Package. If “RETURNFLOW” is listed as an option, LayR, and, optionally, RowR, ColR, and Rfprop are read from items 3 and(or) 5.

•NOPRINT—suppresses the printing of cell lists.

•hmtoggle_plus1        PRINTFILE PRTFIL

PRINTFILE PRTFIL

The keyword is PRINTFILE followed by a unit number, PRTFIL, that is specified in the NAM. The unit number is where the DRT flow data is written.

This option is only available in MODFLOW-OWHM.

To facilitate parameter estimation, a new output file was added to the DRT to create observations for drain return flows. This output file prints to either a binary file or text (ASCII) file, a header and then all the drain cells’ locations, where drain water was sent to, and the flow rate. This option is activated by adding the option keyword PRINTFILE on Item 1, followed by a unit number of the file to which data will be written. For binary files, a set of static information is written for each drain location to be consistent. Below is an example written to a binary file where the variables are those previously defined in the DRT documentation or in the next section.

HEADER: ‘ DRAINS (DRT)’ KPER KSTP NDRTCL

DRN# Layer Row Column Q ‘ DRT ‘ LayR RowR ColR QIN

DRN# Layer Row Column Q ‘ DRT ‘ 0 0 0 0D0

DRN# Layer Row Column Q ‘ FMP ‘ LayR RowR 0 QIN

DRN# Layer Row Column Q ‘ SWR ‘ LayR RowR 0 QIN

The first record is a header that contains a string, the current stress period, time step, and the number of drains that will be printed. The subsequent records contain the current drain count, DRN#, the flow rate out of the drain cell, Q, a four-character string that indicates the package that the drain flow is sent to, and the flow rate into that package, QIN. Note that if Rfprop=1.0, then Q=QIN. The second entry represents when DRT functions like DRN and is specified with a zero layer, row, and column, and the type at the end of the line is set to zero because this drain flow is not returned within the model.

 

Repeat Items 2 and 3 for each parameter to be defined (that is, NPDRT times). Items 2 and 3 are omitted if NPDRT = 0.

Data Set 2

[PARNAM PARTYP Parval NLST [INSTANCES NUMINST]]

If PARNAM is to be a time-varying parameter, the keyword “INSTANCES” and a value for NUMINST must be entered.

PARNAM—is the name of a parameter to be defined. This name can consist of 1 to 10 characters and is not case sensitive. That is, any combination of the same characters with different case will be equivalent.

All parameter names must be unique.

PARTYP—is the type of parameter to be defined. For the DRT1 Package, the only allowed parameter type is “DRT,” which defines values of the drain hydraulic conductance.

Parval—is the parameter value. This parameter value may be overridden by a value in the PVAL file, the Sensitivity Process (SEN) input file, or by a value generated by the Parameter-Estimation (PES) Process.

NLST—is the number of drain-return cells included in a non-time-varying parameter or in each instance of a time-varying parameter.

INSTANCES – is an optional keyword that designates a parameter as time varying. The keyword is case-insensitive; that is, it may be entered in any combination of upper- and lower-case letters. If INSTANCES is present, it must be followed by a value for NUMINST. If INSTANCES is absent, PARNAM is non-time-varying and NUMINST should not be present.

NUMINST – is the number of instances that are included in the definition of a time-varying parameter, where each instance is a list of drain-return cells, associated recipient cells, and properties. If the keyword INSTANCES is present, NUMINST must be present and must be at least 1. If the keyword INSTANCES is absent, NUMINST should not be present.

Data Set 3a

INSTNAM

Item 3a is read only if PARNAM is time-varying. NUMINST repetitions of Item 3 (parts a and b) are read. After each repetition of Item 3a, NLST repetitions of Item 3b are read.

INSTNAM – is the name of an instance associated with the parameter PARNAM specified in the corresponding Item 3. The name can consist of 1 to 10 characters and is not case sensitive. That is, any combination of the same characters with different case will be equivalent. Names entered for INSTNAM must be unique for any given parameter, but names may be reused for instances associated with different parameters.

Data Set 3b

Layer Row Column Elevation  Condfact [LayR RowR ColR Rfprop] [xyz]

NLST repetitions of Item 3b records are required; they are read by module ULSTRD (Harbaugh and others, 2000). (SFAC of the ULSTRD utility module applies to Condfact.) The NLST repetitions of Item 3b follow each repetition of Item 3a when PARNAM is time-varying.

Layer—is the layer number of the cell containing the drain.

Row—is the row number of the cell containing the drain.

Column—is the column number of the cell containing the drain.

Elevation—is the elevation of the drain.

Condfact—is the factor used to calculate drain hydraulic conductance from the parameter value. The conductance (L2/T) is the product of Condfact and the parameter value.

See also "What is conductance?"

LayR—is a flag and, if greater than 0, a layer number. If auxiliary variables are being read, LayR must be greater than zero, so that RowR, ColR, and Rfprop are read. LayR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, it is the layer number of the recipient cell.

•If LayR = 0, there is no return flow for the drain cell, and RowR, ColR, and Rfprop are not read unless there are auxiliary variables defined.

•If LayR = –1, drain water will be sent to a FMP farm whose farm ID is specified. RowR, ColR, and Rfprop and any aux variables are read. MODFLOW-OWHM only

•If LayR = –2, drain water will be sent to a SWR reach. RowR, ColR, and Rfprop and any auxiliary variables are read. MODFLOW-OWHM only

RowR is defined by the value of LayR that is read. RowR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, RowR is the row number of the recipient cell that will receive the drain water as recharge.

•If LayR = 0, RowR is NOT read, and there is no return flow for the drain cell, and the water leaves the model.

•If LayR = –1, RowR is the farm ID of the farm that will receive the drain water, and the water stays in the model. If RowR = 0, then the farm located at the drain’s Row and Column is used. MODFLOW-OWHM only

•If LayR = –2, RowR is the SWR reach that will receive the drain water, and the water stays in the model. MODFLOW-OWHM only

ColR is defined by the value of LayR that is read. ColR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, ColR is the column number of the recipient cell that will receive the drain water as recharge.

•If LayR = 0, ColR is NOT read, and there is no return flow for the drain cell.

•If LayR = –1, ColR is read, but is not used. It can be any integer number to serve as a place holder before reading Rfprop and any auxiliary variables. MODFLOW-OWHM only

•If LayR = –2, ColR is read, but is not used. It can be any integer number to serve as a place holder before reading Rfprop and any auxiliary variables. MODFLOW-OWHM only

Rfprop—is the return-flow proportion. Valid values are in the range 0.0 to 1.0, inclusive. Rfprop is the proportion of the drain flow, if any, calculated for the drain-return cell simulated as returning to the recipient cell. If Rfprop equals 0.0, the return-flow capability is deactivated for the cell. Rfprop is not read if “RETURNFLOW” is not listed as an option in item 1.

[xyz]—is up to 20 auxiliary variables for a drain-return cell that have been defined in item 1. The auxiliary variables must be present in each repetition of items 3 and 5 record if they are defined in item 1.

FOR EACH STRESS PERIOD

Data Set 4

ITMP NP

ITMP—is a flag and a counter.

•If ITMP < 0, non-parameter drain-return data from the last stress period will be reused.

•If ITMP ≥0, ITMP will be the number of non-parameter drain-return cells read for the current stress period.

NP—is the number of drain-return parameters in use in the current stress period.

Data Set 5

Layer Row Column Elevation Cond [LayR RowR ColR Rfprop] [xyz]

ITMP repetitions of Item 5 records are read by module ULSTRD (Harbaugh and others, 2000) if ITMP > 0. (SFAC of the ULSTRD utility module applies to Cond). Item 5 is not read if ITMP ≤0.

Layer—is the layer number of the cell containing the drain.

Row—is the row number of the cell containing the drain.

Column—is the column number of the cell containing the drain.

Elevation—is the elevation of the drain.

Cond—is the hydraulic conductance of the interface between the aquifer and the drain.

See also "What is conductance?"

LayR—is a flag and, if greater than 0, a layer number. If auxiliary variables are being read, LayR must be greater than zero, so that RowR, ColR, and Rfprop are read. LayR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, it is the layer number of the recipient cell.

•If LayR = 0, there is no return flow for the drain cell, and RowR, ColR, and Rfprop are not read unless there are auxiliary variables defined.

•If LayR = –1, drain water will be sent to a FMP farm whose farm ID is specified. RowR, ColR, and Rfprop and any aux variables are read. MODFLOW-OWHM only

•If LayR = –2, drain water will be sent to a SWR reach. RowR, ColR, and Rfprop and any auxiliary variables are read. MODFLOW-OWHM only

RowR is defined by the value of LayR that is read. RowR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, RowR is the row number of the recipient cell that will receive the drain water as recharge.

•If LayR = 0, RowR is NOT read, and there is no return flow for the drain cell, and the water leaves the model.

•If LayR = –1, RowR is the farm ID of the farm that will receive the drain water, and the water stays in the model. If RowR = 0, then the farm located at the drain’s Row and Column is used. MODFLOW-OWHM only

•If LayR = –2, RowR is the SWR reach that will receive the drain water, and the water stays in the model. MODFLOW-OWHM only

ColR is defined by the value of LayR that is read. ColR is not read if “RETURNFLOW” is not listed as an option in item 1.

•If LayR > 0, ColR is the column number of the recipient cell that will receive the drain water as recharge.

•If LayR = 0, ColR is NOT read, and there is no return flow for the drain cell.

•If LayR = –1, ColR is read, but is not used. It can be any integer number to serve as a place holder before reading Rfprop and any auxiliary variables. MODFLOW-OWHM only

•If LayR = –2, ColR is read, but is not used. It can be any integer number to serve as a place holder before reading Rfprop and any auxiliary variables. MODFLOW-OWHM only

Rfprop—is the return-flow proportion. Valid values are in the range 0.0 to 1.0, inclusive. Rfprop is the proportion of the drain flow, if any, calculated for the drain-return cell simulated as returning to the recipient cell. If Rfprop equals 0.0, the return-flow capability is deactivated for the cell. Rfprop is not read if “RETURNFLOW” is not listed as an option in item 1.

[xyz]—is up to 20 auxiliary variables for a drain-return cell that have been defined in item 1. The auxiliary variables must be present in each repetition of items 3 and 5 record if they are defined in item 1.

Data Set 6

Pname [Iname]

Item 6 is repeated NP times. It is not read if NP ≤0. Iname is read if Pname is a time-varying parameter.

Pname—is the name of a parameter being used in the current stress period. NP parameter names will be read.

Iname – is an instance name that is read only if Pname is a time-varying parameter. Multiple instances of the same time-varying parameter are not allowed in a stress period.