SMS:Reading a TUFLOW Simulation

From XMS Wiki
Revision as of 14:53, 25 September 2017 by Jcreer (talk | contribs) (ECF File)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

TUFLOW simulation files can be opened into SMS by opening the simulation's control file (*.tcf). This can be done by dragging and dropping the file into the graphics window or by using File | Open. Multiple simulations can be opened together, and SMS will only create one copy of the data that is shared between the projects.

TCF File

The following commands are supported when reading a TCF file into SMS:

  • BC CONTROL FILE – Read the specified TUFLOW boundary condition file
  • BC DATABASE – Set the active database
  • BC EVENT NAME – Set the active event filename to be used
  • BC EVENT TEXT – Set the text to be substituted by the BC EVENT NAME value
  • CELL SIDE WET/DRY DEPTH – Set the depth for when cell sides wet and dry
  • CELL WET/DRY DEPTH – Set the wet/dry depth for when a cell wets and dries
  • CHECK INSIDE GRID – Set to ERROR, WARNING, or OFF
  • DISPLAY WATER LEVEL – Display water level for cell at specified location
  • END 1D DOMAIN – End block of 1D commands
  • END 2D DOMAIN – End block of 2D domain definition
  • END TIME – Set the simulation finish time in hours
  • ESTRY CONTROL FILE (AUTO) – Set the ESTRY control filename
  • GEOMETRY CONTROL FILE – Read the specified TUFLOW geometry control file
  • HX ZC CHECK – Set whether or not to check the minimum ZC elevation is above the 1D bed level
  • INSTABILITY WATER LEVEL – Set the water level used to detect instabilities
  • MAP OUTPUT DATA TYPES – Define data types to be output in map format
  • MAP OUTPUT INTERVAL – Set the output interval for map based output in seconds
  • MASS BALANCE OUTPUT – Set whether or not to output mass balance data
  • MI PROJECTION – Set the geographic projection
  • NUMBER ITERATIONS – Specify the number of iterations per time step
  • READ FILE – Read the specified external file as an addition TUFLOW control file
  • READ GIS FC – Read the specified flow constriction mif/mid files
  • READ GIS IWL – Read the specified initial water level mif/mid files
  • READ MATERIALS FILE – Read the specified TUFLOW materials file
  • READ MI PROJECTION – Set the projection
  • READ RESTART FILE – Set the model to use the specified restart file
  • SCREEN/LOG DISPLAY INTERVAL – Set the frequency for display of output to the computer screen and log file
  • SET IWL – Set a default initial water level for all cells
  • START 1D DOMAIN – Start a block of 1D commands
  • START 2D DOMAIN – Begin block of 2D domain definition
  • START MAP OUTPUT – Set simulation time in hours when map output begins
  • START TIME – Set the start time of the simulation in hours
  • STORE MAXIMUMS AND MINIMUMS – Set whether or not to store the highest and lowest values
  • SX ZC CHECK – Set whether or not to check if the minimum ZC elevation is below the connected or snapped 1D node bed level
  • TIMESTEP – Set the computation time step in seconds
  • VISCOSITY COEFFICIENT – Set the viscosity coefficient(s)
  • VISCOSITY FORMULATIONS – Set the viscosity formulation
  • WRITE RESTART FILE AT TIME – Set when to write the restart file in hours
  • WRITE RESTART FILE INTERVAL – Set the interval in hours between writing the restart file
  • ZERO NEGATIVE DEPTHS IN SMS – Set whether or not to zero depths if negative

The following commands are not supported and are written to an external file:

  • ADJUST HEAD AT ESTRY INTERFACE
  • APPLY WAVE RADIATION STRESSES
  • APPLY WIND STRESSES
  • BC WET/DRY METHOD
  • BC ZERO FLOW
  • BED RESISTANCE CELL SIDES
  • BED RESISTANCE DEPTH INTERPOLATION
  • BED RESISTANCE VALUES
  • BOUNDARY CELL SELECTION
  • CALIBRATION POINTS MI FILE
  • CHANGE ZERO MATERIAL VALUES TO ONE
  • CHECK MI SAVE EXT
  • CSV TIME
  • DEFAULTS
  • DENSITY OF AIR
  • DENSITY OF WATER
  • DEPTH/RIPPLE HEIGHT FACTOR LIMIT
  • DISTRIBUTE HX FLOWS
  • DOUBLE PRECISION
  • EXCEL START DATE
  • FIRST SWEEP DIRECTION
  • FREE OVERFALL
  • FREE OVERFALL FACTOR
  • FROUDE CHECK
  • FROUDE DEPTH ADJUSTMENT
  • GLOBAL FC CH FACTOR
  • GLOBAL WEIR FACTOR
  • INPUT DRIVE
  • INSIDE REGION
  • LATITUDE
  • LINE CELL SELECTION
  • MAP CUTOFF DEPTH
  • MAXIMUM POINTS
  • MAXIMUM VERTICES
  • MESHPARTS
  • MODEL PRECISION
  • NULL CELL CHECKS
  • NUMBER 2D2D LINK ITERATIONS
  • OBLIQUE BOUNDARY ALIGNMENT
  • OBLIQUE BOUNDARY METHOD
  • OUTPUT DRIVE
  • READ GIS CYCLONE
  • READ GIS HURRICANE
  • READ GIS ISIS NETWORK
  • READ GIS ISIS NODES
  • READ GIS ISIS WLL
  • READ GIS ISIS WLL POINTS
  • READ GIS GLO
  • READ GISLP
  • READ GISPO
  • READ GIS XP NETWORK
  • READ GIS XP NODES
  • READ GISXP WLL
  • READ GIS XP WLL POINTS
  • READ ROWCOL IWL
  • RECALCULATE CHEZY INTERVAL
  • SHALLOW DEPTH STABILITY FACTOR
  • SHALLOW DEPTH WEIR FACTOR CUT OFF DEPTH
  • SHALLOW DEPTH WEIR FACTOR MULTIPLIER
  • SNAP TOLERANCE
  • START TIME SERIES OUTPUT
  • START WIND OUTPUT AT TIME
  • SUPERCRITICAL
  • SX HEAD ADJUSTMENT
  • TIME SERIES OUTPUT INTERVAL
  • TIMESTEP DURING WARMUP
  • UK HAZARD DEBRIS FACTOR
  • UZ HAZARD FORMULA
  • UZ HAZARD LAND USE
  • UNUSED HX AND SX CONNECTIONS
  • VERBOSE
  • VG Z ADJUSTMENT
  • WARMUP TIME
  • WATER LEVEL CHECKS
  • WAVE PERIOD
  • WETTING AND DRYING
  • WIND OUTPUT INTERVAL
  • WIND/WAVE SHALLOW DEPTHS
  • WRITE EMPTY MI FILES
  • WRITE PO ONLINE
  • WRITE Z1D CHECK FILES

The following commands are ignored when read in by SMS because they are hardwired:

  • CHECK MI SAVE DATE – Hardwired to “OFF”
  • LOG FOLDER – Hardwired to “.\\log”
  • MI PROJECTION CHECK – Hardwired to “WARNING”
  • OUTPUT FOLDER – Hardwired to “..\\results”
  • WRITE CHECK FILES – Hardwired to “..\\check\\”

TGC File

The following commands are supported when reading a TGC file into SMS:

  • ALLOW DANGLING Z LINES – Allows dangling z lines
  • CELL SIZE – Sets the cell size
  • GRID SIZE (N, M) – Sets the number of I and J in the grid
  • GRID SIZE (X, Y) – Sets the grid size in x and y
  • ORIENTATION – Sets the x,y location of a point along the x-axis
  • ORIENTATION ANGLE – Sets the angle of the grid
  • ORIGIN – Sets the location for the origin
  • READ FILE – Reads an external file
  • READ GIS CODE – Reads mif/mid files and stores the codes in polygons in a bc coverage
  • READ GIS FC SHAPE – Reads mif/mid files to create a flow constriction coverage
  • READ GIS FLC – Reads mif/mid files to create a 2D spatial coverage with form loss coefficient as the coverage property
  • READ GIS IWL – Reads mif/mid files to create a 2D spatial coverage with initial water level as the coverage property
  • READ GIS LAYERED FC SHAPE – Reads mif/mid files to create a flow constriction coverage
  • READ GIS LOCATION – Set the grid location
  • READ GIS MAT – Reads mif/mid files to create an area property coverage
  • READ GIS VARIABLE Z SHAPE – Reads mif/mid files to create a z-shape coverage
  • READ GIS WRF – Reads mif/mid files to create a 2D spatial coverage with weir factor as the coverage property
  • READ GIS Z LINE – Reads mif/mid files to create a z-lines coverage
  • READ GIS Z SHAPE – Reads mif/mid files to create a z-shape coverage
  • READ GIS ZPTS – Reads mif/mid files to create points in a z-lines coverage
  • READ ROWCOL CODE – Sets code values for grid cells
  • READ ROWCOL MAT – Sets material values for grid cells
  • READ ROWCOL ZPTS – Sets z values for grid cells
  • READ TIN ZPTS – Creates a scatter set from the points
  • SET CODE – Set the default code
  • SET IWL – If opening with a simulation, sets the default initial water level, otherwise the card is written to an external file
  • SET MAT – Set the default material id
  • SET ZPT – Set the default z-value for each grid cell

The following commands are not supported and are written to an external file:

  • READ TGA
  • READ TGC
  • EXTERNAL BNDY
  • READ GIS CNM
  • READ GIS FRIC
  • READ ROWCOL GRID
  • SET CNM
  • SET FRIC
  • SET CODE ZERO ABOVE ZC
  • WRITE MI DOMAIN
  • WRITE MI GRID
  • CREATE TIN ZPTS
  • DEFAULT LAND Z
  • INTERPOLATE ZC
  • INTERPOLATE ZHC
  • INTERPOLATE ZUV
  • INTERPOLATE ZUVC
  • INTERPOLATE ZUVH
  • PAUSE WHEN POLYLINE DOES NOT FIND ZPT
  • TIN COINCIDENT POINT DISTANCE
  • READ MI Z HX LINE
  • READ MI Z HX LINE RIDGE or MAX or RAISE
  • READ MI Z LINE RIDGE or MAX | GULLY or MIN | HX
  • READ MI Z SHAPE RIDGE or MAX or RAISE | GULLY or MIN or LOWER

TBC File

The following commands are supported when reading a TBC file into SMS:

  • BC DATABASE – Set the database to be used
  • BC EVENT NAME – Set the name of the event file to be used
  • BC EVENT TEXT – Set the text to be replaced by the event name
  • READ GIS BC – Read the boundary condition MIF/MID files
  • READ GIS RF – Read the rainfall MIF/MID files
  • READ GIS SA – Read the source flow MIF/MID files

The following commands are not supported and are written to an external file:

  • GLOBAL RAINFALL AREA FACTOR
  • GLOBAL RAINFALL BC
  • GLOBAL RAINFALL CONTINUIN LOSS
  • GLOBAL RAINFALL INITIAL LOSS
  • READ GIS SA ALL
  • READ GIS SA PITS
  • READ GIS RF
  • READ ROWCOL RF
  • UNUSED HX AND SX CONNECTIONS

ECF File

The following commands are supported when reading a ECF file into SMS:

  • DEPTH LIMIT FACTOR – Set the depth limit for detecting instabilities
  • MANHOLE DEFAULT C EXIT COEFFICIENT – Set the K coefficient for automatic circular manholes
  • MANHOLE DEFAULT LOSS APPROACH – Set the loss approach for automatic manholes
  • MANHOLE DEFAULT R EXIT COEFFICIENT – Set the K coefficient for automatic rectangular manholes
  • MANHOLE DEFAULT SIDE CLEARANCE – Set the side clearance for circular and rectangular manholes (automatic)
  • MANHOLE DEFAULT TYPE – Set the type (circular, rectangular, no chamber, automatic) for automatic manholes
  • MANHOLE K MAXIMUM BEND/DROP – Set the K coefficient for energy loss when using Engelhund approach with automatic manholes
  • MANHOLE MINIMUM DIMENSION – Set the minimum dimension for circular and rectangular automatic manholes
  • MANHOLES AT ALL CULVERT JUNCTIONS – Set whether or not to automatically create manholes at culvert junctions
  • MINIMUM NA – Set the minimum surface area in all NA tables
  • OUTPUT INTERVAL – Set the output interval for ESTRY output
  • PIT INLET DATABASE – Read the specified inlet database file
  • READ GIS NETWORK – Read the network mif/mid files
  • READ GIS TABLE LINKS – Read the table link mif/mid files
  • READ GISI WLL – Read water level lines mif/mid files
  • READ GIS WLL POINTS – Read elevations and points from water level lines from mif/mid files
  • STORAGE ABOVE STRUCTURE OBVERT – Define how surface area is to be contributed to the NA table
  • TIMESTEP – Set the computation time step in seconds
  • READ FILE – Read the external file as an ECF file
  • SET IWL – Set the initial water level

The following commands are not supported and are written to an external file:

  • BG DATA
  • BRIDGE FLOW
  • CHECK MI SAVE DATE
  • CHECK MI SAVE EXT
  • CREATE NODES
  • CS DATA
  • CSV FORMAT
  • CSV TIME
  • CULVERT ADD DYNAMIC HEAD
  • CULVERT CRITICAL H/D
  • CULVERT FLOW
  • DEFAULTS
  • END TIME
  • FIXED FIELD FLAGS
  • FLOW CALCULATION
  • FROUDE CHECK
  • HEAD RATE CREEP FACTOR
  • HEAD RATE LIMIT
  • HEAD RATE LIMIT MINIMUM
  • INTERPOLATE CROSS-SECTIONS
  • INTERPOLATE CULVERT INVERTS
  • LOG FOLDER
  • M11 NETWORK
  • MI PROJECTION
  • MINIMUM CHANNEL STORAGE LENGTH
  • MINIMUM NA PIT
  • MOMENTUM EQUATION
  • NA DATA
  • ORDER OUTPUT
  • OUTPUT FOLDER
  • OUTPUT TIMES SAME AS 2D
  • PIT CHANNEL OFFSET
  • READ MATERIALS FILE
  • READ GIS IWL
  • RELATIVE RESISTANCE
  • S CHANNEL APPROACH
  • SNAP TOLERANCE
  • START OUTPUT
  • START TIME
  • STRUCTURE LOSSES
  • TAPER CLOSED NA TABLE
  • TRIM XZ PROFILES
  • VEL RATE CREEP FACTOR
  • VEL RATE LIMIT
  • VEL RATE LIMIT MINIMUM
  • VG DATA
  • WEIR FLOW
  • WLL ADDITIONAL POINTS
  • WLL ADJUST XS WIDTH
  • WLL AUTOMATIC
  • WLL NO WEIRS
  • WLL VERTICAL OFFSET
  • WLLP INTERPOLATE BED
  • WRITE CHECK FILES
  • WRITE CSV ONLINE
  • WRITE EMPTY MI FILES
  • XS DATABASE
  • ZERO CULVERT COEFFICIENTS

The following commands are ignored when read in by SMS because they are hardwired:

  • APPLY ALL INVERTS – Hardwired to “ON”
  • CONVEYANCE CALCULATION – Hardwired to “ALL PARALLEL”
  • FLOW AREA – Hardwired to “TOTAL”
  • WLL APPROACH – Hardwired to “Method B”

Related Topics