| makertn Required Commands |
Command
Description |
| ReplaceSurfaceWaterReturn |
Allows the user to specifiy the
surface water return flow location, percentage, and delay pattern for each diversion node.
Five required fields on this record:
Field one is the command token "ReplaceSurfaceWaterReturn", but
it is not case sensitive.
Field two on this record should be a text string denoting the StateMod diversion node ID
Field three on this record should be a text string denoting the StateMod surface water
return flow node ID.
Field four on this record should be a number containing the percentage (a number between
0% and 100%) of the unconsumed water to be returned to the node denoted in field
three with the delay pattern in field five.
Field five two on this record should be an integer number denoting the index of the delay
pattern in the *.dly file to use for this surface water return.
This command is OPTIONAL in the makertn command file. |
| ReplaceGroundWaterReturn |
Allows the user to specifiy the
ground water return flow location(s), percentage(s), and delay pattern(s) for each
diversion node.
The required fields on this record are:
Field one is the command token "ReplaceGroundWaterReturn", but it
is not case sensitive.
Field two on this record should be a text string denoting the StateMod diversion node ID
Field three on this record should be an integer number denoting the number of return flow
nodes that will be defined for the groundwater returns from this diversion node.
The number of remaining fields depends on the value specified in field three. There
should be three fields in the following order for each and every return flow node:
A text string denoting the StateMod groundwater return flow node ID.
A number containing the percentage (a number between 0% and 100%) of the unconsumed
water to be returned to the node denoted in the previous field with the delay pattern in
the following field. (See the important note regarding this perceantage value in the text
of this documentation.)
An integer number denoting the index of the delay pattern in the *.dly file to use for
this ground water return.
This command is OPTIONAL in the makertn command file. |
| DefaultSurfaceWaterDelayPatternIndex |
Allows the user to specifiy the default
surface water return flow delay pattern index.
Two required fields on this record:
Field one is the command token "DefaultSurfaceWaterDelayPatternIndex",
but it is not case sensitive.
Field two on this record should be an integer number denoting the default delay
pattern index to use for surface water return flows.
This command is OPTIONAL in the makertn command file. |
| DefaultSurfaceWaterReturnPercentage |
Allows the user to
specifiy the default surface water return flow percentage.
Two required fields on this record:
Field one is the command token "DefaultSurfaceWaterReturnPercentage",
but it is not case sensitive.
Field two on this record should be a number denoting the default percentage (a
number between 0% and 100%) of the diverted but unconsumed water to return
to the stream via surface water return flows.
This command is OPTIONAL in the makertn command file. |
| DefaultGroundwaterDelayPatternIndex |
Allows the user to specifiy the default
ground water return flow delay pattern index.
Two required fields on this record:
Field one is the command token "DefaultGroundwaterDelayPatternIndex",
but it is not case sensitive.
Field two on this record should be an integer number denoting the default delay
pattern to use for ground water return flows.
This command is OPTIONAL in the makertn command file. |
Table 3. makertn Optional Commands
# makertn command file
# space delimited, but CAN handle quoted text strings
#
# these are the required input parameters for makertf (space delimited)
#=================================================================
ReturnFlowFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.rtn"
RINFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.rin"
NodeToParcelFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.n2p"
ParcelToURFZoneFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.p2z"
URFZoneToURFFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.z2u"
URFToRiverReachFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.u2r"
RiverReachToNodeFileName "G:\PROJECTS\297\Task 6\RGModel\Return Flows\rg.r2n"
#
#
# these are optional input parameters for makertn (space delimited)
#=================================================================
#DefaultSurfaceWaterDelayPatternIndex delaypatternid
DefaultSurfaceWaterDelayPatternIndex 1
#DefaultSurfaceWaterReturnPercentage returnpercentage
DefaultSurfaceWaterDelayPatternIndex 5.0
#DefaultGroundWaterDelayPatternIndex delaypatternid
DefaultGroundWaterDelayPatternIndex 2
#
ReplaceSurfaceWaterReturn 20ANWR 08240000 5.0 1
ReplaceSurfaceWaterReturn 350597 08251500 5.0 1
ReplaceSurfaceWaterReturn 24_EastLand RG_RFNode 5.0 1
ReplaceSurfaceWaterReturn 240537 RG_RFNode 5.0 1
#replacegroundwaterreturn divnodeid numberofreturnpatterns [retnodeid returnpercentage
delaypatternid] ...
ReplaceGroundWaterReturn 20ANWR 2 08240000 50.0 2 08251500 45.0 19015
ReplaceGroundWaterReturn 350597 1 08251500 95.0 19015
ReplaceGroundWaterReturn 24_EastLand 1 RG_RFNode 95.0 2
ReplaceGroundWaterReturn 240537 1 RG_RFNode 95.0 2 |
Figure 1. Sample makertn Command File
- StateMod river network file (*.rin)
This ASCII text file is created by the makenet StateMod DMI. It
contains the order and organization (or topology) of the nodes in the StateMod model
network. This file is used by makertn to identify all the diversion nodes
in the network and to detemine which return flow nodes might be upstream of the diversion
location. Diversion nodes are currently the only nodes which will potentially have
return flows. See the CDSS makenet DMI documentation for more
information on this file.
- Diversion node to irrigated parcel database (*.n2p)
This ASCII text file (space delimited) contains the
diversion node to irrigated
parcel database. This database is typically created by special GIS
database queries based on irrigated parcel maps developed as part of the State's CDSS
project. Each record in this file represents the relationship between a diversion
structure and an irrigated parcel. There may be and often are several lines for each
diversion structure since multiple irrigated parcels can be served by the same source
(ditch or well). This relationship is therefore "one to many."
Each record of this file has 3 space delimited fields as follows:
Field 1. contains the diversion structure ID.
Field 2. contains the parcel ID.
Field 3. contains the percentage (a number between 0.0 and 1.0) of the total irrigated
area for this structure (created by summing all the irrigated parcel acreages for this
structure) that is in this particular parcel.
Not every diversion structure in the model needs to be represented in
this file. For structures that are modeled in the StateMod network but are without
any mapped irrigated parcels, makertn uses the default return flow
location (next downstream node), as well as the default delay patterns and return flow
percentages. Also, the order of the records in this file is not important.
Example lines from a typical diversion node to irrigated parcel database (*.n2p) file is shown below in Figure 2.
| ... 200812 11200 0.001675810
200812 11201 0.001696726
200812 11202 0.001691096
200812 11203 0.001815828
200812 11204 0.001775262
200812 11205 0.001643458
200812 11206 0.001814110
200812 11207 0.001935656
200631 11208 0.001525458
200631 11209 0.002775871
200812 11210 0.000655247
200812 11211 0.000341166
200812 11212 0.000629302
200631 11213 0.001397375
200631 11214 0.001302014
200812 11215 0.000065081
200812 11216 0.000063501
200812 11217 0.000057695
200631 11218 0.000148033
200631 11219 0.000074140
200812 11220 0.000065186
200812 11221 0.000109998
200631 11222 0.000129832
200631 11223 0.000130510
200812 11224 0.000703273
200812 11225 0.000813233
200812 11226 0.001615645
200812 11227 0.001689566
200812 11228 0.001521046
200812 11229 0.001861723
200812 11230 0.001867729
... |
Figure 2. Sample Node to Parcel Database File
- Irrigated parcel to URF zone database (*.p2z)
This ASCII text file (space delimited) contains the
irrigated parcel to URF zone
database. This database is typically created by special GIS database
queries based on irrigated parcel and URF zone maps developed as part of the State's CDSS
project. Each record in this file represents the relationship between an irrigated
parcel and a URF zone. There should only be one line or record in this file for an
irrigated parcel. This relationship is therefore "one to one."
Each record of this file has 2 space delimited fields as follows:
Field 1. contains the parcel ID.
Field 2. contains the ID of the URF Zone in which this parcel is located.
Not every parcel needs to be represented in this file. Some
parcels can be in areas for which no URF zones are defined. For structures that are
modeled in the StateMod network but are serving parcels that are not within a URF zone, makertn
uses the default return flow location (next downstream node), as well as the default delay
patterns. Also, the order of the records in this file is not important.
Example lines from a typical irrigated parcel to URF zone database (*.p2z) file is shown below in Figure 3.
| ... 10163 21
10164 21
10165 21
10166 21
10167 21
10168 21
10169 24
10170 22
10171 22
10172 22
10173 22
10174 22
10175 22
10176 24
10177 24
10178 24
10179 24
10180 24
10181 24
10182 24
10183 24
10184 24
10185 24
10186 24
10187 24
10188 24
10189 24
10190 24
10191 24
... |
Figure 3. Parcel to URF Zone Database File
- URF zone to URF database (*.z2u)
This ASCII text file (space delimited) contains the
URF zone to URF database. This database defines which Unit Response Functions (URF's) to use as
delay patterns for groundwater returns and/or depletions due to recharge and/or pumping
within the URF zones. The actual URF data is stored in the StateMod delay file
(*.dly). This file is typically created manually after the URF's have been
developed based on groundwater modeling activities in the State's CDSS project. Each
record in this file represents the relationship between a URF zone and a URF describing
the stream impacts of recharge or pumping in this zone on a particular river reach.
Since several reaches could be affected by activities in one URF zone, there can be
multiple records for the same zone. This relationship is therefore "one to
many."
Each record of this file has 2 space delimited fields as follows:
Field 1. contains the ID (integer) of a URF Zone
Field 2. contains the ID (integer) of the Unit Response Function (URF) in the StateMod
delay file defined for this URF zone
Currently, the URFs are defined such that the sum of each URF pattern
represents the percentage of the total impact from this URF zone for a particular reach.
Therefore the full amount of the unconsumed diversion applied to parcels within
this URF zone must be multiplied by EACH URF. This can results in nodal return flow
percentages that sum to more than 100% for URF zones with multiple URF's defined.
This is compensated by the fact that the URF's themselves only sum to a fraction of the
total returns.
Not every URF zone needs to be represented in this file. Some URF
zones may not have URFs defined because the groundwater model showed that pumping and/or
recharge in this URF zone did not have a significant effect on any river reach in
the basin. For structures that are modeled in the StateMod network but are serving
parcels within URF zones with no URF defined, makertn uses the default
return flow location (next downstream node) and delay pattern. Also, the order of
the records in this file is not important. Example lines from a typical URF
zone to URF database (*.z2u) file is shown below in Figure 4.
1 10108
2 10208
3 10308
4 10408
5 10508
6 10608
7 10708
8 10808
8 10816
9 10916
10 11016
11 11116
12 11216
13 11316
14 11416
15 11516
16 11616
18 11816
19 11916
20 12016
24 12401
28 12801
28 12802
29 12901
29 12902
29 12903
32 13204
32 13213
32 13214
32 13215... |
Figure 4. URF Zone to URF Database File
- URF to river reach database (*.u2r)
This ASCII text file (space delimited) contains the
URF to river reach database. This database defines the river reach with which each URF is
associated. The URF describes the delay pattern of stream effects for recharge
and/or pumping between a particular URF zone and a particular river reach. This file
is typically created manually after the URF's have been developed based on groundwater
modeling activities in the State's CDSS project. The river reach ID is actually
embedded in the URF ID as the fourth and fifth characters. Each record in this file
represents the relationship between a URF and a river reach which is "one to
one."
Each record of this file has 2 space delimited fields as follows:
Field 1. contains the ID (integer) of a URF
Field 2. contains the ID (integer) of the river reach with which this URF is associated
Every URF zone needs to be represented in this file. However, ,
the order of the records in this file is not important. Example lines from a typical
URF to riiver reach database (*.u2r) file is shown below in Figure
5.
10108 8
10208 8
10308 8
10408 8
10508 8
10608 8
10708 8
10808 8
10816 16
10916 16
11016 16
11116 16
11216 16
11316 16
11416 16
11516 16
11616 16
11816 16
11916 16
12016 16
12401 1
12801 1
12802 2
12901 1
12902 2
12903 3
13204 4
13213 13
13214 14
13215 15... |
Figure 5. URF to River Reach Database File
- River reach to Return flow node database (*.r2n)
This ASCII text file (space delimited) contains the
river reach to return flow
node database. This database defines the nodes to which return flows
are delivered within each river reach and the distribution of the return flows between
these nodes. The URFs assign return flows (or depletions) from recharge (or pumping)
occurring within URF zones to specific river reaches within the basin. The last
step, therefore, in the automation of return flow development for StateMod is the
assignment of the river reach returns flows to specific nodes in the StateMod network.
This file is created manually after the StateMod network has been developed and the
URF's have been generated based on groundwater modeling activities in the State's CDSS
project. The definition of the river reaches depends on the groundwater modeling.
Each record in this file represents the relationship between a river reach and a
node in the Statemod network. There are usually multiple nodes for return flows
assigned to each river reach, so there will be multiple records for each river reach in
this file, making this a "one to many" relationship. The sum of the nodal
percentages for each river reach should equal 100%.
Each record of this file has 3 space delimited fields as follows:
Field 1. contains the ID (integer) of a river reach
Field 2. contains the ID (text string) of a node within this river
Field 3. contains the percentage (number between 0% and 100%) of the river reach's return
flows to assign to this node
Every river reach needs to be represented in this file. However,
the order of the records in this file is not important. Example lines from a typical
riiver reach to node database (*.r2n) file is shown below in Figure
6.
1 200846 33
1 200671 33
1 200677 34
2 200775 50
2 20_MS_2 50
3 200627 50
3 200680 50
4 200575 33
4 08240000 67
5 08251500 100
6 220562 33
6 220627 33
6 220501 34
7 220525 50
7 220899_Dwn 50
8 25_MS_11 33
8 250661 67
9 240589 100
10 240581 100
11 210566 25
11 210521 25
11 210565 25
11 210536 25
12 210593 25
12 210513 25
12 210529 25
12 210557 25
13 08241000 100
14 35_MS_3 100
15 350597 100
16 260584 25
16 260655 25
16 26_MS_5 25
16 26_MS_1 25
17 NORDLSCO 100
18 CerroDamC 33
18 90_METRJ 33
18 240537 34 |
Figure 6. River Reach to Node Database File
makertn was created using
Microsoft Visual Basic 6.0, and was compiled to create an executable (makertn.exe) file.
It should be executed in the Windows (95, 98, 2000, NT, etc.) environment and
requires one command line argument, the name of the makertn command file
described in Section 2.0. It should be executed from a command line prompt as show
below.
makertn will execute in the
background until the return flow file, *.rtn, is complete. Errors in reading input
will result in a message to the user and stopping the execution of the program.
Output generated by makertn
consists of the following file:
the StateMod return flow file (*.rtn) specified in
the ReturnFlowFileName variable in the makertn command
file.
See also:
StateMod Users'
Manual
DMI Utilities
– watright
DMI
Utilities – makenet