|
Extran A-B (Simulation Control)
|   |
|
Extran A-B (Simulation Control)
| |
* Create title lines for the simulation. There are two title lines
* for the Extran Block. Titles are enclosed in single quotes.
*============================================================================
A1 'EXTRAN EXAMPLE SHOWING MOST CONDUIT SHAPES, INCLUDING BRIDGES'
A1 'INITIAL 20 CFS IN TWO NATURAL CHANNELS'
*============================================================================
* 'AA' line offers options for backward and forward version compatibility.
* Just two options for first use of this line (July 04).
*============================================================================
* AA line : Optional. Not required.
*
* NAVER : For subcritical geometric computations, conduit/channel
* area, hydraulic radius, and width are weighted as follows
* in Subroutine NHEAD:
* AREA = WUP*AREA-up + WMD*AREA-mid + WDN*AREA-down
* and similarly for hydraulic radius and top width.
* NAVER = 1 is SWMM3x option:
* WDN = WUP = 1/4, WMD = 1/2
* NAVER = 2 is SWMM4x option: <<<<DEFAULT
* WDN = WUP = 0, WMD = 1.0
* NAVER = 3 is SWMM5 option:
* WDN = WUP = 1/6, WMD = 2/3.
* NFASNH : = 0 (default): do not add surface area to upstream node
* is not included with downstream node when downstream
* node depth is less than normal but greater than critical.
* = 1: do add residual surface area to upstream node.
*============================================================================
* NAVER NFASNH
AA 2 0
*============================================================================
* 'B' data lines describe the Extran program control information.
*============================================================================
* 'B0' data line is optional and need not be entered by the user.
*============================================================================
* B0 line :
* ISOL : Solution technique parameter (see Appendix C).
* = 0 Explicit solution of Section 5 (default) (Subroutine
* XROUTE)
* = 1 Enhanced explicit solution (Subroutine YROUTE)
* = 2 Iterative explicit solution using variable
* time-steps <_ DELT (group B1). Iteration
* limit is ITMAX and convergence criterion is
* SURTOL (group B2). (Subroutine ZROUTE)
* = 3 Explicit solution of Section 5 (ISOL=0) and skips
* calculation when system goes to a steady state as
* defined by TOLCS1,QLOWCS,TOLCS2 (Subroutine XROUTE)
* = 4 Enhanced explicit solution (ISOL=1) and skips
* calculation when system goes to a steady state as
* defined by TOLCS1,QLOWCS,TOLCS2 (Subroutine YROUTE)
* KSUPER : = 0 Use minimum of normal flow and dynamic flow
* when water surface slope < conduit slope (default).
* = 1 Normal flow always used when flow is supercritical.
*
* The following are required only if ISOL is greater than 2.
* Controls for skipping computations during steady state periods
* KREDO : = 0 Use the last computed heads and flows during dry
* periods.
* = 1 Read the hot start file to establish heads and flows
* during steady-state periods.
* TOLCS1 : = Maximum steady state flow imbalance to control when
* model is in steady state conditions expressed as follows:
* IF [ABS(QOUT-QIN) < ABS(TOLCS1*QIN)] then steady state
* conditions prevail.
* Note: to avoid printout of many change of status
* between steady-state and non-steady-state, enter
* negative value for TOLCS1. Absolute value of TOLCS1
* is used in computation, so negative value has no
* effect other than to stop status change printouts.
* QLOWCS : = Maximum steady state outflow (cfs or cms). Total model
* outflow (including all outfalls and overflows)
* must be less than this value for steady state conditions.
* TOLCS2 : = Maximum change in flow (cfs or cms). The change in flow
* between inflow hydrograph values must be less than this
* for steady-state conditions to occur.
*
*============================================================================
* ISOL KSUPER [KREDO TOLCS1 QLOWCS TOLCS2]
B0 0 0
*============================================================================
* B1 line :
* NTCYC : Number of time-steps desired.
* DELT : Length of time-step, seconds. Shorten to improve stability
* if necessary, but must have DELT >= 1 sec. Values < 5 sec
* should be avoided if possible by using equivalent conduits
* to avoid violation of Courant stability condition.
* TZERO : Start time of simulation, decimal hours. Time zero
* is midnight (beginning) of first simulation day.
*
* If inflows to model are provided on interface file
* associated with JIN, then model will skip ahead this
* many hours in the interface file.
*
* NSTART: First time-step to begin print cycle.
* INTER : Interval between intermediate print cycles during
* simulation. Number of cycles printed is
* (NTCYC - NSTART)/INTER.
* IF INTER is entered as zero. Then it is set equal to a
* large number (999999999).
* If INTER is entered as a negative number, then system
* configuration and intermediate model depth and flow
* results are sent to file associated with JOUT in ASCII
* format. The intent of this file is to provide detailed
* model results in a format that is readily accessible to
* post-processor programs.
* JNTER : Interval between time-history summary print cycles at end
* of simulation. Number of cycles printed is NTCYC/JNTER.
* JREDO : Hot-start file manipulation parameter.
* = 0 No hot-start file is created or used,
* = 1 Read NSCRAT(2) for initial flows, heads,
* areas, and velocities,
* = 2 Create a new hot-start file on NSCRAT(2),
* = 3 Create a new hot-start file but use the old
* file as the initial conditions. The old file
* is subsequently erased and a new file created.
* This option creates a hot-start file starting with
* the existing hot-start file, whereas JREDO=2 creates
* a hot-start file beginning with initial conditions in
* this Extran input file.
*
* Note, the following new (4/11/94) parameter is strictly optional and
* may be omitted from B1 line without error.
*
* IDATZ : Initial date of simulation, 8 digits,
* YYYYMODY (e.g. 19970915). If it is written at 970915 then
* program will assume that date is 1997
* Default is 19410802.
* NOTE: If inflows are provided on interface file associated
* with JIN, then DATEZ on interface file is used for
* initial date.
* EXCEPT, if IDATZ is entered as negative number, this
* starting date will be used regardless of starting date
* on interface file. This permits user to start at some
* intermediate date on interface file. In this case
* the starting time on B1 line will also be used.
*============================================================================
* NTCYC DELT TZERO NSTART INTER JNTER JREDO IDATZ
B1 2160 20.0 0.0 180 300 1 0 19940101
*B1 720 20.0 0.0 180 300 15 0 19940101
*B1 720 20.0 0.0 180 300 15 0
*============================================================================
* B2 line :
* METRIC : U.S. customary or metric units for input/output (and
* internal computations).
* = 0 U.S. customary units.
* = 1 Metric units.
* NEQUAL : Modify short conduit lengths and/or incorporate local losses.
* = 0 Do not modify lengths or incorporate losses.
* = 1 Modify short conduit lengths without incorporating
* local losses. This option creates a longer conduit
* with a correspondingly lower roughness. Under this
* option and the previous option, no local loss
* coefficients are required at the end of the C1 line.
* Note: because the cross-section dimensions stay the
* same, this results in an increase in volume in the
* network. If the user wishes, the user can input
* an alternative equivalent conduit according
* to different criteria, e.g., constant volume.
* OPTIONS 2 and 3 INCORPORATE LOCAL LOSSES BY ADJUSTING MANNING'S N
* SUCH THAT LOSSES ARE EQUIVALENT FOR FULL-FLOW CONDITIONS.
* = 2 Incorporate local losses into closed conduits, but do
* not lengthen conduits. This option requires three
* local loss coefficients at the end of the C1 line
* for each closed conduit.
* = 3 Incorporate local losses into closed conduits, and
* lengthen short conduits. This option requires three
* local loss coefficients at the end of the C1 line for
* each closed conduit.
* OPTIONS 4 and 5 INCORPORATE LOCAL LOSSES IN MOMENTUM EQUATION SIMILAR
* TO FRICTION TERM
* = 4 Incorporate local losses into closed conduits, but do
* not lengthen conduits. This option requires three
* local loss coefficients at the end of the C1 line
* for each closed conduit.
* = 5 Incorporate local losses into closed conduits, and
* lengthen short conduits. This option requires three
* local loss coefficients at the end of the C1 line for
* each closed conduit.
* AMEN : Default surface area for all manholes ft2 [m2].
* Used for surcharge calculations in Extran.
* Manhole default diameter is 4 ft (1.22 m).
* ITMAX : Maximum number of iterations to be used in surcharge
* and iterative calculations (30 recommended for ISOL
* 0 and ISOL 1; 10 recommended for ISOL 2).
* SURTOL : Fraction of average flow in surcharged areas
* to be used as convergence criterion for surcharge
* iterations (0.05 recommended). Also, convergence
* criterion during flow iterations (ISOL = 2) with
* 0.0025 recommended.
*============================================================================
* METRIC NEQUAL AMEN ITMAX SURTOL
B2 0 0 0.0 30 0.05
*============================================================================
* B3 line :
* NHPRT : Number of junctions for detailed printing
* of head output.
* NQPRT : Number of conduits for detailed printing
* of discharge output.
* NPLT : Number of junction heads to be plotted.
* LPLT : Number of conduits for flows to be plotted.
* NJSW : Number of input junctions (data group K2), if
* user input hydrographs are used.
*============================================================================
* NHPRT NQPRT NPLT LPLT NJSW
B3 5 5 4 4 5
*============================================================================
* B4 line : Required only if NHPRT > 0 on data group B3.
* JPRT(1) : First junction number/name for detailed printing
* of junction elevations.
* Continue for the number of junctions defined by NHPRT.
*============================================================================
* JPRT1 JPRT2 etc.
B4 30002 30004 30006 30081 30082
*============================================================================
* B5 line : Required only if NQPRT > 0 on data group B3.
* CPRT(1) : First conduit number/name for detailed printing
* of conduit flow and velocity.
* Continue for the number of conduits defined by NQPRT.
*============================================================================
* CPRT1 CPRT2 etc.
B5 10001 10003 10005 10081 10082
*============================================================================
* B6 line : Required only if NPLT > 0 on data group B3.
* JPLT(1) : First junction number/name for detailed plotting
* of junction elevations.
* Continue for the number of junctions defined by NPLT.
*============================================================================
* JPLT1 JPLT2 etc.
B6 30002 30006 30081 30082
*============================================================================
* B7 line : Required only if LPLT > 0 on data group B3.
* KPLT(1) : First conduit number/name for detailed plotting
* of conduit flow.
* Continue for the number of conduits defined by LPLT.
*============================================================================
* KPLT1 KPLT2 etc.
B7 10001 10006 10081 10082
*============================================================================
* Data group B8 is optional and may be omitted.
*============================================================================
* B8 line :
* NSURF : Number of conduit upstream/downstream elevation plots.
* The upstream/downstream heads are plotted on
* the same graph. A separate plot is also given of the water
* surface slope in this conduit, as a function of time.
* JSURF(1): First conduit number/name for plotting.
* Continue for the number of conduits defined by NSURF.
*============================================================================
* NSURF JSURF1 JSURF2 etc.
B8 2 10081 10082
*============================================================================
*
* B9 line : Controls writing of results of flows in specified conduits
* to ASCII or binary unformatted sequential file (negative
* IFINTER). This option allows flows from any conduit to
* be placed on an interface file, whereas use of JOUT on
* the SW line allows output only of flows at the most
* downstream locations in the Extran simulation.
*
* Flows are output when the flow in any of
* the specified conduits is greater than FLOWMIN.
* Flows are output every IFINTER time steps.
* The flow is the average flow over the previous IFINTER
* time steps.
* Flows are written to scratch file number 3.
* NOFLOW : Number of conduits.
* If negative, then the absolute values of the flows are
* written. This option is useful if one or more of the
* specified conduits has an adverse slope.
* NOFDUP Number of additional conduits to write flows for.
* These are entered on additional lines following this B9
* line. This allows the writing of flows in a conduit
* whenever the flow in another conduit is greater than
* FLOWMIN.
* IFINTER : Number of time steps to output flows. Flows will be
* output every IFINTER time steps.
* Enter IFINTER as a negative number to write sequential
* unformatted file for input to STATS or other SWMM Block.
* FLOWMIN : Minimum flow, cfs [cms]. If average flow in any of the
* requested conduits exceeds FLOWMIN, then flows are
* written for all requested conduits. Enter a large
* negative number to write all flows for all time steps.
* FLOWOUT(1): First conduit number/name for writing flows to ASCII file.
* FLOWOUT(2) Continue for the number of conduits defined by NOFLOW.
* ... These can wrap to subsequent lines but do not
* include B9 identifier on subsequent lines.
*
* Follow the B9 line with NOFDUP lines for additional
* conduits for which flows are written when flows in one
* of the conduits specified on the B9 lines are written.
* Each line has the following information (no B9
* identifier is included):
* FLOWDUP Additional conduit ID for which flows are to be written
* FLOWREF Reference conduit. FLOWREF must be specified as one of
* the FLOWOUT conduits on the B9 lines. Flows will be
* written for conduit identified by FLOWDUP whenever flows
* in the reference conduit FLOWREF are greater than FLOWMIN.
*
*
* NOFLOW NOFDUP IFINTER FLOWMIN FLOWOUT1 FLOWOUT2 etc.
B9 5 0 45 10 10001 10002 10003 10004 10005
* With a 20 sec time steop, above writes every 15 minutes when flows are
* greater than 10 cfs
* NOFDUP possible additional lines, with no B9 identifier, two entries
* per line
* FLOWDUP FLOWREF
*
*============================================================================
* DATA GROUP B
*============================================================================
* 'BA' data line is optional and need not be entered by the user.
* If one variable is entered, then a value must be entered for
* all variable that appear before, or to the left, of that variable.
* This line provides options for modifying program output.
* Excluding this data input line or supplying zero values leaves
* the output format unchanged.
*============================================================================
* BA line :
* JHEAD : Eliminate intermediate headers in summary and time
* history output tables to ease pulling results into
* spreadsheet or database files.
* = 0 Prints header lines at top of each output page as
* in the original program.
* = 1 Eliminate intermediate header lines in junction and
* conduit input and output summary tables.
* JP10 : Print all 10 characters and digits at all locations in
* program. Note that changing this option may cause
* some versions of Extran post-processing programs
* (e.g., MTVE) to not operate correctly. Also modifies
* significant digits in some output fields (e.g.,
* maximum flows in conduit summaries).
* = 0 No change
* = 1 Consistently print 10 digits and 10 characters
* throughout program.
* IWLEN : Irregular section conduit lengths are entered at two
* locations: on the C1 line and on the irregular channel
* input data. This parameter controls the operation of
* the program regarding these two length inputs.
* = 0 or not entered. The lengths on the C1 line and
* the C3 or X1 line must be equal or an error will occur.
* = 1. Use lengths specified on the C3 or X1 lines. A
* warning message is printed if this length does not
* equal the length on the C1 line.
* = 2. Use lengths specified on the C1 line. A warning
* message is generated if the length on the C2 or X1
* line does not equal the value on the C1 line.
*============================================================================
* JHEAD JP10 IWLEN
*BA
*============================================================================
* 'BB' data line is optional and need not be entered by the user.
* If one variable is entered, then all values must be entered.
*============================================================================
* BB line :
* JELEV : Input elevations instead of depth for variables ZP1
* and ZP2 on data line C1 and elsewhere in the data inputs
* = 0 Enter conduit depth offset (ZP values), default.
* = 1 Enter absolute elevation of conduit offset ZP1
* and ZP2 only.
* = 2 Enter elevations in place of depths for conduit ZPs
* and for initial water elevations on D1 line.
* = 3 Enter elevations in place of depths for conduit ZPs,
* initial water elevations of D1 lines, and surface
* area/elevation data in place of surface area/depth
* data on E2 lines
* = 4 Enter elevations in place of depths throughout program,
* including pipe ZPs, junction initial depth YO,
* surface area/elevation on E2 lines, orifice ZP,
* variable orifice control depth, weir YCREST and YTOP,
* and pump station control depths.
*
* JDOWN : = 0 Use either minimum of normal or critical depth
* at free outfall conduits entered on I1 lines.
* This is the default.
* = 1 Use critical depth at free outfall conduits.
* = 2 Use normal depth at free outfall conduits.
*
* The next input variable is optional and equals 0 by default.
*
* IPRATE : = 0 Use default of three PRATE/VRATE pairs for pump
* inputs on H1 line. In this case the parameter
* NRATES should not be entered on the H1 input line.
* = 1 Enter NRATES parameters on pump H1 lines to define
* the number of PRATE/VRATE pairs used by the pump
* station.
*
* The next input variable is optional and equals 0 by default.
* If IM2 is entered, IPRATE must also be entered.
*
* IM2 : = 0 Program uses standard procedures for computing
* characteristic conduit parameters.
* : = 1 Program uses revised procedures for computing
* characteristic conduit parameters for M2 and S2
* drawdown conditions. See the file M2.DOC for
* more detailed description of this change.
*
* The next input variable is optional and equals 0 by default.
* IF IPIPESED is entered, then IM2 and IPRATE must also be entered.
* NOTE - Sediment depth option has been implemented for only
* circular conduits.
*
* IPIPESED : 0 Program will not read conduit sediment data on C1 line.
*
* IPIPESED : 1 Program will read conduit sediment depth (SEDEDPTH) on
* C1 line. The sediment depth must input for all
* conduits in the C1 lines.
*============================================================================
* JELEV JDOWN IPRATE IM2 IPIPESED
BB 0 0 0
*============================================================================
* 'BC' data line is optional and need not be entered by the user.
*============================================================================
* The BC line controls the output of intermediate continuity summaries.
* The continuity results are printed in the intermediate output. The
* maximum five intermediate continuity results are also summarized in
* the continuity output in the summary section of the output.
* BC line :
* ICONTER : Number of time steps. Continuity summary will be produced
* every ICONTER time steps.
*============================================================================
* ICONTER
* BC 1000
*============================================================================
* The BD line is optional and may be excluded. This line allows input of
* monthly base flow factors that are applied to the flows entered for the
* junctions (QINST) entered on the D1 lines. If no BD lines are entered
* then base flow rates remain constant (i.e., base flow factors are set to
* 1.0. If one set of BD lines is entered, then this one set is used for
* all junctions. If more than one set of BD lines are entered, then the
* program will look for the input defining which set to use on the
* D1 lines for each junction. If no input if found, it is assumed that
* the first set is used. See description of data for D1 lines for more
* information.
*
* The maximum number of sets of BD lines is defined by parameter statement
* variable MAXSETS. The number of monthly base flows per set is defined
* by parameter statement variable MAXBFF.
*
* The first input on the BD line is the number of input values for this SET.
* This is followed by the input factors. Note that additional values are
* wrapped onto following lines. These following lines should NOT have a
* BD as the initial value. It is not necessary to have 12 values per line.
* When a second (or third or fourth...) BD line is read, then the program
* reads these as the second SET or third SET... of monthly base flow values.
*
* If 12 values are specified, the program assumes that the first value is
* for January, the second February.. and the 12th value is used for
* December.
*
* If a number other than 12 is used, the program assumes that the first
* value is for the first month in the simulation, the second is for the
* second month. Note that the starting date of the storm is defined by
* IDATEZ on the B1 line (or as defined on the transfer file from
* RUNOFF???). If the simulation starts on 960206, then the first
* value represents February of 1996, the second, March of 1996...
* If the simulation duration extends past the number of months input,
* then the values are repeated.
*
* BD line :
* NUMBFF : The number of monthly base flow factors to be read on
* this SET of base flow lines
* BFFMO(1) : NUMBFF Monthly base flow factors separated by space.
* Values may wrap onto subsequent lines but these lines
* BFFMO(2) : should not start with a BD.
* BFFMO(NUMBFF) :
*
* Subsequent sets of base flow factors may be entered
* on additional BD lines.
*BD 12 1.15 1.15 1.2 1.3 1 1 0.8 0.75 0.8 0.85 0.9 1.1
*============================================================================
* The BE line is optional and may be excluded. This line allows input
* of up to 10 distinct periods for which intermediate output will be
* printed. Each period is defined by a starting time step and the ending
* time step. If BE lines are used, then NSTART on the B1 line is
* ignored. The interval for printing of intermediate results is defined
* by INTER. Up to 10 separate BE lines may be entered. The periods
* specified on BE lines must increase and the periods on BE lines must
* not overlap.
*
* BE line :
* IBESTART : The simulation cycle for which output will start.
* IBEND : the simulation cycle for which output will end.
*
* Up to 10 BE lines may be entered defining up to 10 printout periods.
*============================================================================
* IBESTART IBEND
*BE 500 600
*BE 700 800
*============================================================================
* The BF through BH lines are optional and may be excluded.
* These lines control the output of Extran model results to generate a
* EPA CEAM WASP (Water Analysis Simulation Program) model hydrodynamic
* input file (.HYD).
*
* The file name is that used for NSCRAT(8), if given on an @-line.
* The user will be prompted for a file name if not given on an @ line.
*
* Each WASP segment corresponds to one, or more than one, Extran model
* junction(s). Note that more than one contiguous Extran junction can be
* lumped to represent a single WASP segment. Transfer flows between WASP
* segments are represented by conduits in the model. Parallel conduits can
* be lumped to represent flows between WASP segments. The user enters the
* number of Extran time steps per WASP time step. Extran writes segment
* volumes, depths, and water velocities at the beginning of each water
* quality time step and average link flows over the time step. WASP uses
* flows to calculate mass transport, volumes to compute concentrations,
* and segment depths and velocities to calculate reaeration or
* volatilization.
*
* The single BF line contains the following inputs.
* WTSTART : Time of day (hours) at which linkage file output
* should begin.
* IDEP : = 0, Output volumes, depths and velocities at
* every time step (time variant).
* = 1, Output volumes, etc. only for first time step
* and hold constant for remainder of WASP
* simulation (time invariant).
* NSTEPW : Number of Extran time steps per WASP time step.
* IVCALC : = 0, Compute volumes using subroutine VOLUME
* = 1, Output volumes tracked during simulation for each
* junction. This should be more accurate.
*
* BG lines provide mapping between WASP segments and Extran junctions.
* Repeat for each WASP segment represented. Typically all Extran
* junctions will not be included in the WASP model.
* IWASPSEG : WASP segment number.
* ICONSEG : Extran conduit to use to compute WASP segment
* velocity. Velocity is used in WASP in reaeration
* calculations.
* NJUNSEG : Number of Extran junctions that correspond to
* the WASP segment.
* JUNSEG(1) : Extran junction(s) that correspond to this WASP
* segment.
* ...
* JUNSEG(NJUNSEG)
*
* BH lines identify Extran conduits used to represent WASP segment
* interfacial flows. Positive flows are from FROMSEG to TOSEG. Note that
* in Extran positive flow is defined
* as flow from the end of the conduit with the higher invert elevation to
* the end of the conduit with the lower invert elevation.
* Inflows to the model must be simulated as a flow from FROMSEG 0 and
* outflows to the model are simulated as a flow to TOSEG 0. In this
* version, all inflows and outflows to the model must be represented
* by an Extran conduit. Junctions mapped to WASP segment cannot have
* direct inflows specified on D1 lines, K3 lines, or through interface
* file transfers.
*
* FROMSEG : "From" WASP segment.
* TOSEG : "To" WASP segment.
* NCONSEG : Number of parallel Extran conduits
* ICONSEG : Extran conduit(s) that correspond to this WASP
* interfacial flow.
*
*============================================================================
*
* Data group BZ is optional and may be omitted.
* This controls option for writing hydraulics output file
* for use by water quality simulation program TRANAID.
*============================================================================
* BZ line :
* IDUMP : Parameter to control writing of hydraulics file
* 0 - file is not written
* 1 - file is written
* DTHYD : Time step for hydraulics output file, seconds.
* HYDSTR : Start time for hydraulic output file, hours.
* IVCALC : = 0, Compute volumes using subroutine VOLUME
* = 1, Output volumes tracked during simulation for each
* junction. This should be more accurate.
*============================================================================
* IDUMP DTHYD HYDSTR IVCALC
*BZ 1 60.0 24.0
*============================================================================