Running TUFLOW FV

From TUFLOW FV Wiki
Jump to: navigation, search
LINKS: Main page
Modelling Advice Tutorial Models Tips and Tricks
Mesh Generation Tips Tutorial Module 1 SMS
A Model Won't Start Tutorial Module 2 UltraEdit
A Model Crashes Tutorial Module 3 Notepad++
A Model Runs Slow Tutorial Module 4 Excel
TUFLOW Products Support / Contact TUFLOW FV Utilities
Requesting a Licence Running TUFLOW FV
Mesh Generation Tips



Introduction

There are several different ways available to run TUFLOW FV, ranging from simple double-click to advanced batch files. Keep in mind that for all approaches the executable is a single file “tuflowfv.exe”; the operating system, console program or 3rd party program simply accesses this file with associated command line arguments.

Double click tuflowfv.exe

The TUFLOW FV executable, tuflowfv.exe, is a command console program. A model is started by calling the executable with the control file (.fvc) as the first and only argument. If no argument is specified the command line will request the user input one.

Right Mouse Button in Microsoft Explorer

To start a simulation in Microsoft Explorer by using the right mouse button, complete the following steps to set up a file association:

  • In Explorer, open the “View” (or “Tools”), “Folder Options…” menu and select the “File Types” tab. If . fvc files are not in the “Registered file types:” list box, choose “New Type…”, otherwise select the .fvc file entry under “Registered file types:” as shown in Step 3 below.
  • If adding a new type, enter in a description (eg. “TUFLOW FV Control File”) and “fvc” as the associated extension (see below) and press OK.

Runfv 004.png

  • The Folder Options dialog should appear something like the below.

Runfv 005.png

  • Click “Advanced” to bring up the dialog below (you can add a new icon and change the file type description here).

Runfv 006.png

  • Choose “New…” and enter text to describe the “Action:” (eg. “Run TUFLOW FV”) – this text appears on the pop-up menu when you click the right mouse button on an .fvc file in Explorer. Enter or use “Browse…” to specify the path to TUFLOWFV.exe; note the need for quotes if the path has any spaces. After “TUFLOWFV.exe”, add a space then “%1” including the quotes, as shown below. Choose “OK”. The “Application used to perform action:” field should be something like:
"C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe" "%1"

Runfv 007.png

  • The action should now appear in the list under “Actions:”. It is not recommended that a “Run TUFLOW FV” action be set as the default action as it is easy to accidentally start a simulation, which instantly overwrites any existing result files. You may wish to set up other associations at this point, for example, to access your preferred editor.
  • Choose “OK” or “Close”, then “Close” on the “Folder Options” menu.
  • Check the file association, by clicking the right mouse button on an .fvc file in Windows Explorer. The “Run TUFLOW FV” action should appear in the list.

Once the file association is complete, clicking the right mouse button on an .fvc file in Explorer, and selecting “Run TUFLOW FV” starts a simulation. A Console Command Window opens and TUFLOW FV starts.

From a Console (DOS) Window or “Run”

A single simulation can be started directly from an open Console Window (also called “Command Prompt” in the list of programmes in Windows)Runfv 001.png or from the “start” then “run” commands Runfv 002.png Runfv 003.png
. For example, at the Console prompt enter:

“C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run01.fvc

Using a Batch File

One or many simulations, and other associated operations, can all be specified within a batch file. The simplest format is to specify each simulation one after another. The following shows the contents of a 4 line batch file (called “TUFLOW FV Simulations.bat”) which is located in the same folder as the TUFLOW FV control files (fvc):

“C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run01.fvc
“C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run02.fvc
“C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run03.fvc
pause

The .bat file is run or opened by double clicking on it in Explorer. This opens a Console Window and then executes each line of the .bat file. The pause at the end stops the Console window from closing automatically after completion of the last simulation. Note that the full path and executable is within double quotes; this is needed when there is a space in the command. Comment lines are specified in a .bat file using “#” in the first column, or alternatively a “REM”. For example, if you want to re-run only the first simulation in the examples above, edit the file as follows:

“C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run01.fvc
REM “C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run02.fvc
REM “C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run03.fvc
pause

The above batch files will run the TUFLOW FV simulations using the default "Normal" priority, and parallel processing of all available cores for multi-core machines. If you plan to undertake additional tasks on your computer in parallel to the TUFLOW FV simulation, it is preferred that the number of cores which TUFLOW FV calls be limited. When TUFLOW FV runs in parallel processing mode (using multiple cores), the utilisation rate of all cores is limited by the core with the least available CPU (ie. if a model is using 4 cores, though one is only being utilised by 50% due other software demands, all 4 cores will be limited by 50% for the TUFLOW FV simulation). In some instances, if a single core is likely to be used by another application, increased runtime efficiencies can be gained by limiting access to less cores, all of which will all be 100% fully utilised by TUFLOW FV

The below batch file syntax sets the TUFLOW FV simulations to run sequentially one after the other in low priority mode using only 3 computer cores (the computer has 4 available cores):

SET OMP_NUM_THREADS=3  
start "TUFLOW FV" /wait /low ”C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run01.fvc
start "TUFLOW FV" /wait /low “C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run02.fvc
start "TUFLOW FV" /wait /low “C:\Program Files\TUFLOWFV\exe\win32\TUFLOWFV.exe” run03.fvc
pause

From a Text Editor

TUFLOW FV can be run from the text editors Notepad++ and UltraEdit.

Notepad++

The steps required to configure Notepad++ are provided here: Run TUFLOW FV from Notepad++

From UltraEdit

The steps required to configure UltraEdit are provided here: Run TUFLOW FV From UltraEdit