Tuflow and estry manual Version 3

Appendix C.tgc File Commands

Allow Dangling Z Lines
Cell Size
Default Land Z
External Bndy
Grid Size (N,M)

Grid Size (X,Y)
Interpolate

Interpolate ZC
Orientation

Orientation Angle

Origin
Pause When Polyline Does Not Find Zpt
Read File

Read MI

Read MI Code

Read MI Location

Read MI [ Mat | IWL | CnM | Fric | WrF ]

Read MI Z Line

Read MI Zpts

Read MID [ Code | Mat | IWL | CnM | Fric | WrF ]

Read MID Grid

Read MID Zpts

Read TGF
Set [ Code | Mat | IWL | CnM | Fric | WrF ]

Set Zpt

Stop
Write MI Domain

Write MI Grid

Write MI Zpts
ZC == MIN(ZU,ZV)

C.1Grid Size, Location and Orientation Commands (.tgc)

Latitude == [ {0} | ] 8

MI Projection == [ <.mif file> |
] 8

Snap Tolerance == [ {0.001} | ] 9

BC Control File == <.tbc_file> 17

Check MI Save Date == [ {ERROR} | WARNING | OFF ] 17

Check MI Save Ext == [ {.tab} | ] 17

End 2D Domain 18

ESTRY Control File [ {} | Auto] == <.ecf_file> 18

Geometry Control File == <.tgc_file> 18

Log Folder == 18

Output Folder == 18

Read File == 18

Start 2D Domain == [ {} | <2d_domain_name> ] 19

Write Check Files == [ | {OFF} ] 19

Write Empty MI Files == [ {} | ] 20

End Time == 28

Number Iterations == [ {2} | ] 28

Start Time == 28

Timestep == 28

Timestep During Warmup == [ {timestep} |  ] 29

Warmup Time == [ {0} | ] 29

Calibration Points MI File == <.mif/.mid_file> 37

Display Water Level == , 37

Map Output Data Types == [ d E F {h} q R SS t {V} Z1 Z2 Z3 ZH ] 37

Map Output Format == [ {SMS} | SMS WITH LAND CELLS | RMA2 ] 38

Map Output Interval == 38

Mass Balance Output == [ ON | {OFF} ] 38

Read MI GLO == <.mif/.mid_file > 39

Screen/Log Display Interval == [ {1} | ] 39

Start Map Output == 39

Store Maximums and Minimums == [ ON | ON MAXIMUMS ONLY | {OFF} ] 39

Zero Negative Depths in SMS == [ {ON} | OFF ] 40

Bed Resistance Values == [ {MANNING N} | MANNING M | CHEZY ] 48

Depth/Ripple Height Factor Limit == [ {10} |  ] 48

Read Materials File == 48

Recalculate Chezy Interval == [ {0} |  ] 49

Global FC Ch Factor == [ {0.8} | ] 57

Read MI FC == <.mif/.mid_file> 57

CSV Time == [ {DAYS} | HOURS ] 65

Excel Start Date == 65

Read MI LP == <.mif/.mid_file> 65

Read MI PO == <.mif/.mid_file> 65

Start Time Series Output == 66

Time Series Output Interval == 66

Write PO Online == [ ON | {OFF} ] 66

Read MI IWL == <.mif/.mid_file> 74

Read MID IWL == <.mid_file> 74

Set IWL == 74

Read Restart File == <.trf_file> 82

Write Restart File at Time == 82

Write Restart File Interval == [ {0} |  ] 83

Cell Side Wet/Dry Depth == [ {0.03} | ] 91

Cell Wet/Dry Depth == [ {0.05} | ] 91

HX ZC Check == [ {ON} | OFF ] 91

SX ZC Check == [ {ON} | OFF ] 92

Wetting and Drying == [ {ON} | ON NO SIDE CHECKS | OFF ] 92

Free Overfall == [ {ON} | ON WITHOUT WEIRS | OFF ] 100

Free Overfall Factor == [ {0.8} | ] 101

Froude Check == [ {1} | ] 101

Froude Depth Adjustment == [ {ON} | OFF ] 101

Global Weir Factor == [ {1.0} | ] 101

Shallow Depth Weir Factor Cut Off Depth == [ {0} |  ] 101

Shallow Depth Weir Factor Multiplier == [ {1} | ] 102

Supercritical == [ {ON} | OFF | PRE 2002-11-AD ] 102

Viscosity Coefficient == [ {1} | ] 110

Viscosity Formulation == [ {CONSTANT} | SMAGORINSKY ] 110

Cell Size == 118

First Sweep Direction == [ AUTOMATIC | {POSITIVE} | NEGATIVE ] 118

Instability Water Level == [ {see_below} |  ] 126

Water Level Checks == [ {ON} | OFF ] 126

BC Database == <.csv_file> 134

BC Event Name == 134

BC Event Text == 135

Adjust Head at Estry Interface == [ {ON} | ON VARIABLE | OFF ] 143

Check Inside Grid == [ {ERROR} | WARNING | OFF ] 143

Extrapolate Heads at Flow Boundaries == [ ON | {OFF} ] 143

Null Cell Checks == [ ON | {OFF} ] 144

Oblique Boundary Alignment == [ {NEAREST TO LINE} | CENTRE TO CENTRE ] 144

Oblique Boundary Method == [ {ON} | ON METHOD 2 | OFF ] 144

Unused HX and SX Connections == [ {ERROR} | WARNING ] 145

Apply Wind Stresses == [ ON | ON VARIABLE | {OFF} ] 153

Start Wind Output at Time == 153

Wind Output Interval == 153

Apply Wave Radiation Stresses == [ ON | {OFF} ] 161

Wave Period ==
161

MI Projection ==
9

Snap Tolerance == [ {0.001} | ] 9

Check MI Save Date == [ {ERROR} | WARNING | OFF ] 17

Check MI Save Ext == [ {.tab} | ] 17

CSV Format == [ HORIZONTAL | {VERTICAL} ] 17

CSV Time == [ {DAYS} | HOURS ] 17

Log Folder == 17

Output Folder == 18

Read File == 18

Write CSV Online == [ ON | {OFF} ] 18

Write Empty MI Files == [ {} | ] 18

Write Check Files == [ | {OFF} ] 19

Bridge Flow == [ {Method A} | Method B ] 27

Culvert Flow == [ Method A | {Method B} ] 27

End Time == 27

Froude Check == [ {1} | ] 28

Froude Depth Adjustment == [ {ON} | OFF ] 28

Head Rate Creep Factor == [ | {1.2} ] 28

Head Rate Limit == [ ON | {OFF} | ] 28

Head Rate Limit Minimum == [ | {0.001} ] 28

Start Time == 28

Structure Losses == [ ADJUST | {FIX} ] 29

Timestep == 29

Vel Rate Creep Factor == [ | {1.2} ] 29

Vel Rate Limit == [ | {0.2} ] 29

Vel Rate Limit Minimum == [ | {0.0001} ] 29

Order Output == [ {ON} | OFF ] 38

Output Interval [ {} | (s) ] == 38

Output Times Same as 2D == [ {ON} | OFF ] 38

Read MI WLL == <.mif/.mid_file> 39

Read MI WLL Points == <.mif/.mid_file> 39

Start Output == 39

WLL Additional Points == [ {0} | ] 39

WLL Adjust XS Width == [ {ON} | OFF ] 39

WLL Approach == [ {Method A} | Method B ] 39

Apply All Inverts == [ ON | {OFF} ] 48

Conveyance Calculation == [ {CHANGE IN RESISTANCE} | ALL PARALLEL ] 48

Create Nodes == [ {ON} | OFF ] 48

Depth Limit Factor == [ {1} | ] 49

Flow Area == [ {EFFECTIVE} | TOTAL ] 49

M11 Network == <.nwk11_file> 50

Minimum NA == [ {0} | ] 50

Momentum Equation == [ PRE 2003-08-AD ] 50

Pit Channel Offset == [ {10} | ] 50

Read MI Network == <.mif/.mid_file> 50

Read MI Table Links == <.mif/.mid_file> 50

Read Materials File == 51

Relative Resistance == [ {RELATIVE} | MATERIAL ] 51

S Channel Approach == [ PRE 2004-06-AA ] 51

Storage Above Structure Obvert == [ {CHANNEL WIDTH} | ] 51

Trim XZ Profiles == [ ON | {OFF} ] 52

XS Database == 52

[ BG | CS | NA | VG ].... ! Fixed Field Flags 60

BG Data == 60

CS Data == 60

NA Data == 61

VG Data == 61

Read MI IWL == <.mif/.mid_file> 69

Set IWL == 69

BC Database == <.csv_file> 77

BC Event Name == 77

BC Event Text == 78

EB Data == 78

Read MI BC == <.mif/.mid_file> 78

Cell Size == 9

Grid Size (N,M) == , 9

Grid Size (X,Y) == ,  9

Orientation == , 9

Orientation Angle == 10

Origin == , 10

Read MI Location == <.mif/.mid_file> 10

Read TGA == <.tga_file> 18

Read TGF == <.tgf_file> 18

External Bndy == , , , 27

Read MI [ MAT | IWL | CnM | FRIC | WrF | FLC ] == 28

Read MI Code [ {} | BC ] == 28

Read MID [ CODE | MAT | IWL | CnM | FRIC | WrF | FLC ] == 28

Read MID Grid == 29

Set [ CODE | MAT | IWL | CnM | FRIC | WrF ] == 29

Write MI Domain == <.mif/.mid_file> 29

Write MI Grid == <.mif/.mid_file> 29

Allow Dangling Z Lines == [ ON | {OFF} ] 38

Default Land Z == 38

Interpolate ZC [ {} | ALL ] [ {} | LOWER ] 38

Interpolate [ ZHC | ZUVC ] [ {} | ALL ] [ {} | AFTER ] 39

Pause When Polyline Does Not Find Zpt == [ ON | {OFF} ] 39

Read MI Z Line [ {} | RIDGE or MAX | GULLY or MIN | HX ] [ {} | CC ] [ {} | THICK ] [ {} | ADD ] == 40

Read MI Zpts [ {} | ADD | MAX | MIN ] == 41

Read MID Zpts [ {} | ADD | MAX | MIN ] == 41

Set Zpt == 42

Write MI Zpts == 42

ZC == MIN(ZU,ZV) 42

Read File == 51

Stop 51

BC Database == <.csv_file> 9

BC Event Name == 9

BC Event Text == 10

Global Rainfall Area Factor == [ {1.0} | ] 10

Global Rainfall BC == 10

Global Rainfall Continuing Loss == [ {0} | ] 10

Global Rainfall Initial Loss == [ {0} | ] 10

Read MI BC == <.mif/.mid_file> 10

Read MI SA [ {} | Rainfall ] == <.mif/.mid_file> 11

Unused HX and SX Connections == [ {ERROR} | WARNING ] 11

Cell Size ==

(Mandatory if not specifying in .tcf file)

Sets the grid’s cell size in meters. This overrides any value specified in the .tcf file. The cell size must be specified either using this command or in the .tcf file.

Grid Size (N,M) == ,

(One GRID SIZE command is mandatory)

Sets the dimensions of the grid based on the number of rows and columns. Must be integer values.

Grid Size (X,Y) == , 

(One GRID SIZE command is mandatory)

Sets the dimensions of the grid using a distance along the grid’s X axis () and Y axis (). The number of columns and rows is rounded to the nearest integer, therefore, and do not have to be an exact multiple of the cell size.

Orientation == ,

(One ORIENTATION command is mandatory if Read MI Location not used)

Sets the geographical orientation of the grid using another point along the bottom of the grid. , defines any point on the grid’s X-axis relative to and (see above).

Orientation Angle ==

(One ORIENTATION command is mandatory if Read MI Location not used)

Sets the geographical orientation of the grid using an angle. The angle is in degrees relative to east (eg. X-axis directly north would be 90).

Origin == ,

(Mandatory if Read MI Location not used)

Sets the geographical origin of the grid, the origin being the lower left corner of the lower left cell. is the X coordinate in meters and the Y coordinate.

Read MI Location == <.mif/.mid_file>

(Mandatory if Origin and Orientation commands not used)

Sets the geographical origin and orientation of the grid based on the first line, polyline or region found in .mif/.mid_file. The orientation is based on the first point in the line or region being located at the bottom left corner of the grid.

If a line or polyline is used the second point is located anywhere along the bottom of the grid to set the orientation of the grid – it does not determine the length of the grid along the X-axis (use Grid Size (N,M) or Grid Size (X,Y) to set the size of the grid). If using a polyline it must only have two points (vertices) otherwise TUFLOW stops with an error.

If a region is used it must have four sides digitised clockwise. The second vertex is located at or close to the top left corner of the 2D grid. The distance from the first to second vertices determines the length of the grid’s Y-axis. The third vertex is not used. The fourth vertex is located at the bottom right corner of the grid. The distance from the first to fourth vertices determines the length of the grid’s X-axis. The grid’s orientation is determined from the line passing from the first vertex to the fourth vertex. The region approach was incorporated at Build 2002-10-AG.