Home

SHETRAN Standard Version – V4.4.1 User Guide and Data Input

1. Note that overland boundary conditions are specified for individual elements in the OC data file and are not entered in the OC definition grids Table 2 1 Overland channel flow codes 22 FR37 FR38 FR39 FR43 FR44 FR46 FR47 FR49 FR50 2 3 Code ETI ET2 23 20A4 17 10G7 0 ZGRUND 20A4 17 1X 7211 NMC 20A4 17 1X 7211 NRAINC 20A4 17 1X 7211 NVC Format 20A4 TITLE 3L7 TITLE IY ZGRUND J TY J 1 NX Ground surface elevation at all elements on the model grid line IY metres above datum TITLE TY NMCVJ TY J 1 NX Integer array see introduction Meteorological grid codes at all elements on the model line IY TITLE TY NRAIN J TY J 1 NX Integer array see introduction Rainfall station grid codes at all elements on the model line IY TITLE TY NVC JTY J 1 NX Integer array see introduction Vegetation type code at all elements on the model line IY Evapotranspiration Interception Module Description TITLE Description of data on the next line s BMETP BINETP BMETAL NY NY NY NY NY Repeat Count IDMC 0 FR33 IDRA 0 FR33 IDVE 0 FR33 Data Only Required Notes If ET3 ET4 24 BMETP BINETP BMETAL DTMET DTMET2 DTMET3 If TRUE the meteorological input data are printed once they have been read in If TRUE the ET input data are printed once they h
2. This number is of relevance to all the sediment in the channel link elements since sediment in suspension is quantified by the volume it would occupy were it to settle on the bed such that its porosity was PBSED Initial composition of loose soil or bed sediment in each size group If the initial depth of loose soil bed sediment is greater than zero the simulation is very sensitive to the initial faction of loose soil bed sediment in each size group For grid elements it is generally better unless additional information is know to set either the initial depth of loose sediment to be zero or set the initial fraction in each size group to be the same as the soil Setting NCAT equal to 1 here will set the initial sediment size distribution of loose bed sediment to be the same as that for soil see SOSDEN throughout the catchment SY62 64 The sediment boundary condition routines have not yet been implemented 57 2 9 CM9 CM11 CM13 CM15 58 Contaminant Migration Components Format C80 Description Repeat Count Title for contaminant simulation TITLE Number of contaminants NCON Flux boundary condition at base of columns ISFLXB Default cell number at base of columns NCED Number of columns where bottom cell number is not default value NCLBND Numbers and bottom cell numbers for those columns NCL NCOLMB NCL NCLBND CM9 Non linear adsorption ISADNL Depth of bed surface layer dys
3. Essential first line in every visualisation_plan txt file note quotes must be used because the text includes a space character diag Optional second line It causes extra information to be output to the echo file to help in diagnosing any problems that SV4 has in reading and interpreting the visualisation_plan txt file item Introduces lines which define an item list Introduces lines which define a list of SV4 elements mask Introduces lines which define a rectangular grid mask time Introduces lines which define a timing pattern for recording data kill Optional second last line This stops the run after the visualisation_plan txt file has been read and processed but before the start of the first simulation timestep It is useful when creating and editing a visualisation_plan txt file stop Essential last line in every visualisation_plan txt file Table 2 4 Special lines that can be used in visualisation_plan txt The following are rules for writing items Each item must start with item and end with ENDITEM Only one property e g NAME can appear on a line The value of a property is specified by value where value is the value assigned to the property 69 70 The properties can be entered in any order Missing properties take the default values Table 2 5 The entry as_above clones the properties from the previous item Any properties specified after an as above entry take precedence o
4. FR8 FRO FR10 FR11 15 9 JSYEAR JSMTH JSDAY JSHOUR JSMIN JCYEAR JCMTH JCDAY JCHOUR JCMIN 20A4 10F7 0 DXIN 20A4 10F7 0 DYIN TITLE JSYEAR JSMTH JSDAY JSHOUR JSMIN Start year for sediment simulation Start month for sediment simulation Start day for sediment simulation Start hour for sediment simulation Start minute for sediment simulation TITLE JCYEAR JCMTH JCDAY JCHOUR JCMIN Start year for contaminant simulation Start month for contaminant simulation Start day for contaminant simulation Start hour for contaminant simulation Start minute for contaminant simulation TITLE DXIN J J 1 NX 1 Distances metres between nodes in x direction TITLE DYIN K K 1 NY 1 Distance metres between nodes in y direction See Fig 2 1 Data is input from the bottom to the top If the sediment or contaminant components are not included see line FR25 lines FR7a FR7d are ignored The grid boundaries are at the midpoints between adjacent nodes see Fig 2 1 The program calculates the actual grid sizes DXQQ and DYQQ from DXIN and DYIN respectively 16 gt DXIN NY 1 DXIN 3 DXIN 1 Y DIRECTION NY DXIN 1 e e e e e 3 4 5 X DIRECTION DXIN 3 DXIN 4 bid pid DXIN 2 Figure 2 1 Specification of grid size NX DXIN N
5. Canopy resistance s m Actual potential evapotranspiration NF D see line ET8 MODE or 3 ETS varying parameters This method as well as MODE 1 can be adapted to give actual evapotranspiration as a quantity independent of soil moisture If only one row is entered in the table NF 1 then the one value of RCF is used for canopy resistance if MODE 2 and the one value of FET is used for the ratio of actual to potential evapotranspiration if MODE 3 This holds as long as the current value of soil moisture tension is negative If it is zero or positive RC takes the default value of RCF and FE takes the value 1 0 ET17 2044 ET18 2F7 4 DEPTH RDF TITLE DEPTH RDF LJ Depth below ground surface The proportion of the roots at DEPTH The sum of RDF over the root zone should be one Running index from 1 to NRD END OF LOOP OVER VEGETATION TYPES 29 NV NV NRD FR29 ET8 ET18 is repeated NRD D times see ET8 The distances of DEPTH are for reference only The RDF values correspond to the depth of each UZ node so the values of DEPTH should correspond to the vertical distance steps DDZ I L read in the UZ data file line UZ21 2 4 Overland Channel Module Code Format OCI A80 OCla 317 L7 NT NCATR KONT BIOWAT 30 Description Repeat Data Only Required Count If TITLE NT NCATR KONT BIOWAT Number of different timesteps used in the simulation Number of
6. SCOPE squares EXTRA_DIMENSIONS none GRID_OR_LIST_NO 7 TIMES 9 LAYERS 1 55 ENDITEM item NUMBER 2 NAME psi BASIS list_as_list SCOPE squares EXTRA_DIMENSIONS none GRID_OR_LIST_NO 6 TIMES 9 LAYERS 55 25 ENDITEM number and size 22 123 345 400 401 402 mask 12 6 8 number and row and column limits row low row high column low column high mask 8 1 29 1 17 number and row and column limits row low row high column low column high 1123456 78901234 WODMDIADGOPWNHE OMDIADGHBWNHEO IPR I 9 4 number and no of entries 1 12 2 24 3 36 48 2560 atan Figure 2 2 Example visualisation plan 68 When a visualisation_plan txt file is read its values are echoed in the file check_visualisation_plan txt which is written to the output directory for the catchment A visualisation_plan txt file is an ASCII file containing lines of information The plan lists items each of which causes a pair of time and value datasets to be created in a shegraph h5 file There can be any number of items The following special characters seen in Table 2 3 can be used in visualisation_plan txt The special lines seen in Table 2 4 should be used ignore the rest of this line line break is off or does not exist is off applies in masks only Table 2 3 Special characters that can be used in visualisation_plan txt visualisation plan
7. 1 NTAB NCAT End of Loop over each contaminant NCON lines CM25 CM26 CM27 Concentrations in rainfall Cr F CCAPI JCONT JCONT 1 NCONCM CM29 Number of columns which receive flow from outside catchment I NFEX CM31 Numbers of those columns and concentrations in the flows F FNCL CCAPE NCL JCONT JCONT 1 NCONCM NFEX CM29 CM33 Default concentration at or convected into bases of columns C or Cr F DUMMY JCONT JCONT 1 NCONCM 60 NCL NINIT FNCL NINT is a FORTRAN77 intrinsic function If ISFLXB TRUE array DUMMY 1 NCONC M is copied to array CCAPR NCL 1 NCONCM for NCL NLF 1 to NEL otherwise the array CCAPB is used in place of CCAPR CM35 CM37 CM39 CM41 CM43 CM45 CM47 61 Number of columns where base concentration is not default value NCBC Numbers and concentrations for those columns FNCL CCAPB or R NCL JCONT JCONT 1 NCBC NCONCM CM35 Rate of dry deposition for each contaminant ig IICK JCONT JCONT 1 NCONCM Three size fractions for each soil used only if sediment component is not included in the simulation FJSOIL SOFN JSOIL JEN JFN 1 3 NSCM CM21 Freundlich isotherm power constant for each contaminant n GNN JCONT JCONT 1 NCONCM Chemical decay constant for each contaminant Ao GGLMSO JCONT JCONT 1 NCONCM Coefficients for exchange between bed layers for each contaminant 644 ALPHBD JCONT JCONT 1 NCONCM
8. DBS Data Only Required Notes If If NCED 1 the default cell number at base of columns is set to cell number at base of modelled region NLYRBT IEL 1 NCLBND gt 0 Depth below river bed of the base of this layer CM17 CM19 CM21 CM23 Depth of bed deep layer dya DBDI Number of contaminants for which there are property data NCONCM Number of soil types for which there are contaminant data NSCM Number of sediment sizes for which there are contaminant data NSEDCM Start of Loop over each contaminant NCON lines CM25 CM26 CM25 CM26 CM26a CM26b CM26c CM26d 59 L F IG Is the contaminant spatially variable ISCNSV Initial concentration throughout catchment CCAPIN Initial concentration in each link CCAPIN Number of category types for grid elements NCAT Category Type for each grid element NCATTY Number of values in the depth concentration table NCAT NTAB NCAT If ISCNSV FALSE If ISCNSV TRUE If ISCNSV TRUE If ISCNSV TRUE If ISCNSV TRUE Depth below river bed of the base of this layer which must be greater than DBS There is a bug in the code so that DBDI must not equal 2 DBI Maximum of 6 allowed The entire depth concentration information is read in one category at a time before the next category is read CM26e Pairs of values of depth and concentration NCAT If ISCNSV TRUE F DTAB UJTAB CTAB JTAB JTAB
9. DUMMY 1 no longer used data must still be input 10 SD R initial snowpack depth m SM8 SM11 11 RHOSAR R specific gravity of snowpack SM8 SM14 12 ZVSPSL R initial phreatic surface level VS03 VS04 VSI file given as depth below ground level m 13 HRF R initial surface water depth OC1la OC7 given as depth above ground level m R denotes a double precision real variable I denotes an integer variable The input format for each array is similar for integer variables and for real variables Four methods of input are available allowing datasets to be set up simply and quickly while still allowing full flexibility of input if required These are controlled by an input type INTYPE Type 1 the value of the array for each bank element is given the value of the adjacent grid element The only exception to this is that ZGRUND is set to the bank full elevation of the adjacent channel link OC33 ZVSPSL is set to the depth below ground and HRF set to the depth above ground of the adjacent grid element rather than the absolute elevations Type 2 a default value is input for all bank elements Type 3 no longer used Type 4 a value is given for each individual bank element 49 Code Format Description Repeat Data Only Required Notes Count If BKI A80 TITLE BK2 L7 BINBKD BINBKD Print control parameter for printing of input data START OF LOOP OVER 13 ARRAY VARIABLES BK3 TITLE 13 BK4 217 INTYPE NVALUE 13 INT
10. HDF output data Table 1 2 File unit numbers input input input input input input optional input optional input optional input optional input time varying input time varying input time varying ASCII output ASCII output ASCII output ASCII output ASCII output unformatted output unformatted input output input initial conditions input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying input optional time varying ASCII output ASCII output ASCII output ASCII output input ASCII output HDF Output 1 6 Setting Up Catchment Data 1 6 1 General layout of data input files The catchment geometry and basic simulation control parameters are set up in the frame module FR data set Logical flags line FR25 are used to control execution of the optional bank BK snowmelt SM sediment SY and contaminant CM modules Parameter data are read in from the appropriate data file for each component or module selected The frame and the basic flow components are all mutually inter dependent and are automatically used in every simulation evapotranspiration ET overland channel OC variably saturated subsurface VS The visulisation_plan txt file is us
11. If MEASPE 1 and no other meteorological data are available MODE 3 ET8 must be used If MEASPE 1 and the full set of meteorological data are available or if MEASPE 0 MODE 1 or 2 ET8 can also be used If MODE 1 the value of RC is important If MODE 2 or 3 the necessary data are tabulated elsewhere see below ET15 ET16 MODE NF PLAI CSTCAP CK CB NRD CLAI VHT RDL 26 The mode by which actual evapotranspiration is to be calculated 1 a constant value of RC is used varying only with vegetation type 2 RC is set to vary with soil moisture tension as well as with vegetation type 3 actual evapotranspiration is derived from the dependency of the ratio of actual potential evapotranspiration on soil moisture tension Number of rows in the above mentioned table of parameters dependent on soil moisture tension If MODE 1 NF isa dummy variable The proportion of ground covered by vegetation at its maximum seasonal extent between 0 and 1 Canopy storage capacity mm Drainage parameters K and b mm s and mm respectively Number of UZ node points which lie in the root zone The canopy leaf area index defined as the ratio of total projected leaf area to area of ground covered by vegetation It can exceed unity Vegetation height m At present this is required for the snowmelt calculations only Proportion of roots that take water from the channel bank elements only If greater than
12. J XDEFH IDEF J J 1 NXDEF IDEF Width of channel corresponding to XDEFH m Depth of channel cross section above channel bed m NDEEFCT gt 0 NDEFCT 6 1 NDEFCT The first value of XDEFH must be zero The last value of XDEFH defines the bank full depth of the channel START OF CHANNEL DATA line OC36 is repeated once for each channel link defined by the arrays in FR35a FR35d in numerical order Each line may be followed by a cross section table if a unique cross section for the link is required and or further data for boundary elements if these have been defined as types 7 W 8 A 9 H 10 F or 11 P in FR35a FR35d see Table 2 1 OC35 TITLE OC36 17 3F7 0 17 IEL ZGRUNDCUEL WDEPTH STR IDEFX IEL Element number of the channel link ZGRUND Elevation of the channel bed at the mid point of the link metres above datum WDEPTH Initial depth of water in the link m STR Strickler coefficient for the link IDEFX If lt 0 ve default cross section category If gt 0 number of width elevation pairs in cross section for this link OC37 10F7 0 XINW CEL J XINHCUEL J J 1 IDEFX IDEFX gt 0 The first value of XINH XINW Width of channel cross section corresponding to XINH m OC36 must be zero The last XINH Height of channel cross section above channel bed m value of XINH defines the bank full depth of the channel Boundary type 7 and 8 weir or river and weir in parallel OC38 7X 17 4F7 0 IF
13. Reads into variable CCAPB or CCAPR corresponding to C or Cr see line CM33 NCL NINIT FNCL NINT is a FORTRAN77 intrinsic function JSOIL NINIT FJSOIL NINT is a FORTRAN77 intrinsic function CM49 CM51 CM53 CM55 CM57 CM59 CM61 62 Coefficients for exchange between water and bed for each contaminant Ops ALPHBS JCONT JCONT 1 NCONCM Reference Kd for each particle size for each contaminant kd FJCONT KDDLS JSEDS JCONT JSEDS 1 NSEDCM Coefficients for exchange between soil regions for each contaminant o FICONT ALPHAVJSOIL JCONT JSOIL 1 NSCM Fraction of adsorption sites in dynamic region for each contaminant f FICONT FADS JSOIL JCONT JSOIL 1 NSCM Fraction of pore water in dynamic region for each soil PHIDAT JSOIL JSOIL 1 NSCM Diffusion coefficient for each contaminant DIFDAT JCONT JCONT 1 NCONCM Dispersivity for each contaminant and each soil type FICONT DISPDT JSOIL JCONT JSOIL 1 NSCM NCONCM CM19 NCONCM CM19 NCONCM CM19 NCONCM CM19 JCONT NINIT FJCONT NINT is a FORTRAN77 intrinsic function JCONT NINIT FJCONT NINT is a FORTRAN77 intrinsic function JCONT NINIT FJCONT NINT is a FORTRAN77 intrinsic function JCONT NINIT FJCONT NINT is a FORTRAN77 intrinsic function 2 10 Meteorology 2 10 1 Full meteorological data This file is used only if BMETAL FALSE ET2 Data are read
14. for each station at regular time intervals DTMET ET4 NME NRAIN If NM NRAIN the rainfall and general meteorological data are assumed to be measured at the same locations and to have the same distribution across the catchment Both rainfall and general meteorological data are then read from the same line Code Format Description Repeat Data Only Required Notes Count If MEI TITLE NM NRAIN ME2 216 4G12 6 ISITE METIME P 1 RN I U PAC TAC DEL D NM Each data set occupies two 12X 3G12 6 112 VPD D IDATA lines plus an extra line for ISITE The measuring station reference number OBSPE ME3 if this is METIME This may be given as the day of the year Jan Ist 1 Dec 31st required 365 followed by the hour of the day It is not used in the program P Rainfall Rate mm hr RN Net radiation W m U Windspeed at height ZU above the ground m s PA Atmospheric pressure mb This is not currently required by the SHE program but is included for later eventualities Air temperature C TA Slope of the saturation vapour pressure temperature curve DEL mb C VPD Vapour pressure deficit of air mb IDATA A data quality indicator I Running index ME3 12X G12 3 OBSPE I NM MEASPE 1 63 OBSPE Measured potential evapotranspiration mm hr ET6 NM lt NRAIN If NM lt NRAIN the rainfall and general meteorological data are read from separate lines in the data file Thus for each time interval there are NM sets of me
15. i e squares banks and rivers squares squares only banks banks only rivers rivers only all SEDIMENT_NO integer Sediment fraction number Sediment is simulated as a set of fractions numbered 1 2 3 It is a limitation of the output that data for only one fraction is recorded per item The sediment number must be specified when a variables with S against its name in Figure 2 3 is specified in an item Sediment variables in Figure 2 3 which do not have S against their name apply to the total sediment i e all fractions combined TIMES integer If say times is set at 9 the file should contain a set of times numbered 9 and this set will be used to control when data are recorded to the item s time and value datasets Table 2 5 Properties for items in visualisation_plan txt 71 As an aid when creating and editing visualisation_plan txt files a full list of the constants and variables recognised by SV4 is automatically written to the echo file ie check_visualisation_plan txt Figure 2 3 has been copied from an echo file The constants are recorded automatically every time SV4 is run The variables to be recorded must be specified in the items in the visualisation_plan txt file Against some of the names there are characters which show that there is variation with contaminant number character C elevation E or sediment number S Next there are the units and extra dimensions an
16. iel iel 1 NLF such that IA and FC together define link element values for FA thus FA iel n FC n JA iel Category code for grid elements present only if NCAT gt 1 IG with FLAG NCAT TY IGUX TY X 1 nnnn See format IG above Analygous to component d above except that associations are made via the grid to element index array NB Bank element values are defined by association with their neighbouring grid elements provided such a neighbour exists otherwise an association is made with the opposite bank Floating point Column Element array Format name FC This is identical to FA above except that no values are required for link elements components a and d are therefore omitted Appendix B Mobile Sediment Concentration in SHETRAN The sediment component represents the concentration of sediment carried by the flow with a non dimensional quantity FDEL FDEL is the ratio of the depth that sediment would cover if it were allowed to settle to the depth of the water column In this hypothetical settling of sediment carried by the flow it is assumed that the sediment settles such that its porosity is that of the bed sediment porosity in channels or the loose sediment porosity of the hillslope The mobile sediment concentration in the surface water of an element can thus be expressed as 85 ci FDEL x p where c is the concentration of sediment in size group I mass of sediment per unit water volume FDEL is the no
17. possible and is the default level for SHEGRAPH HDFS5 files Chunking is to do with the way the data are stored for efficiency of storage and retrieval The three dimensions are defined by the dataset s attributes to see these click the attributes tab on the Properties window 76 File Window Tools Help eal eae shegraph h5 9 CATCHMENT_MAP SV4_numbering CONSTANTS centroid grid_dyy number r_span soil_typ Bi surf_elv H vert_thk VARIABLES gt 1net_rain gt 2psi gt 3theta gt 4 ovr_flow 5srf_dep gt 6s dis1 7s dis2 gt 8s dis3 gt 9s dis4 gt 10s dis5 gt 115 dis6 amp 12s dis gt 13s ver gt 149160 gt 15s t_dp 32 bit integer Chunking 29 17 9 Compression GZIP level 9 Allocation time Late Figure 3 3 General properties for dataset number 77 Figure 3 4 shows the attributes for dataset number The Value entry column 2 for element types has been clicked so that its full contents are shown in the large box squares are SV4 elements which are not banks and not river links The first two dimensions in the dataset are for the location in the catchment s grid and the third is for the element type To give an example the value at location 1 3 5 in the dataset will be for the w
18. section 3 is displayed using the standard numbering system for faces numbered 1 north 2 east 3 south 4 west The basic catchment topography catchment boundary and drainage network and geometry grid sizes basic ground surface level are set up in the FR data file The sizes of the vertical cells for the VS and CM components are set up in the VS data file The cell sizes are referred to ground level at each element Soil horizons and impermeable bed elevations are also defined in the VS file Soil horizon and impermeable bed elevations are automatically adjusted to lie on the nearest cell boundary at each grid square The detailed channel geometry cross section and channel bed elevation is set up in the OC data file A unique cross section can be assigned individually to each channel link If a group of channel links have identical cross sections they can be assigned the same cross section category code and the width elevation pairs describing the cross section need only be input once for that category The bank full elevation used to control overbank flooding is established as the elevation above the channel bed of the last value in the cross section table Two types of channel cross section are used internally within SHETRAN channel flow is calculated using the cross sections input by the user subsurface flow exchanges use an effective rectangular channel with the same cross sectional area as the input channel Bank ele
19. storing output The pathnames of the files used are set up in a rundata file with the format Main title Subtitle File pathname Subtitle File pathname If any file is omitted the subtitle must still be included with a blank line replacing the filename Example of rundata files can be seen in the SHETRAN example datasets document The order of the files and the file unit number correspond to those in Table 1 2 below File Unit Number Mnemonic Variable Not currently used Description Frame data Variable saturated subsurface data Overland channel data Evapotranspiration data Output data Snowmelt data Bank element data Sediment yield data Contaminant data Full meteorological data Precipitation Potential evaporation Time counter file Formatted flow output Formatted sediment yield output Formatted contaminant output Debug output for code develop only Graphical interface control file Hotstart file VSS initial conditions Vegetation Well abstraction Lateral subsurface flow boundary Lateral subsurface head boundary Lateral subsurface head gradient b ry Aquifer base flow boundary Aquifer head boundary Overland channel flow boundary Overland channel head boundary Contaminant migration boundary 1 Contaminant migration boundary 2 Hourly discharge at outlet Data for hotstart Mass balance data Discharge at outlet every timestep Visualisation_plan data Check visualisation plan Shegraph
20. variable of length 80 and are expected to contain some identifying code Subsequent records within a format conform to the defintions below In the following the format name is the name by which the given format may be referred to and the format identifier and input output list are as defined in the FORTRAN 77 Standard The definition of input output list items is extended here to include those embedded within an implied DO list Wherever practical list directed input output is specified in which case the format identifer is simply an asterisk Some of the following data input formats are rather complex these are best interpreted with the help of example data sets Integer List Format name Format identifier Input output list Floating point List Format name Format identifier Input output list Logical List Format name Format identifier Input output list Character List Format name Format identifier Input output list Integer Grid array Format name 83 I List of input output list items of type integer F x List of input output list items of type real or double precision L x List of input output list items of type logical Cn eg C80 where n is the length of the input output list item s into from which the data are transferred 6 AY List of input output list items of type character IG This format has an associated FLAG whose value gt 1 is a
21. zero the total of the root distribution function RDF in line ET18 is reduced to 1 RDL ET9 ET10 ETI ET12 ET13 ET14 27 20A4 417 MODECS MODEPL MODECL MODEVH 20A4 17 NUMCST 20A4 2G7 3 RELCST TIMCST J TITLE MODECS 1 MODEPL I MODECL I MODEVH 1 1 time varying CSTCAP 0 otherwise 1 time varying PLAI 1 time varying CLAI 1 time varying VHT TITLE NUMCST D Number of rows in the table giving the variation of the parameter with time TITLE RELCST J TIMCST I J Ratio of value of CSTCAP at time TIMCST to the initial value of CSTCAP at time zero specified on record ET Specified time days Row index NV NV NV NV NV NV NUMCST FR29 ET12 MODECS 1 ET 10 similarly for MODEPL MODECL MODEVH If all the MODEs are zero no further data concerning a time varying parameter are necessary However if any of the MODEs are 1 the following data are needed for the parameter in question This is illustrated by reading time varying CSTCAP below The last value of TIMCST must exceed the length of the simulation period and the differences between successive values of TIMCST must exceed the difference between successive values of METIME Lines ET11 ET14 may be repeated for other time ET15 ET16 28 2044 377 2 PS1 RCF FET NI TITLE NV PS1 RCFA J FET LJ J 1 N1 NV Soil moisture tension m
22. 10 so that the one character format is sufficient If the number of categories is greater than or 12 equal to 10 a full grid format is automatically used in the format I7 IY IY row number in descending order 2014 IDUM J IY J 1 NX IDUM input array NX number of grid squares in x direction Distributed data for the bank elements are input separately in the bank component data file Although the bank module is part of the frame component its use is optional so its input data file format is presented after those for the water flow component in this manual In many cases the input of distributed data can be simplified by defining categories of types each sharing a common data value The indication of a category value for an element rather than an individual value is generally achieved by using a negative category code rather than a positive element number See for example the use of default channel cross sections OC30 OC34 and the use of category codes in the time varying boundary conditions in the OC and VS components Many of the lines of input data must be repeated either as single lines eg meteorological grid codes FR44 or as groups of data e g vegetation parameters ET7 ET18 These are indicated in the format descriptions by a repeat count including reference to the line where the repeat count number is input Depending upon the options chosen and the complexity of the input data set some lines of th
23. ACE COEFF SUBRIO ZSILL ZL Type 7 W or 8 A IFACE Element face number 1 4 at which the weir is located COEFF Weir coefficient SUBRIO Submergence ratio ZSILL Elevation of the sill of the weir metres above datum ZL Water surface elevation downstream of weir external boundary elements only 35 Boundary type 9 time varying head boundary 0 9 7X 17 NCAT Type 9 H NCAT Head boundary category code Boundary type 10 time varying flow boundary OC40 7X 217 IFACE NCAT Type 10 F IFACE Element face number 1 4 through which boundary flow is specified NCAT Flow boundary category code Boundary type 11 polynomial function boundary OC41 7X 17 5F7 0 IFACE A B C D E Type 11 P IFACE Element face number 1 4 through which boundary flow is specified A E Coefficients of polynomial function Q AH BH CH DH E where H is the water depth m in the element 36 2 5 2 5 1 Code VSO1 VS02 VS03 37 Variably Saturated Subsurface Module Variably saturated subsurface data VSD file Format C80 C80 C80 BFAST BSOILP BHELEV C80 C NS NCSZON NCRBED INITYP Description Repeat Data Only Required Count If VSD file title TITLE Logical Flags BFAST BSOILP BHELEV TRUE set up simulation cell sizes and numerical parameters for fast simulation FALSE set up for slow accurate simulation TRUE print soil hydraulic tables
24. B VSZWLT C80 C Number of spring elements Number of categories for lateral flow boundary conditions Number of categories for lateral head boundary conditions Number of categories for lateral head gradient boundary conditions Number of categories for bottom flow boundary conditions Number of categories for bottom head boundary conditions Number of categories for bottom free drainage boundary conditions Number of well elements NW Number of well elements Well element data IEL NVSWLC IWT NW Element number of the well Well element category number Target element for the water from the well Well screen data VSZWLB VSZWLT NW Depth below ground m of bottom of well screen Depth below ground m of top of well screen Number of spring elements Dummy NVSWL gt 0 NVSWL gt 0 NVSWL gt 0 NVSWL gt 0 NVSWL gt 0 NVSWL gt 0 NVSSP gt 0 NVSSP gt 0 If IWT is less than or equal to zero the water from the spring is removed from the catchment VS13a C80 C IEL NVSSPT VS13b C80 9 VSSPD VSSPZ VSSPCO VS14 C80 IG VS15 C80 IG 43 Spring element data IEL NVSWLC IWT NVSSP Element number of the spring Target element for the water from the spring Spring element properties VSSPD VSSPZ VSSPCO NVSSP Depth of the spring source below ground m Elevation of discharge point m Spring coefficient Distribution grid for types of lateral boundary conditions Integer
25. GRIDG TY J 1 NX NY Integer array see introduction FR3 Model grid line TY used for checking the data Computation grid code It can be given the following values 1 Normal computational element inside the model area 0 Element outside the model area where no computation or data are required TITLE IY LCODEX J TY J 1 NX 1 NY The flow code which defines the boundaries between grid overland elements in the West East direction or river links running North South for model line IY see Table 2 1 If the value of any of the parameters is zero a corresponding array of codes for all grid elements is entered below note that bank data are entered separately If a value is non zero this is used as the default value for all grid elements In the current version the size of the grid is limited to 72 elements in the x direction FR35c 20A4 TITLE FR35d 17 1X 72A1 TY LCODEY J TY J 1 NX NY 1 LCODEY The flow code which defines the boundaries between grid overland elements in the North South direction or river links running West East for model boundaries below line IY see Table 2 1 Code Mnemonic Description Impermeable boundary Internal overland flow Overland head boundary Overland flux boundary Overland polynomial function boundary River link Weir link River and weir in parallel River head boundary River flux boundary River polynomial function boundary R W A H F P
26. Grid See Appendix A for NLBTYP The following codes are used in the integer grid 3 lateral flow boundary condition 4 lateral head boundary condition 5 lateral head gradient boundary condition Distribution grid for category numbers for lateral boundary conditions Integer Grid See Appendix A for NLBCAT Category types for lateral flow head and head gradient boundary conditions NVSSP gt 0 NVSSP gt 0 NVSSP gt 0 NVSSP gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 NVSLE gt 0 or NVSLH gt 0 or NVSLG gt 0 NVSLE gt 0 or NVSLH gt 0 or NVSLG gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 If NVSSPT is less than or equal to zero the water from the spring is removed from the catchment The FLAG for the format of the input is the maximum of NVSLF NVSLH NVSLG Each element in the catchment can be given only a single lateral boundary condition Non zero values in the grid must correspond to non zero values in VS16 VS1l6a VS16b VS17 44 C80 C NLB C80 ITYPE ICAT NLDUM C80 NVSL C80 Number of lateral boundary categories with boundary conditions set only on selected layers NLB Number of categories Boundary condition type category number and number of layer ITYPE ICAT NLDUM Boundary condition type either 3 4 or 5 corresponding to NLBTYP Category number corresponding to NLBCAT Number of layers Layer numbers
27. M 1 is selected The location of each meteorological station within the catchment is required to allow for the effect of snowpack depth on the sampling of windspeed 48 SM12 SM13 SM14 20A4 F7 1 UNIFSD 20A4 17 IY 10F7 0 SD 20A4 17 IY 10F7 0 RHOSAR TITLE UNIFSD Uniform initial snowpack depth mm TITLE IY Model grid line IY used for checking SD J IY J 1 NX NY Snowpack depth mm at all elements on the model line IY TITLE IY Model grid line IY used for checking RHOSAR J IY J 1 NX Specific gravity of snowpack at all elements on the model line IY NY NY NY NY NSD 0 SM4 NSD 1 SM4 NSD 1 SM4 2 7 Bank Element Module The data for bank elements consist of arrays of data already read in for grid or channel elements in the other components There are 13 array types each of which must be assigned values or dummy values even if the array is not used or set up in the other components 1 ZGRUND R ground surface elevation metres above datum FR39 2 NMC 1 meteorological station codes FR33 FR44 3 NRAINC 1 rainfall station codes FR33 FR47 4 NVC 1 vegetation codes FR33 FR50 5 DUMMY 1 no longer used data must still be input 6 STRX R Strickler coefficient in x direction OC2 OC3a OC4 OC16 7 STRY R Strickler coefficient in y direction OC2 OC3a OC4 OC19 8 DUMMY 1 no longer used data must still be input 9
28. SHETRAN Standard Version V4 4 1 User Guide and Data Input Manual EXECUTIVE SUMMARY This report contains detailed information on the setting up and use of the hydrological flow sediment transport and contaminant migration catchment modelling system SHETRAN Version 4 4 1 SV4 4 1 There are three main sections to the report The first section describes the basics of setting up and running a SHETRAN simulation The next section consists of a detailed layout of the input data formats required by SHETRAN This includes details for the flow sediment and contaminant components including initialisation parameters time varying meteorological data and boundary data used during a simulation run The inter dependence between input parameters is clearly described The final section describes the SHETRAN output and the method to view the results ii CONTENTS 1 INTRODUCTION TO RUNNING SHETRAN 11 SHETRAN Basics 1 2 Command line options 1 3 SHETRAN modules 1 4 SHETRAN Array Sizes 1 5 SHETRAN Rundata file 1 6 Setting Up Catchment Data 1 6 1 General layout of data input files 1 6 2 Catchment geometry 1 6 3 Output 1 6 4 Sediment and contaminant components 1 6 5 Time varying boundary data files 1 6 6 Error handling 2 DATA INPUT FILE FORMATS 2 1 Introduction 2 2 Frame Module 2 3 Evapotranspiration Interception Module 2 4 Overland Channel Module 2 5 Variably Saturated Subsurface Module 2 5 1 Variably saturated subsurface data
29. TRUE boundary condition head data are elevations FALSE boundary condition head data are depths below ground Integer Parameters NS NCSZON NCRBED INITYP Number of soil lithology types Number of cells in the soil zone Number of cells below the river bed Type of initial conditions equilibrium profile of potentials with uniform phreatic surface depth below ground given by VSIPSD VS04 2 equilibrium profile of potentials with phreatic surface elevations for each element from from the VS initial conditions file VSD 3 potentials for each cell in each column read from the VS Notes VS04 VS05 38 C80 9 VSIPSD VSZMIN VSZMAX VSWV VSWL C80 9 IS IVSFLG IVSNTB initial conditions file VSD Real Parameters VSIPSD VSZMIN NSZMAX VSWV VSWL Initial depth of phreatic surface below ground m read for INITYP 1 only VS03 Minimum depth of a cell m Maximum depth of a cell m Value for w in the w mean averaging of vertical hydraulic conductivity Value for w in the w mean averaging of lateral hydraulic conductivity Physical property data IS IVSFLG IVSNTB NS Soil type Flag for soil hydraulic property functions 1 van Genuchten 2 user defined tables 9 and K 3 exponential functions 4 user defined table for 9 and Averjanov function for K 6 y Number of values in soil property tables only used for IVSFLG 2 or 4 K Ky Kz Gap Ores Ss D 0 NS
30. The identifying code eg X Y41 specified for the composite format applies directly to the initial component below subsequent components have the code augmented by their identifying letter eg XY4la Determines the specification method I Input output list NCAT interpreted as follows Note Component a 84 gt 0 number of user defined categories 0 no categories use direct values lt 0 special option eg values derived from data defined elsewhere The following two components where present are repeated as a pair N2 times with subscipt n increasing from 1 to N2 Link element values present only if NCAT 0 and the number of link elements is non zero Format Input output list Component b Format Input output list Component c Format Input output list Component d Format Input output list Component e Format Input output list F FAGel n iel 1 NLF where NLF is the number of channel link elements Grid element values present only if NCAT 0 FG TY FA CIX IY X 1 nnnn See format FG above Grid element values for the array FA with second subscript fixed at n are defined in terms of FG values via SHETRAN s grid to element conversion array Values for each category present only if NCAT 0 F FC n cat n 1 N2 cat 1 NCAT where FC is used temporarily to hold the values Category code for link elements present only if NCAT gt 1 and NLF gt 0 I A
31. VSD file 2 5 2 Variably saturated subsurface initial conditions VSI file 2 6 Snowmelt Module 2 7 Bank Element Module 2 8 Sediment Transport Component 2 9 Contaminant Migration Components 2 10 Meteorology 2 10 1 Full meteorological data 2 10 2 Precipitation data 2 10 3 Potential Evaporation data 2 11 Time Varying Boundary Conditions 2 12 Specification of Output Data 3 SHETRAN RESULTS ill oMoOOONNN 12 14 23 30 37 37 46 47 49 52 58 63 64 64 66 68 3 1 Introduction 3 2 Catchment_Map and Catchment_Spreadsheet 3 3 Constants 3 4 Variables Appendix A Data File Formats for the Sediment and Contaminant Transport Components Appendix B Mobile Sediment Concentration in SHETRAN TABLES Table 1 1 Array sizes Table 1 2 File unit numbers Table 2 1 Overland channel flow codes Table 2 2 Time varying boundary data files Table 2 3 Special characters that can be used in visualisation_plan txt Table 2 4 Special lines that can be used in visualisation_plan txt Table 2 5 Properties for items in visualisation_plan txt Table 3 1 Constants recorded in shegraph h5 file Table 3 2 Data Types dimensions that can be recorded for grid datasets FIGURES Figure 1 1 File select window Figure 2 1 Specification of grid size Figure 2 2 Example visualisation plan Figure 2 3 Constants and variables recognised for SHETRAN output Figure 3 1 Shegrpah h5 file showing the SV4_numbering in Catchment_Map Figu
32. VSZMIN and VSZMAX are only used for the aquifer zone where cell sizes are set up automatically Values for VSWV or VSWL of 0 0 correspond to a weighted harmonic mean and a value of 1 0 corresponds to an arithmetic mean The use of other values may significantly increase simulation times due to the calculation of the exponents IF IVSFLG 2 then n and VSO5a VS06 VS07 39 E AA A 3 2 RB NODO IS C Y C80 C DCSZON C80 CG DCRBED Saturated hydraulic conductivity in the x direction m day Saturated hydraulic conductivity in the y direction m day Saturated hydraulic conductivity in the z direction m day Volumetric saturated soil water content porosity Volumetric residual water content Sprecific storage Van Genuchten n parameter Van Genuchten amp parameter IS Soil type Y 0 K Soil water potential m Volumetric soil moisture content Relative hydraulic conductivity Soil zone cell sizes DCSZON I 1 1 NCSZON Depths to the bottom of cells in the soil zone starting at the ground surface River bed cell sizes DCRBED I I 1 NCRBED Depths to the bottom of cells in the river bed starting at the For each soil type IS for which IVSFLG 2or4 IVSNTB IS for each soil type IS for which IVSFLG 2or4 NCSZON gt 0 NCSZON gt 0 NCRBED gt 0 NCRBED gt 0 Q are not used IF IVSFLG 3 then amp is the exponent for the exponential functi
33. X 1 FR12 20A4 FR13 F7 0 17 4L7 F7 0 DTAO IAOUT BINFRP BFRTS1 BFRTS2 BSTORE PSTART 17 TITLE DTAO IAOUT BINFRP BFRTS1 BFRTS2 BSTORE PSTART Timestep hours between print output of results This applies only to the end results of the computations in each component as described below 1 gives a molecular print at DTAO intervals where all results for each point are printed together Results at all model points are obtained 2 gives a print of selected results at DTAO intervals where each result for the whole model area is printed as a separate array This option is usually used TRUE for a print of all the data read and set up by the frame during its initialisation phase TRUE for a screen output of the calculation sequence during the simulation TRUE for a print of all the data passed from the frame to the components and back to the frame at each timestep TRUE for the old method of outputting result data Start time hours for printing of results on PRI file FR20 FR21 18 20A4 4F7 0 0L7 PMAX PALFA QMAX TMAX BSOFT TITLE PMAX PALFA QMAX TMAX Maximum rainfall volume mm allowed in one timestep hours Rate of increase of timestep after reduction The timestep is increased until the basic timestep TMAX is reached Maximum river discharge m s allowed in one timestep Basic timestep hours TRUE to activate soft start facility P
34. YPE Type of input for this array variable 1 set to adjacent value 2 set to default value 3 no longer used 4 assign value for each bank element NVALUE No longer used INTYPE 1 No further input required for this array variable 50 INTYPE 2 integer variable BKS 17 IFAULT IFAULT Default value used for all bank elements real variable BK6 F7 0 DFAULT DFAULT Default value used for all bank elements INTYPE 4 integer variable BK9 1017 ELEM 1 IVALUE D I 1 2 NLF IELEM Bank element number IVALUE Value to be used for bank element IELEM NLF Total number of channel links calculated automatically from definition arrays FR35b and FR35d Note that there are 2 NLF bank elements real variable BK10 5 17 F7 0 AELEM I VALUE I I 1 2 NLF TELEM Bank element number VALUE Value to be used for bank element IELEM NLF Total number of channel links END OF LOOP OVER 13 ARRAY VARIABLES 51 INTYPE 2 BK4 INTYPE 2 BK4 INTYPE 4 BK4 INTYPE 4 BK4 2 8 Sediment Transport Component The sediment input parameters are organized into groups SY01 02 preliminary parameters SY11 12 static variables SY21 24 sediment soil and vegetation properties SY31 32 channel element properties SY41 43 hillslope element properties SY51 53 initial parameter values for all elements SY61 64 boundary conditions Format A description of the format in which the data should be entered is gi
35. ame Where executable is SV4 executable e g sv4 4 1 exe option is c or f standing for catchment and 116 name is a filename or catchment name For option c the file catchments txt is searched for the catchment name Examples Say the current directory contains the executable SV4 4 1 and a file called catchments txt which contains only the following 6 lines of text default c valsa rundata rundata val slapton c slapton rundata rundata sla valsa c valsa rundata rundata val Then the outcome is as follows Command Line Entry Outcome SV4 4 1 exe brings up a popup window which asks for the rundata filename SV4 4 1 exe c runs the default i e valsa SV4 4 1 exe c slapton runs slapton SV4 4 1 exe c valsa runs valsa SV4 4 1 exe runs slapton c slapton rundata rundata sla SV4 4 1 f runs ouse Note filename for f option does C ouse rundata rundata ouse not need to be listed in catchments txt file 1 3 SHETRAN modules SHETRAN consists of 8 main modules FR Frame module ET Evapotranspiration module OC Overland channel module VS Variably saturated subsurface module BK Bank module optional SM Snowmelt module optional SY Sediment erosion and transport module optional CM Contaminant transport module optional 1 4 SHETRAN Array Sizes SHETRAN is written mainly in FORTRAN 90 Array sizes are specified before running SHETRAN the dimensions of the main arrays mu
36. and STRY see below OC14 OC19 Time hours for start of print control output for KONT gt 1 Time hours for termination of print control output for KONT gt 1 Homogeneous detention storage parameter metres applied all over the grid not currently used CATR I NCATR CDRS 0 OC3a and Roughness coefficient attached to category I m s NCATR 0 1 TITLE BIOWAT TRUE IY NY 1 Model grid line TY used for checking the data HRFG TY J 1 NX NY Initial depth of overland water m at all elements in model line NY The values of PT and TEMPS in line OC2a are presently not used as the timestep specification is made in the FRAME dataset The distribution of the categories is read later see STRX and STRY below 14 0 19 OC14 0 15 0 16 0 17 0 18 0 19 OC20 OC21 OC22 OC23 32 20A4 17 10B7 0 STRX 20A4 17 10B7 0 STRY 20A4 317 NOCHB NOCFB NOCPB 20A4 17 1X 7211 IDUM TITLE IY STRX J TY J 1 NX For NCATR 0 table of roughness parameters for each grid square for model line IY For NCATR 0 table of category belonging to each grid square for model line TY NB these integers are input in I7 format TITLE IY STRY GJ TY J 1 NX Analogous to STRX in y direction TITLE NOCHB NOCFB NOCPB Number of head boundary categories Number of flux boundary categories Number of polyno
37. arameters PMAX and PALFA are hardcoded PMAX 1 0 PALFA 0 15 Values entered into the frd file are ignored The maximum allowable value for TMAX is 2 hours The soft start facility shortens the timestep at the start of the simulations the enable the system to cope with imbalances in initial conditions FR22 20A4 FR23 10L7 BPPNET BPEPOT BPQOC BPDEP BPQF BPQH BPQSZ BPHSZ BPBAL BPSD FR24 20A4 FR25 4L7 BEXSM BEXBK BEXSY BEXCM 19 TITLE BPPNET BPEPOT BPQOC BPDEP BPQF BPQH BPQSZ BPHSZ BPBAL BPSD Indicators of which results are required to be printed at the DTAO intervals TRUE for net rainfall TRUE for potential evapotranspiration TRUE for overland flows TRUE for depths of overland flows TRUE for river levels and flows TRUE for infiltration TRUE for saturated zone flow TRUE for phreatic surface level TRUE for mass balance state TRUE for printing snowpack depth temperature and snowfall TITLE BEXSM BEXBK BEXSY BEXCM Component execution control parameters TRUE if the SM component is to be included in the simulation For the BK component For the SY component For the CM component The frame component FR and the basic flow modules ET OC VS are automatically run for every simulation The bank BK and snowmelt SM flow components may be omitted if not required If the CM component is included ho
38. ariable name e g psi and the item number specified by the user in the visualisation_plan txt file Dataset 2 psi Figure 3 5 is for Three by three SV4 grid dimensions 0 and 1 layers 55 to 25 dimension 2 33 times dimension 3 79 File Window Tools Help Sam shegraph h5 9 CATCHMENT_MAP SV4_numbering CONSTANTS centroid B grid_dxy E number i r_span B soil_typ E surf_elv B vert_thk VARIABLES gt 1net_rain 2psi time Spale gt Q 3theta S 4 ovr_flow 5srf_dep gt 6s _dis1 gt 7s_dis2 gt 8s dis3 95 dis4 gt 10s dis5 gt 115 dis6 gt 12s dis7 gt 135 ver TableView D shetranPCv4iexamples Cobres outputishegraph h5 VARIABLES 2 psitime 10 324 61465 yt 372 28513 42 420 64655 468 44656 Properties VARIABLES 2 psi value General attributes Number of attributes 10 Soil water potential String length 70 Saag 516 5678 ea String length 8 564 5678 6612 660 5678 SESS m grid_as_grid String length 12 squares String length 7 row column layer 1 90109 length 6 10 12 32 bit integer 6 8 32 bit integer 55 25 32 bit integer has its own dataset 90109 length 19 M String length 1 22 900 2 948 1867 24 joos 26 10441866 26 11092 2711401866 28 11881866 29 12364312 12044312 13804312 Figure 3 5 Data
39. ave been read in If TRUE the reading procedure for the PRD and EPD data files is used TITLE DTMET DTMET2 DTMET3 Timestep hours for updating of full meteorological data MED file Timestep hours for updating of precipitation data PRD file Timestep hours for updating of potential evaporation data EPD file If BMETAL is TRUE only potential evapotranspiration is available and MODE 3 ET8 must be used ETS ET6 20A4 1017 MEASPE TITLE MEASPE I I 1 NM Control parameter 1 potential evapotranspiration is measured and is read from meteorological file 0 potential evapotranspiration is not measured START OF LOOP OVER VEGETATION TYPES NV lines ET7 ET18 ET7 ET8 25 20A4 L7 5F7 0 17 17 4F7 0 17 3F7 0 I BAR RA ZU ZD ZO RC TITLE NV BAR I RAC ZUD ZD ZOD RC MODE D NF D FR29 PLAI I CSTCAP I CK D CB NRD D CLAI D NV VHT D RDL D Running index for vegetation type Logical variable which determines how the aerodynamic resistance RA is to be evaluated If TRUE a value of RA does not need to be specified but values for ZU ZD and ZO are required If FALSE a constant value of RA is used and must be specified but values of ZU ZD and ZO are not required Aerodynamic resistance s m Height of the anemometer above the ground m Zero plane displacement m Roughness height of the vegetation canopy m Canopy resistance s m
40. cient ABC m s h PS Steady sediment rating curve coefficient BBC DLS iel iel 1 NEL FBETA iel sed iel 1 NEL s ed 1 NSED FDEL iel sed iel 1 NEL sed 1 NSED NS YB NSYC type type 1 4 NSYBCD bel i i 1 3 bel 1 NSYB GBC sed cat sed 1 NSED Cat 1 NSYC 1 ABC sed cat BBC sed cat sed 1 NSED cat 1 NSYC 3 NSYB gt 0 NSYC 1 gt 0 amp NSYB gt 0 NSYC 3 gt 0 amp NSYB gt 0 Notes NSED ISGSED ISTEC ISSYOK ISACKW ISUSED NFINE FPCRIT 55 This integer should be in the range 1 to NFINE 6 However the upper limit is actually defined by the array sizes used Enter 0 to instruct SHETRAN to use the Yalin formula to calculate the overland flow sediment transport capacity or 1 for the Engelund Hansen formula Any other value gives rise to a transport capacity of zero Note a both formulae were derived for noncohesive sediment transport in channels and their appropriatness for overland flow is in question especially during rainfall when they are expected to under predict concentrations amp b both formulae are bounded by FPCRIT see below Enter to instruct SHETRAN to use a simple formulae based on fractional clay content to calculate critical shear stress for flow erosion or any other number for the Shields formula The first check is on the first non initilization call to the SY component Values less than 1 give no checking Enter 0 to instruct SHETRAN t
41. cified to limit the recording to gridsquares streambanks or river sections The frequency of recording can vary through time following complex patterns specified using pairs of time steps and end times 3 2 Catchment Map and Catchment_Spreadsheet There are three parent directories CATCHMENT_MAP CATCHMENT_SPREADSHEET CONSTANTS and VARIABLES in a shegraph h5 file Double clicking on Catchment_map brings up the SV4_elevations heading Right clicking on the name and selecting open as from the drop down menu brings up a map of the elevations Double clicking on Catchment_map brings up the SV4_numbering heading Right clicking on the name and selecting open as from the drop down menu brings up a Dataset Selection window The main choice to be made is then whether to view the data on a spreadsheet or as a 2 dimensional plot 74 clicking either the spreadsheet or image button Select the image button and a Rainbow palette and a Figure similar to 3 1 should be visible In the Image window selecting image and show_value from the drop down menu enables the SHETRAN element number to be seen using the mouse HDF View File Window Tools Help a lle eo gaa 5 shegraph hS ImageView D shetranPCv4 examples Cobres output shegraph h5 CATCHMENT_MAP SV4_numbering CATCHMENT_MAP fme MAA SV4_numbering gt CONSTANTS amp VARIABLES Figure 3 1 Shegrpah h5 file showing the SV4_numbering in Catch
42. d finally the full title as it appears when the data is displayed Full list of constants recorded in the HDF5 file E varies with subsurface elevation soil_typ E Soil type surf_elv Elevation of surface vert_thk E Cell vertical thickness r_span radial spans measured along radial from gridsquare centroid number Index number centroid coordinates of cell centroid Grid thicknesses Full list of variables that can be recorded in the HDF5 file E varies with subsurface elevation C varies with contaminant no S varies with sediment fraction no net_rain mm hour Net rainfall pot_evap mm hour Potential Evapotranspiration trnsp mm hour Transpiration srf_evap mm hour Evaporation from soil surface int_evap mm hour Evaporation from intercepted storage drainage mm hour Drainage from intercepted storage can_stor mm Canopy storage v_flow m s Vertical flows snow_dep mm Snow pack depth ph_depth m Phreatic depth below surface ovr_flow m3 s Overland flow srf_dep m Surface water depth psi m Soil water potential theta m3 m3 Soil water content s_t_dp mm Total depth of sediment S_v_er mm day Rate of ground surface erosion s_dis kg s Sediment discharge rate c_c dr Rel conc in soil dynamic region c_cds Rel conc in soil dead space bal_err m Water mass balance error Figure 2 3 Constants and variables recognised for SHETRAN output 72 Lists masks and time sets can be entered in any order A mask is a logical array which covers a recta
43. d to each element Boundary conditions may not be specified for bank elements other than regional aquifer flows 1 6 6 Error handling SHETRAN is a highly flexible modelling system capable of simulating hydrological flow and transport for a wide variety of catchment sizes and configurations In order to retain this degree of flexibility as few restrictions as possible have been imposed on the relationships between parameter values for each of the components and on the catchment geometry including the sizes of the elements and vertical cells It is the user s responsibility to ensure that data sets are self consistent and physically plausible The use of parameter values outside physically realistic bounds and the use of inappropriate modelling parameters such as tolerance criteria or grid spacings is likely to result in physically unrealistic inaccurate or unstable simulations Any user of SHETRAN should therefore have sufficient hydrological and modelling experience to use the complexities of the system correctly A minimum amount of necessary checking of the input data files is made where obvious inconsistencies may occur In addition the simulation is monitored and messages written to the print output files PRI SPR and CPR Each message is given a unique number which is printed along with the element and cell numbers where applicable the simulation time and a short error message on the same line The first digit of the e
44. different categories of roughness parameters in the grid squares gt 0 the roughness parameter distribution across the model area is defined by the distribution of the categories read in STRX and STRY OC14 19 and CATR 4 0 the roughness parameter distribution across the model area is defined directly by the values read in STRX and STRY if CDRS 0 OC3a or by the value of CDRS if it is greater than zero Print control parameter 0 no print 1 print of initialisation data and initial phase results 2 print from simulation phase only 3 extensive print from both phases If TRUE then initial overland flow levels are entered below OC5 OC7 If FALSE then no initial overland flow exists Notes KONT determines only output from the OC routines the output of results from the FRAME are often sufficient during the simulation phase OC2 OC2a OC3 OC3a OC4 OCS 0 6 OC7 31 20A4 10F7 0 PT TEMPS 20A4 5F7 0 SMIN CDRS TDC TFC DET 10F7 0 CATR 20A4 14 IY 10G7 0 HRF TITLE PT TEMPS D I 1 NT Timestep hours for the OC computations Corresponding end time hours for validity period of timestep PT TITLE SMIN CDRS TDC TFC DET Minimum surface area of a river node not used Default value of overland flow roughness parameter gt 0 The value of CDRS will be used in all grids 0 The roughness parameters will be defined by STRX
45. e data files may be omitted These lines need only be included if the condition under the data only required if column is true This column includes a reference to the line where the condition variable is set Note that the condition is entered against the title line of a group of data items but refers to the whole group of items For example the meteorological grid code array lines FR43 FR44 need only be input if no default code has been entered i e IDMC is zero in line FR33 13 2 2 Frame Module Code Format FRI 20A4 TITLE FR2 20A4 TITLE FR3 NX NY FR4 ERS ISYEAR ISMTH ISDAY ISHOUR ISMIN FRO FR7 IEYEAR IEMTH IEDAY IEHOUR IEMIN 14 Description Repeat Count TITLE General title for the simulation TITLE Description of data on the next line s NX NY Number of grid squares in the x direction Number of grid squares in the y direction TITLE ISYEAR ISMTH ISDAY ISHOUR ISMIN Start year of simulation Start month of simulation Start day of simulation Start hour of simulation Start minute of simulation TITLE IEYEAR IEMTH IEDAY IEHOUR IEMIN End year of simulation End month of simulation End day of simulation End hour of simulation End minute of simulation Data Only Required If Notes NX and NY should be set equal to the maximum number of active grid squares plus 2 in each of the two directions FR7a FR7b FR7c FR7d
46. e link elements NCAT gt 1 BEXBK TRUE and NLF gt 0 NCAT gt 1 NCAT gt 1 IVSCAT I 0 for any element IVSCAT D 0 for any element IVSCAT I 0 for VS09 VS09a VS10 VS10a VS11 41 IVSDUM RVSDUM C80 ISRBED C80 c DRBED C80 NAQCON C80 IAQCON C80 NVSWL Soil lithology type of each layer RVSDUM I 1 NLAYER NELEM Depth to the bottom of layer I starting at the bottom layer Soil types for river links ISRBED I 1 NLF Soil types for river beds Soil depths for river links DRBED I 1 NLF Soil depth for river beds Aquifer zone user defined connectivity NAQCON Number of user defined aquifer connectivity lines Aquifer zone user defined connectivity data IAQCON LJ I 1 4 J 1 NAQCON User defined connectivity Boundary conditions categories NVSWL NVSSP NVSLF NVSLH NVSLG NVSBF NVSBH NVSBD Number of categories for well elements any element IVSCAT I 0 for any element BEXBK TRUE and NLF gt 0 BEXBK TRUE and NLF gt 0 BEXBK TRUE and NLF gt 0 BEXBK TRUE and NLF gt 0 NAQCON gt 0 NAQCON gt 0 If NAQCON 1 and the values input are 1 1 2 2 Then element 1 layer 1 is connected to element 2 layer 2 VS12 VS12a VS12b VS13 42 NVSSP NVSLF NVSLH NVSLG NVSBF NVSBH NVSBD C80 NW C80 IEL NVSWLC IWT C80 C VSZWL
47. ed in every simulation and specifies the items to be recorded when they are to be recorded and for which locations in the catchment Meteorological data are read in throughout the simulation Two methods of reading in the meteorological data are available controlled by a logical flag in the ET data file line ET2 full sets of meteorological data at regular intervals MED file or precipitation PRD file and potential evapotranspiration EPD file also read in at regular intervals Time varying boundary conditions can be set up for the VS and OC components The flags controlling these are in the parameter files for each of these components All the boundary condition data files time varying heads or flows are set up in a standard format 1 6 2 Catchment geometry Three types of elements are used to describe the finite difference representation of a catchment basic elements often called grid elements or grid squares although they may be non square rectangles note however that graphically only squares can be depicted as the basic element bank elements and channel links At the start of the initialisation phase of a simulation each element is assigned a unique element number which is used both for data input and internally throughout the program Each element has four faces numbered 1 east 2 north 3 west 4 south These are used to define OC boundary data e g weir locations Output data in the shegraph h5 file
48. er up to a depth of DCBEDO provided there is enough available Note a where there is significant deposition of sediment in a channel link element sediment concentration will be very sensitive to DCBEDO and b DCBEDO determines the depth of sediment available for suspension within one time step making simulation results dependent on the time step length This should be a list of representative sediment diameters in meters for each sediment size group The list should be in increasing order beginning with a maximum of one diameter representing fine material This should be set to equal 1 THSAT Psea Where Pseq is the density of the sediment particles usually 2650 kg m and THSAT is the saturated soil moisture content and is specified by the user in the uzd file There is a general note about the densities used by the sediment code in Appendix B This parameter is not used if the critical shear stress is calculated using the Shields formula This represents the composition of soil before it is eroded It should be a list of NSED numbers some of which can be 0 0 The first number is the fraction by mass of soil in the smallest size group the last is the fraction in the largesr size group and the sum of the numbers in each row should be 1 0 each fraction should correspond to a representative sediment particle diameter given for DRSED Note that all values of DRDRIP must be non zero even for a vegetation type representating bare soil or rock
49. est bank because element type 5 is W bank for the gridsquare at row 1 and column 3 in the catchment s grid Had for example the dataset been for a grid section with say row and column limits of 4 29 and 5 17 then the value at location 1 3 5 would have been for the west bank for row 4 and column 7 in the catchment s grid Datasets for grids can have up to 6 dimensions and these can be seen in Table 3 2 For lists the maximum number of dimensions is 5 Element list Element type Layer Extra and Time Properties CONS TANTS number General Attributes Number of attributes 8 Add Delete Array Size Index number String length 50 String length 8 igrid_as_grid 91108 length 12 CC all String lengths names of dimensions row column el_typ String length 6 row limits 1 29 32 bit integer column limits 117 32 bit integer element types square N bank E blank 4String length 6 4 a a N ho oo S a square N bank E bank S bank 020 64 N link E link S link VW link Figure 3 4 Attributes for dataset number 78 Row Column Element type Layer Extra Time By convention HDF5 rows are numbered top to bottom i e North to South starting at 1 Columns are numbered left to right i e West to East starting at 1 This is relevant only if the scope is banks rivers or all in which cases it will respectively have exten
50. for each category NVSL I 1 NLDUM Layer numbers fir each boundary condition and category type Distribution grid for types of bottom boundary conditions NLB NLB NLB NLB NLBTYP NVSLE gt 0 or NVSLH gt 0 or NVSLG gt 0 NVSLE gt 0 or NVSLH gt 0 or NVSLG gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 and NLB gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 and NLB gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 and NLB gt 0 NVSLF gt 0 or NVSLH gt 0 or NVSLG gt 0 and NLB gt 0 NVSBF gt 0 or VS18 45 IG C80 IG Integer Grid See Appendix A for NBBTYP The following codes are used in the integer grid 6 bottom flow boundary condition 7 bottom head boundary condition 8 bottom free drainage boundary condition Distribution grid for category numbers for bottom boundary conditions Integer Grid See Appendix A for NBBCAT Category types for bottom flow head and free drainage boundary conditions NVSBH gt 0 or NVSBD gt 0 NVSBF gt 0 or NVSBH gt 0 or NVSBD gt 0 NVSBF gt 0 or NVSBH gt 0 or NVSBD gt 0 NVSBF gt 0 or NVSBH gt 0 or NVSBD gt 0 The FLAG for the format of the input is the maximum of NVSBF NVSBH NVSBD Each element in the catchment can be given only a single bottom boundary condition Non zero values in the grid must correspond to non zero values in NBBTYP 2 5 2 Variably saturated
51. gory are input in the data files for the relevant component The six types of boundary data files are given in Table 2 2 Description Units Number of Categories File Only Read If Pumping well m s NVSWL VS11 NVSWL gt 0 Lateral subsurface flow boundary m s NVSLF NLB D I 1 NVSLF VS11 NVSLF gt 0 and VS16 Lateral subsurface head boundary metres above datum NVSLH NLB D I 1 NVSLH VS11 NVSLH gt 0 and VS16 Lateral subsurface head gradient boundary NVSLG NLB D I 1 NVSLG VS11 NVSLG gt 0 and VS16 Bottom flow boundary m s NVSBF VS11 NVSBF gt 0 Bottom head boundary metres above datum NVSBG VS11 NVSBG gt 0 Overland channel flow boundary m s NOCEB 21 NOCFB gt 0 Overland channel head boundary metres above ground NOCHB 21 NOCHB gt 0 Table 2 2 Time varying boundary data files 66 Code BCI BC2 67 Format A80 Il 12 13 14 15 VALUE NCAT Description Repeat Count TITLE 11 12 13 14 I5 WALUE J J 1 NCAT Year Month Day Hour Minute Input value constant flux since the last breakpoint or head Number of categories see Table 2 2 Data Only Required If Notes 2 12 Specification of Output Data The visualisation_plan txt file is used to specify what output is produced by SHETRAN An example of a file can be seen below visualisation plan Cobres diag switch on the diagnostics item NUMBER 1 NAME theta BASIS grid_as_grid
52. has been set at dimension 2 this is for the layer number and there are data for 31 layers so there are 31 sheets of paper in the stack Each sheet of paper shows a spreadsheet or image but each sheet is for a different layer These pages can be leafed through using the arrows on the spreadsheet s or image s toolbar In Figure 3 6 there is data for dimension 1 which is the horizontal part of the three by three grid The constant values for this dimension can be set by clicking more in the Dataset Selection window HDFV iew File Window Tools Help ed eas 5 shegraph hd S W CATCHMENT_M CONSTANTS VARIABLES 1net_rain i 1 7639 4 2psi 2 7373154 4 37 3 2 8008902 Pee UM LARGE WANE Lineplot VARIABLES 2 psi value by column x 2 7832496 2 758424 l 4 0 0498163 0 1 3 gt W 3theta 1 5232809 1 8 4 ovr_flow 17954423 2 9 4 pa Sat cep ae 6s_dis 1 11 2008080334 1 5893161_1 2 j a7 s_dis 2 p red Dataset Selection VARIABLES 2 psi yalue gt 8s dis3 144 1 5583 Display As 9s dis4 454 8503 amp amp 10 s dis5 Spreadsheet _ Show As Char Image Select palette v f i i ie Tablevi hdf
53. inant migration component is selected the bank element component must be included The transport components can be started later than the flow components to allow any inconsistencies in the flow initial conditions to decay before the transport components are introduced The usual procedure is to run only the flow components until a satisfactory flow simulation is established The simulation is then re run with the transport components included 1 6 5 Time varying boundary data files Prescribed time varying boundary conditions can be set up for the OC and the VS components Boundary conditions for the OC component are specified channel discharge or stage and overland water level or flow Boundary conditions for the VS component are specified lateral subsurface head and flow aquifer bed head and flow and well extraction rate All time varying boundary data files are in a standard format with values given at breakpoint times Head or stage boundary data are interpolated at each timestep between the given values Flux boundary data are given as constant values up to the breakpoint time and values for each timestep are calculated as the equivalent averaged value over the computational timestep In all cases the boundary elements are assigned boundary category codes and the time varying data are read in for each category If different time varying conditions are required for each boundary element a unique category code must be assigne
54. lance data averaged over the entire catchment 3 Phreatic surface levels and head data for each finite difference cell at the end of the simulation This can be used for hot start data by copying the data to a vsi file adding a line to the rundata file and changing INITYP in VSO3 in the vsd file 4 Discharge at the outlet every timestep The main advantage of HDF5 is that it is an open and widely used format so there are dozens of applications which can open HDF5 files and display edit and plot the data they contain Some of these applications are free to obtain and use such as the Windows java based application HDFView available from http www hdfgroup org hdf java html hdfview and it is assumed that HDF View is being used Note that HDF View comes with a built in electronic manual which describes its full capabilities Constants describing the catchment e g ground surface elevation and the SV4 element numbering system are automatically recorded in the HDF5 file What else is recorded is controlled by a file called visualisation_plan txt see section 2 12 which the user must write This specifies the items to be recorded when they are to be recorded and for which locations in the catchment Locations can be specified as the catchment grid rectangular sections of the grid or lists of SV4 element numbers It can also be specified that a list be created to contain all the elements in a grid section For each item a limited scope can be spe
55. ment_Map 3 3 Constants Constants are recorded for the data in Table 3 1 Each grid square can have associated with it a bank element on each side and a channel link on each side So element type 1 is the grid square types 2 3 4 and 5 are the banks on the north east south and west sides and types 6 7 8 and 9 are the river links on the north east south and west sides Note the difference between this and the faces in SHETRAN input files that are ordered east north west and south 75 Data Item Meaning centroid Grid coordinate i e distance m of the centre of the grid square from the top left of the catchment grid_dxy Grid size m in the x and y direction number SHETRAN element number r_span Length of grid square m from the grid centroid to the edge of the grid square Takes into account link and bank elements soil_type Soil type in each cell surf_elv Ground surface elevation vert_thk Vertical height of each cell Table 3 1 Constants recorded in shegraph h5 file The Constant number has been selected in Figure 3 2 by double clicking and the first two dimensions of this set can be seen in the table in the inset window Each dataset has general properties Right clicking on the number dataset and selecting show properties brings up the Properties window Figure 3 3 The number dataset is three dimensional with an extent 29x17x9 The dataset has been compressed to level 9 this is the maximum compression
56. ments are narrow strips of land at either side of the channel automatically set up for every link whenever the bank component is included It is assumed that channel link and bank element widths are small compared with the basic grid sizes The bank element width is hard coded within the program as 10 metres All other data for bank elements are input in the BK data file The elevation of the impermeable bed at each bank element must be at least 0 5 metres below the channel bed at the adjacent link 1 6 3 Output The standard method of obtaining results from SHETRAN is via HDF files with the type of output specified in the visulisation_plan txt file When SV4 is run an echo file is written automatically in the catchment s output sub directory as a file named check_visualisation_plan txt ASCII print output is held in a separate file for flow PRD sediment SPR and contaminants CPR These contain initialisation phase information diagnostic warning and error messages some further data output and summary statistics During normal simulations these need not be used for data output 1 6 4 Sediment and contaminant components Either the sediment component or the contaminant components called the transport components or both may be selected in addition to the flow components by setting the appropriate flags in the frame data file line FR25 Either of these may be selected in the absence of the other or both may be selected If the contam
57. minal function boundary categories TITLE TY DUM TY J 1 NX Integer array see introduction Array of head boundary categories for each grid element NY NY NY NY NY CDRS 0 OC3a CDRS 0 OC3a NOCHB NOCEFB NOCPB apply to grid and channel elements see FR35a d and Table 2 1 If only channel boundary conditions are used the grid arrays OC22 0C27 must still be read in NOCHB gt 0 OC21 0 24 20A4 TITLE OC25 17 1X 7211 TY DUM TY J 1 NX NY NOCEB gt 0 Integer array see introduction OC21 IDUM Atray of flux boundary categories for each grid element OC26 20A4 TITLE OC27 17 1X 7211 TY DUM TY J 1 NX NY NOCPB gt 0 Integer array see introduction OC21 IDUM Array of polynominal function boundary categories for each grid element OC28 TITLE 0 29 17 5F7 0 ICAT OCPBA ICAT OCPBB ICAT OCPBC ICAT NOCPB NOCPB gt 0 OCPBD ICAT OCPBE ICAT OC21 ICAT Category code OCPBA Coefficient A of polynomial function Q AH BH CH DH E where H is the water depth m in the element for each category OCPBB Coefficient B OCPBC Coefficient C OCPBD Coefficient D OCPBE Coefficient E OC30 20A4 TITLE OC31 17 NDEFCT NDEFCT Number of default channel cross section categories 33 OC32 OC33 OC34 34 20A4 17 NXDEF 10F7 0 XDEFW XDEFH TITLE IDEF NXDEF IDEF Number of width elevation pairs in cross section XDEFW IDEF
58. n dimensional concentration of sediment in size group I and p is the bulk density of bed sediment in the case of channel link or the bulk density of loose sediment in the case of a hillslope element 86
59. n upper bound on the range of values expected If FLAG is less than 10 the Format identifier Input output list integers are arranged as a grid of single digits 7 1 X nnnnI1 if FLAG lt 10 where nnnn is the east west extent of the grid or if FLAG gt 10 TY IGUX TY X 1 nnnn repeated NY times where NY is the north south extent of the grid IG is the integer array defined on the grid and IY is the row number Rows are numbered from south to north but must appear in north south order ie row NY first through to row 1 last The data for each row must begin on a new record Floating point Grid array Format name Format identifier Input output list FG TY IGUX TY X 1 nnnn Analogous to the input output list for format IG above FG is an array of type real or double precision Floating point Element array Format name Initial component Format FA This is a composite format made up of a logically determined sequence of simple formats It provides a choice of methods for the specification of a field of values FA 1 NEL 1 N2 covering the entire set of SHETRAN elements where FA is an array of type real or double precision NEL is the total number of elements and N2 is the size of the second dimension of FA a one dimensional array has N2 1 Values may be given directly N2 per element or there may be user defined categories with N2 values per category or there may be other special options
60. ngular region of the catchment s SV4 grid a mask may cover the whole grid It shows which gridsquares in the region are to be switched on for data recording The rectangular region for a mask is specified by its lowest and highest row and column numbers All characters except and represent on For example in Figure 2 2 row 17 of mask 8 IS 1lp 111111 so for this row of the catchment s grid data will be recorded only for the 9 gridsquares marked with the characters 1 or p A list is simply a list of SHETRAN element numbers Full sets of lists and masks including lists generated from masks for use when the basis is grid_as_list is given in the catchment s output sub directory in the echo file check_visualisation_plan txt Time sets comprise any number of pairs of timesteps and end times To give an example the pairs 1 12 and 2 24 specify that data should be recorded every hour for 12 hours and then every second hour for the rest of the first day 73 3 SHETRAN Results 3 1 Introduction During a simulation SHETRAN records selected simulation results to an HDF5 file Hierarchical Data Format 5 file called shegraph h5 SHEGRAPH HDFS files are self contained and include all the information required to analyse and visualise the data they contain The HDF file is written in a compressed form Four ASCII data files are also written during or at the end of the simulation 1 Hourly discharge at the outlet 2 Daily mass ba
61. o use the Engelund Hansen formula to calculate channel flow sediment transport capacity 1 for Ackers White or 2 for Ackers White Day Note a all of these formulae apply to non fines noncohesive sediment only and b the formulae are limited by FPCRIT Enter 0 to instruct SHETRAN to set non fines sediment velocity equal to water flow speed or to calculate it as less than the water flow speed depending on shear stress Note that fine particles always travel at the speed of the water NFINE is strictly 0 or 1 If NFINE is 1 then the smallest sediment size fraction is treated as fine material The transport calculations applied to the fine material are assumed to be appropriate for sediment particles with a diameter of less than 0 25mm Therefore if the smallest size fraction is greater than this NFINE should be set to 0 otherwise NFINE should be set to 1 There should be only one sediment size group with a diameter of less than 0 25mm Fines are treated differently from non fines in the following ways First the concentration capacity of fines in channels is given by FDEL FPCRIT a smaller value is calculated for non fines Second the speed of fines in channels is always equal to water speed non fines may be slower see ISUSED Third fine material may infiltrate into the channel bed after it settles from upper loose sediment later to lower and fourth fines once settled may be protected from re suspension once settled by being armoured by n
62. on and n is not used IF TVSFLG 4 then n is the exponent for the Averjanov function and 613 not used For IVSFLG 4 the values for K are not used although they must still be entered VS08 VSO8a VS08b VSO8c VS08d 40 C80 C NCAT NELEM C80 C ICAT NLAYER C IVSDUM RVSDUM C80 IVSCAT C80 IG C80 TELEM NLAYER ground surface Aquifer zone layer definitions NCAT NELEM Number of categories for aquifer zone layer defintions Number of individual elements for aquifer zone layer definitions Category definitions ICAT NLAYER Category number Number of layers IVSDUM I 1 NLAYER Soil lithology type of each layer RVSDUM I 1 NLAYER Depth to the bottom of layer I starting at the bottom layer Aquifer zone category codes for links IVSCAT I I 1 NLF Category type for each channel link Distribution grid for aquifer zone category codes Integer Grid See Appendix A for IVSCAT I Individual elements for aquifer zone layer definitions IELEM NLA YER Element number Number of layers IVSDUM I 1 NLAYER NCAT NCAT NCAT NELEM NELEM NCAT gt 0 NCAT gt 0 If there is only 1 category all the elements are given this category and data VSO08b to VSO8d should not be input NCAT gt 0 NCAT gt 0 NCAT gt 1 BEXBK Category codes for the TRUE and NLF gt 0 river links are only required if banks are being used and there ar
63. on fines This limiting concentration is a non dimensional number see Appendix B It has two separate functions First in every channel link element FPCRIT is the maximum sediment concentration that can be carried by the flow in each and every separate sediment size group DLSMAX DCBEDO DRSED RHOSO FPCLAY SOSDFN DRDRIP PBSED SY52 56 It is the only limit for fine material and provides an upper limit on the capacity concentration of non fine material as calculated by the Ackers White or Engelund Hansen equations Second FPCRIT is the maximum total sediment concentration the sum over sediment size groups that can be carried by overland flow There is no real reason why this second function should be connected to the first function however it is expected that the overland transport capacity equations will usually predict lower concentrations than FPCRIT If the depth of loose sediment that builds up on the hillslope reaches DLSMAX meters then the soil underneath is assumed to be protected and no further erosion takes place Interaction between the top and bottom bed sediment layers in channels is controlled by DCBEDO If the depth of sediment deposited on the top layer is greater than DCBEDO the excess sediment is forced into the bottom bed sediment layer If some of the top layer of bed sediment is washed away leaving a depth less than DCBEDO then the bottom layer sediment will be transferred to the top lay
64. re 3 2 Shegrpah h5 file showing SHETRAN element numbers Figure 3 3 General properties for dataset number Figure 3 4 Attributes for dataset number iv 74 74 75 79 83 85 22 66 69 69 71 76 79 16 68 72 75 77 77 78 Figure 3 5 Dataset for time and attributes for value both for item 2 psi Figure 3 6 A 1 D plot for dataset 2 psi in a Lineplot window Figure 3 7 A 2 D plot for dataset theta in an ImageView window 80 81 82 1 INTRODUCTION TO RUNNING SHETRAN 7 7 SHETRAN Basics SHETRAN should run on any modern PC There are two versions 1 SHETRAN Windows in which a basic catchment can be set up and run in a standard windows environment 2 SHETRAN Standard full capability but without the windows environment Both versions use standard SHETRAN text files for running the model But in the Windows version these are hidden This means that a catchment can be set up using the Windows version and then run modified using the standard version The main capabilities missing in the Windows version are 1 Cannot run sediment 2 Cannot run solute transport If you are a new user of SHETRAN or setting up a new catchment use SHETRAN Windows Otherwise do the following 1 Uncompress SHETRAN standard 2 Go to the program directory 3 Run a simulation To run SV4 double click V4 4 1 exe in the program directory This opens a window Figure 1 1 Use this to find the catchment
65. rodibility coefficient J Overland flow soil erodibility kg m Bulk dry soil density kg Fractional clay content of soil Channel bank erodibility coefficient kg m Fraction by mass of sediment in each particle size group Average height that drips fall from canopy to ground m Average diameter of drips falling from canopy m Fraction of drainage from canopy that falls as drips Bank soil type Porosity of bed sediment Ground cover fraction Rock cover fraction Porosity of loose sediment FBIC FICRIT DRSED sed sed 1 NSED GKR soil GKF soil RHOSO soil FPCLAY soil BKB soil soil 1 to NS SOSDFN soil soil 1 to NS XDRIP veg DRDRIP veg FDRIP veg veg 1 to NV NTSOBK link link 1 NLF PBSED dink link 1 NLF FCG iel iel NLF 1 NEL FCROCK iel iel NLF 1 NEL PLS iel iel NLF 1 NEL NLF gt 0 NLF gt 0 NLF gt 0 NLF gt 0 NLF gt 0 NLF gt 0 NLF gt 0 SY51 SY52 SY53 SY61 SY62 SY63 SY64 54 FA FA FA Initial depth of loose bed sediment m Initial fraction of loose bed sediment in each size group Initial concentration of sediment carried by the flow Number of elements with sediment inflow Number of categories for each boundary type Integer data defining each sediment boundary element Particulate inflow rate for each size group For each steady flow flux category Steady sediment rating curve coeffi
66. rror number indicates in which component the error originated 10 0 General library routines 1 Water flow components 2 Sediment component 3 Contaminant component A longer message description may follow the summary message line Three types of message are written of increasing severity WARNINGS warning messages are written for example where input data have been adjusted or where mass balance errors exceed certain values ERRORS error messages may be written due to inconsistencies in input data sets or where unphysical values have occurred during a simulation but where the situation is recoverable FATAL ERRORS a fatal error is written if the simulation terminates prematurely as a result of either errors in input data sets or non recoverable unphysical situations during the simulation A complete listing and summary of all errors may be found in a subdirectory help within the main program directory 11 2 DATA INPUT FILE FORMATS 2 1 Introduction Some of the SHETRAN data files are set out in a fixed format described in the following sections for each component Some of the data are input in a 7 character format Where free format is used the input variable type is signified by the first letter of the variable name following FORTRAN 77 defaults double precision A H O Z integer I N Each of the groups of data items is preceded by a title line which can be used for documenting the follo
67. s rundata directory then double click on the catchment s rundata file Note if SV4 immediately stops and the window disappears then run from a command prompt window start all programs accessories on windows XP machines the error message will then remain in the window 4 Look for a file named output_CATCHMENT NAME_shegrpah h5 5 Examine the output using any HDF5 application If for example HDFView is the default HDF5 application it will be if it is the only HDF5 application you have installed double clicking on _CATCHMENT NAME_shegrpah h5 will automatically open HDF View and load shegraph h5 HDFView is freely available software that can be downloaded from http www hdfgroup org hdf java html hdfview Select a SHETRAN rundata file Look in Cobes 6 Sl ey FE 4 My Recent Documents input_cob_etd txt input_cob_frd txt input_cob_ocd txt input_cob_syd txt input_cob_visualisation_plan txt input_cob_vsd txt input_wet_epd txt input_wet_prd txt readme txt rundata_cob txt temporary txt OB 03 03 03 03 HG Ty File name tundata_cob txt z My Network Files of type All files Ka Cancel Places I Open as read only Figure 1 1 File select window 1 2 Command line options The standard method of running SHETRAN is to double click on sv4 4 1 exe in the progam directory However there are other command line options that can be seen below Syntax executable option n
68. set for time and attributes for value both for item 2 psi For some contaminant and sediment variables data are recorded for only one contaminant or one sediment fraction so the contaminant or sediment fraction number is included at the end of the label for the corresponding VARIABLES dataset For example in Figure 3 5 item 8 is for sediment fraction 3 for the sediment variable s_dis 80 Double clicking on a dataset s name brings up a spreadsheet showing the first two dimensions of the dataset What is more useful is to right click on the name and select open as from the drop down menu This brings up a Dataset Selection window Figure 3 6 The main choice to be made is then whether to view the data on a spreadsheet or as a 2 dimensional plot click either the spreadsheet or image button Both the spreadsheet and plot are 2 dimensional so can only show a 2 dimensional slice through the dataset e g for a 6 dimensional set it could for example show the slice for dimensions 3 and 5 with the values for all the other dimensions remaining constant The selected dimensions run along the height vertical and width horizontal edges of the spreadsheet or image In Figure 3 6 dimension 0 is for the vertical part of the three by three grid and this is shown as the height in the spreadsheet dimension 3 is the time and this is shown as the width The depth can also be specified This works like a stack of paper For example in Figure 3 6 the depth
69. st be checked to ensure that they are sufficiently large to accommodate the required catchment configuration the program halted if the array sizes are too small Below is a list of the dimensions sizes in the attached executable If bigger sizes are needed then please contact the University of Newcastle and a modified executable can be sent Parameter Meaning Dimension NXEE Number of basic grid elements in the x direction 52 NYEE Number of basic grid elements in the y direction 52 NLFEE Number of channel links 1500 LLEE Number of cells in the vertical 60 NVEE Maximum of the number of vegetation types meteorological 25 stations and rainfall stations NSEE Number of soil types 25 NVSEE Size of tables used in VS module 20 NVBP Number of time varying vegetation breakpoints 140 NUZTAB Size of tables used in ET module 20 NLYREE Maximum number of soil layers at any element 9 NXOCEE Maximum number of elements grids banks and links in any 100 row including E W links and banks on the southern edge of the row Used for OC component matrix coefficients NOCTAB 5126 of tables in OC component Maximum of number 20 roughness categories number of channel cross section categories NSEDEE Number of sediment size fractions 7 NCONEE Number of contaminants 3 Table 1 1 Array sizes 1 5 SHETRAN Rundata file SHETRAN uses a number of different input and output files for setting up and controlling a simulation and for
70. subsurface initial conditions VSD file Only required if INITYP 2 or 3 VS03 Code 46 Format 20A4 ZVSPSL IEL VSPSI Description Repeat Count TITLE ZVSPSL EL TEL 1 NEL Initial phreatic surface element for each element IEL NEL Element number VSPSICICL ICL ICBOT ICTOP NEL Initial pressure potential for each cell in the element starting from the bottom Data Only Required Notes If INITYP 2 VS03 INITYP 3 VS03 INITYP 3 VS03 2 6 Code SM1 SM2 SM3 SM4 SM5 SM6 SM6a SM6b 47 Snowmelt Module Format 20A4 L7 BINSMP 20A4 2F7 5 F7 2 217 DDF RHOS TSIN NSD MSM 20A4 3F7 5 ZO ZD ZU 20A4 1017 IMET Description Repeat Count TITLE BINSMP TRUE for print of input data TITLE DDF RHOS TSIN NSD MSM Degree day factor Default specific gravity of snow Initial snow temperature 0 for uniform initial snowpack depth and specific gravity 1 for spatially varying initial depth and specific gravity Calculation method 1 for Degree day 2 for Energy Budget TITLE ZO ZD ZU Aerodynamic roughness of snow Zero plane displacement Height of anemometer above ground TITLE IMET I I 1 NM Element numbers of meteorological station locations Data Only Required If MSM 2 SM4 MSM 2 SM4 Notes Initial snowpack temperature TSIN not used if degree day calculation method MS
71. t 4 4 or 9 the 9 types are listed in Figure 3 4 Subsurface layer The layers correspond to the layers of subsurface finite difference cells in SV4 Layer 1 corresponds to the topmost finite difference cells layer 2 the second topmost finite difference cells and so on Limits 3 24 for example therefore specify the inclusive range from the third topmost cells to the 24th topmost cells Limits specified backwards e g 24 3 will automatically be reversed when read It can be useful to study the constants vert_thk vertical thickness and soil_typ soil type when creating a visualisation_plan txt file Whenever a simulation is run even a preliminary simulation where the visualisation_plan txt file contains only the lines visualisation plan and stop these constants are automatically recorded for the entire extent of the finite difference mesh including any dummy layers of cells that SV4 add to the base of the mesh for computational purposes Extra dimensions The available options can be seen in Table 2 5 Time has its own dataset and attributes The time and value datasets are related in that the 29th say element in the time dimension of a value dataset applies at the time given in the 29th element of the corresponding time dataset Table 3 2 Data Types dimensions that can be recorded for grid datasets 3 4 Variables There can be several datasets for the same variable so the VARIABLES datasets are labelled with both the v
72. teorological data ME4 occupying 2 lines and MES followed by NRAIN sets of rainfall data ME6 occupying line MEI TITLE NM lt NRAIN ME4 216 12X 3G12 6 ISITE METIME RN Ud PAI TAC DEL VPD NM For explanation of the 12X 3G12 6 112 IDATA parameters see lines ME2 and ME3 MES 12X G12 6 OBSPE NM MEASPE 1 ET6 ME6 216 G12 6 24X ISITE METIME P 1 IDATA NRAIN 12 2 10 2 Precipitation data This file is used only if BMETAL TRUE ET2 Rainfall is read in at regular time intervals DIMET2 ET4 PRI 20A4 TITLE PR2 PINP I 1 NRAIN PINP Measured rainfall in the time interval DIMET2 NRAIN Number of rainfall stations 2 10 3 Potential Evaporation data This file is used only if BMETAL TRUE ET2 Potential evaporation is read in at regular time intervals DTMET3 ET4 Other meteorological data are not read in 64 EPI 20A4 TITLE EP2 OBSPE I I 1 NM OBSPE Measured potential evaporation in the time interval DTMET3 NM Number of meteorological stations 65 2 11 Time Varying Boundary Conditions Time varying boundary condition data files are set up in a standard format for both flow and head data Flow data are input as constant values up to the breakpoint time and are averaged over the computational timestep Head data are interpolated to give the value at the computational time Each file contains data for several categories The elements associated with each cate
73. ven in Appendix A Description Note that any quantities described in this section as sediment concentrations are dimensionless See Appendix B for further clarification Code Format Description Variable Name Data Only Required If SYO1 C80 Title of sediment simulation SY02 C8 Version of sediment code being used SY11 I Number of sediment size groups NSED Flag for overland flow transport equation selection ISGSED Flag for shear stress formula selection ISTEC Check water interface data every ISSYOK water flow time steps ISSYOK Number of SY time steps per water flow time step NEPS Flag for channel flow transport equation selection ISACKW NLF gt 0 Flag for non fine sediment velocity in channel selection ISUSED NLF gt 0 Number of fine sediment size groups NFINE NLF gt 0 SY12 F Upper limit in mobile sediment concentration FRCRIT Threshold depth of loose sediment above which erosion is zero m DLSMAX Ratio of settling to re suspension critical shear stress for fines ALPHA NLF gt 0 Mobile sediment concentration threshold for over bank flow CONCOB NLF gt 0 Maximum thickness of top layer of bed sediment m DCBEDO NLF gt 0 52 SY21 SY22 SY23 SY24 SY31 SY32 SY41 SY42 SY43 53 FC FC FC Fines bed sediment fraction above which there is no infiltration Mobile fine sediment concentration threshold for infiltration Particle diameters representing each sediment size group m Raindrop and drip soil e
74. ver the cloned values but do not affect the properties of the previous item Property Format Comments and Allowable Values in bold italics Default Value BASIS word grid_as_grid a grid has been entered and should be used grid_as_list a grid has been entered and should be used to create a list that holds all the elements in the grid list_as_list a list has been entered and should be used grid_as_grid CONTAMINANT_NO integer A simulation can have several contaminants numbered 1 2 3 It is a limitation of the output that data for only one contaminant is recorded per item The contaminant number must be specified when a variables with C against its name in Figure 2 3 is specified in an item EXTRA_DIMENSIONS word 3 0 values left_right faces 2 values 4 values in compass order N E S W X Y 2 values GRID_OR_LIST integer If say the basis is grid_as_grid and grid_or_list is set at 17 the file should contain a mask numbered 17 and this mask will be used LAYERS pair of integers Gives limits in any order of range of SV4 layer numbers if layer numbers are not relevant for the variable the layer numbers should be left at the default values 00 NAME word variable name Figure 2 3 null string NUMBER integer it is sensible but not essential to number the first item as 1 the second item as 2 etc 0 SCOPE word all
75. view DefaultTablevi hdf view Defaultimagevi i E i v gt G 125 dis7 198 19162 eView ncsa hdf view ultTableView ImageView ncsa ndf view DefaultimageView amp 13 sv er roae Dimension and Subset Selection 5 tdp gt 155 t dp 231 6755 Swa Start End Stride Max Size Height dm0 v E 1 3 dim3 v a i N 1 y gt 1 Depth dim2 7 h I 31 _29 _ 1 3568 mor ok cancei l l Figure 3 6 A 1 D plot for dataset 2 psi in a Lineplot window 81 For Figure 3 6 the spreadsheet option was selected and the spreadsheet which appeared is shown in the TableView window Alongside the arrows on the toolbar in this window there is a graph icon The 1 dimensional plot in the Lineplot window was created by selecting columns 1 3 in TableView and clicking this icon Several rows or columns can be selected for a single lineplot Also on the toolbar there is the word Table clicking on this brings up a menu for various tasks such as saving selected table values to an ASCII file Figure 3 7 shows a 2 dimensional plot in an ImageView window make sure that image is selected in the Data Selection window if you want an image and not a spreadsheet Several options including options for contouring colour palettes and animation can be accessed by clicking on the word image on the toolbar in the ImageView window The image size in HDView depends on the si
76. wever the BK component must also be included FR26 FR27 FR28 FR29 FR30 FR31 20 20A4 2L7 2F7 2 BHOTRD BHOTPR BHOTTI BHOTST 517 NM NRAIN NV NDUMI NDUM2 20A4 L7 2F7 0 L7 LDUMI DUMI DUM2 LDUM2 TITLE BHOTRD BHOTPR BHOTTI BHOTST TRUE for reading of initial conditions from hotstart file TRUE for printing of relevant variables on hotstart file Time for hotstart of simulation Timestep for storing data on hotstart file TITLE NM NRAIN NV NDUM1 NDUM2 Number of meteorological data stations Number of rainfall data stations Number of vegetation types in the model area Value read in but not used Value read in but not used TITLE LDUM1 DUM1 DUM2 LDUM2 Value read in but not used Value read in but not used Value read in but not used Value read in but not used NRAIN must be equal to or greater than NM In the case that NRAIN NM one would normally expect the meteorological and rain codes also to be the same that is NRAINC NMC lines FR43 FR47 FR32 20A4 FR33 517 IDMC IDRA IDVE IDUM FR34 20A4 FR35 I7 1X 7211 IY NGRID FR35a 20A4 FR35b I7 1X 7241 LCODEX 21 TITLE IDMC IDRA IDVE IDLYR Default values for meteorological rain vegetation and soil codes Default meteorological grid code Default rainfall grid code Default vegetation type grid code Value read in but the value 1 is used TITLE TY N
77. wing lines of data In addition a general title for the simulation is held in the first line of the frame data file A slightly different format is used for the sediment and contaminant input data files this is discussed in Appendix A Each data line in each file is described with reference to a short identifier code e g FR5 To retain consistency between versions of SHETRAN where input data are changed the codes are not renumbered so that lines may have been inserted e g FR35a FR35d or removed e g FR40 FR42 The variable names described in the input data formats are mostly the FORTRAN variable names used in the program However where processing of the input data occurs in the initialisation phase of a simulation the internal variable names may differ from those described in this report Distributed data are held in grid arrays in a standard format for grid elements Real arrays consist of a title line and the grid row numbers in descending order each followed by the row of data extending over several lines if necessary See the ground surface elevation array ZGRUND lines FR37 FR39 for an example of a real variable array Integer arrays are normally input in a simpler format with the row number and the row of data on the same line See the vegetation distribution array NMC lines FR43 FR44 This input format is only used if the number of possible categories in the array e g the number of vegetation types is less than
78. ze of the dataset a big set gives a big image Magnification in HDFView has a limited range x0 125 to x8 which is a bit annoying when looking a small set as it gives a small image even when x8 is used Note that this has nothing to do with the HDF5 files Catchment_map has a simple form of magnification so that a big image is seen in HDF View Further dataset could be added in a similar manner File Window Tools Help eo emi shegraph hS ImageView D ishetranPCv4iexamples Cobres outputishegrap SO CATCHMENT fima MAIA Kala gt ea CONSTANTS VARIABLES gt 1 net_rain 2psi 3 time i value 3theta time gt S 4 ovr_flow gt 5srf_dep gt 6s dis1 gt W 7s dis2 gt W 8s dis3 gt 9s dis4 gt 10s dis5 gt 115 dis6 gt 125 dis gt w 13s v er i gt 145 t dp Figure 3 7 A 2 D plot for dataset theta in an 72486170 window 82 Appendix A Data File Formats for the Sediment and Contaminant Transport Components This appendix defines certain generic formats used in the specification of input data files for the sediment and contaminant transport components of SHETRAN The definitions should be interpreted within the context of FORTRAN 77 ANSI X3 9 1978 Each format corresponds to a sequence of formatted records within a data file The first record of each format is always a title or header On input the contents of this record are transferred to a character

SHETRAN Standard Version – V4.4.1 User Guide and Data Input

Contents

Download Pdf Manuals

Related Search

Related Contents

SHETRAN Standard Version &ndash; V4.4.1 User Guide and Data Input

Contents

Download Pdf Manuals

Related Search

Related Contents

SHETRAN Standard Version – V4.4.1 User Guide and Data Input