fvc command line syntax

[Guest Chris Nielsen]

What are the general syntax rules for inserting commands into the TUFLOW FV fvc input file?

[Guest Chris Nielsen]

Each command line entry is defined by a descriptor, followed by a “==”, followed by the specified value (or values) for the particular command line. For example, the line "time format == hours" has a descriptor (time format) which is assigned a value of (hours).

 

For command lines that have a series of values to specify, a “,” separator is specified in the syntax. For example, “Timestep Limits == 0.1, 10.0” is a command line that requires specification of two values.

 

 

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, 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 etc are either unused or remain as the default value.