Download TUFLOW FV User Manual
Transcript
Command File (FVC) Reference 7.2 12 Command Line Syntax Each command line entry is defined by a descriptor, followed by a “==”, followed by the specified value (or values) for the particular command line. The syntax in the tables that follow use a triangular bracket to specify a value that requires user specification. As an example, for the command line “Include == <file name>” the syntax inserted into the fvc would be (for example) “Include == includefile.inc”. For command lines that have an option of several values, a “;” separator is specified in the syntax. For example, the command line “Time format == <Hours;ISODate>” requires a choice of two options, so that the command line will be either “Time format == Hours ” or “Time format == ISODate”. For command lines that have a series of values to specify, a “,” separator is specified in the syntax. For example, the command line “Timestep Limits == <min timestep (s), max timestep (s)>” requires two entries in the command line, such as “Timestep Limits == 0.01, 10.0”. Some command lines specify an “on or off” switch for a particular parameter. In such cases a “1” means “on” (or TRUE) and a “0” means “off” (or FALSE). When specifying file names in the fvc file it is recommended that relative file paths are specified. This will make the TUFLOW FV simulation files more portable (it’s easier to move an entire folder structure in this way). However, a full path name can also be inserted if preferred (a common example is when output files are written to a separate folder on another disk drive). Strictly speaking, TUFLOW FV inputs are entered as integers (whole numbers), reals (float, or decimal numbers) and characters (text). The command line entries in the following tables adhere to this syntax, although real numbers can be inserted as integers. For example, the default “CFL == 1.0” can also be entered as “CFL==1”. Finally, take note that not all command lines have to be included in an fvc file. A simple model setup often requires only a small list of command lines, while the remaining model parameters are either unused or remain as the default value. TUFLOW FV USER MANUAL BUILD 2014-01