Application Settings

Limit the range of vector length

If vectors (for flows and velocities) are scaled relative to data values then this setting allows outliers (very large and very small vectors) to be limited to set upper and lower limits.

Load each N vectors

set N to load a lower resolution of vector arrows, e.g. 1 in 4.

Display each N Vectors (from loaded)

Set N to show 1 in N vectors on screen, i.e. load all data into memory so it is available to analysis tools, but show a lower resolution on screen to improve performance.

Default vector length multiplier coef.

factor to increase (or decrease) vector lengths on screen (when vectors are scaled to data magnitudes).

Average SMS vertex values

When you load a 2D results file into the Flood Modeller interface, it needs initial values for the vertex data. This option provides default initial values for those vertex properties. These initial values are used until the actual simulation results are loaded.

Default Manning roughness

It serves as a starting point or default value for the Manning's 'n' coefficient. When you create a new river section or floodplain, this default value is applied unless you explicitly set a different value.

Default relative path length

This parameter comes into paly when dealing with compound channels. For such channels, where a low flow channel meanders within a floodplain, the ratio of the flow path length in the floodplain to the flow path length in the low flow channel can be specified. This ratio is declared after each panel marker and applies to the coordinates on subsequent data sets until the next panel marker is encountered. The default value for the relative path length ratio is 1.0, meaning equal lengths in both the floodplain and low flow channel. The relative path length ratio cannot be negative.

Use nearest valid point properties

When extending or modifying 1D cross sections, this checkbox comes into play. By default, this option is enabled. When extending a cross section, Flood Modeller looks for the nearest valid point (an existing point with known properties) and uses its properties as a starting point for the extension. Essentially, it ensures that the extended portion of the cross section inherits properties from nearby valid points.

Use integrated codec

Radio button to use the default codec included with the Flood Modeller installation.

Use manually selected codec

Radio button to browse to an alternative codec available on your system.

Add spatial data to project when adding 2D simulation

Use relative paths in project file

If this box is ticked then when you save your project the files referenced within it will be saved with file paths relative to the project file folder. Note that “files within files” will not be converted to relative paths, e.g. 1D simulation files (ief files) in your project will be saved with a relative path, however event file and network file references within each ief file will not be converted to relative paths.

Add spatial data to project when adding 2D simulation

If this box is ticked then when you save your project the files referenced within it will be saved with file paths relative to the project file folder. Note that “files within files” will not be converted to relative paths, e.g. 1D simulation files (ief files) in your project will be saved with a relative path, however event file and network file references within each ief file will not be converted to relative paths.

Use relative paths in project file

When you create or save a Flood Modeller project, it may reference various files such as GIS datasets, simulation results, and other related data. Enabling this checkbox ensures that these file references are saved with paths relative to the project file folder.

Always show run interface after adding a simulation

Setting for 2D models. When an existing 2D model is added to your project then it will automatically open in the 2D simulation window if this setting is ticked.

TUFLOW engine file location

Specify the path to your TUFLOW installation to enable TUFLOW models (tcf file) to be run from the Project Panel of the Flood Modeller Interface (this option should not be confused with setting Flood Modeller-TUFLOW linking; setting the path to the TUFLOW installation on the Project settings tab of the Application Settings form does not assist with the setup of integrated Flood Modeller - TUFLOW modelling).

Show solver window when running simulations

Allows you to monitor the simulation progress in real time and respond to any solver-related prompts.

Save simulation summary files

Check this box to save the data and plots displayed at simulation runtime in .xml format.

Associate project file extension (.fmpx) with Flood Modeller interface

This setting will set up a link in Explorer between your project files and the Flood Modeller interface. This enables you to double-click on a project file in Explorer to open Flood Modeller with the project automatically loaded.

Relaunch as Administrator

Note that this setting is only available if you have Administrator rights on your system.

Initial map extent

Type in values to define the initial dimensions to your map view. These will be utilised to provide an initial map extent when you start a new 1D network build (particularly applicable if you are not using any background mapping, i.e. creating more of a schematic view). This setting provides only the initial extent, which can then be changed using the zoom and pan tools.

Default 1D river / 2D units

Sets the project units to either SI (metric units, e.g. mm, km) or US (United States customary units, e.g. inches, miles). Your map will then use these units and new 1D and 2D models will be specified with this setting. Also existing 1D networks loaded in your project and set to use the system default units will be updated to this setting. Note that individual models within your project can have their own unit setting that will override this project setting. These are set as follows:

• 1D networks – unit setting is accessed by double-clicking the General row at the top of the Network table. Default setting for networks is “Default”, i.e. to use the project units setting.

• 2D models – unit setting is accessed by right-clicking on the lower right corner of the status bar of the 2D simulation window. This displays a menu that includes unit selection options. The initial setting for a new 2D model will be the current project setting.

Map projection to use

Refers to how the three-dimensional Earth’s surface is represented on a two-dimensional map.

• Base Maps (Google Mercator) - refers to using the Google Mercator projection as the coordinate system for displaying background maps (basemaps) within your Flood Modeller project. This projection is commonly used for web-based mapping services, including Google Maps and other online mapping platforms.

• Same as project - ensures that the background maps (basemaps) match the map projection you’ve defined for your entire Flood Modeller project. If your project is already in a specific projection (e.g., UTM, Lambert Conformal Conic), selecting this option ensures that the basemaps align with the same projection.

Default project projection

Refers to the initial map projection assigned to new projects. 

• Initial Projection for New Projects - when you create a new project in Flood Modeller, it is initially assigned a default map projection. By default, this setting is the British National Grid (OSGB 1936) projection. However, users have the flexibility to change this default projection based on your specific needs.

• Editing the Default Projection - to modify the default projection: 

  • Open the Application Settings window.

  • Look for the General Settings section.

  • Here, you can specify a different map projection as the default for new projects.

  • Click Apply to apply the change while remaining in the Application Settings window, or click OK to apply the change and close the window.

• At any time, you can check the current projection details by going to the Info tab within the Start tab, then clicking Set Projection to view or edit the current projection.

Set Projection

Allows you to view and edit the map projection associated with your project.

Proxy settings

A web proxy filters websites that you look at, it receives requests from your web browser to fetch web pages and their elements, and following a policy will decide to pass them you back or to block them. Flood Modeller can be configured to utilise online mapping data. One option available in Flood Modeller is to specify and load a WMS layer. A Web Map Service (WMS) is a standard protocol for serving (over the Internet) georeferenced map images which a map server generates using data from a GIS database. In order for Flood Modeller to access the GIS data available through the WMS it must access the internet. Flood Modeller will try to utilise the default proxy settings for your system to do this. However, in some cases you may need to setup specific proxy settings to enable web access, i.e. if your standard proxy settings are configured such that they blocks access for Flood Modeller. In this case you may need to get assistance from your IT department to obtain the required custom settings (alternatively they may add Flood Modeller to a “safe” list allowing it access through your default settings).

Online Basemap Key

Another source of background map data available in Flood Modeller is online base maps. Flood Modeller provides direct links to a number of online map data sources. Activating one of these will display background mapping in the map view for your model extent. Some base map options utilise key codes:

• For Bing Maps: Keys were obtained from the Microsoft website (free of charge). However, Microsoft has recently discontinued their Bing Maps service (it is replaced by Azure Maps). This means new keys can no longer be obtained from Microsoft. If you have an existing Bing Maps key though, this will remain valid until June 2025 and therefore it can still be used in Flood Modeller.

• For OS Maps: A new key can be obtained from the OS data hub website. To download OS keys, users need to create an account on the OS website and purchase the key.

• For Open Street Map (OSM): No key is required for this data source and so selecting this option should immediately display background map data in your map view.  

If no map data appears for your selected base map it could be that no data exists for the current map extent. In this case maybe check the current map projection is appropriate for the selected base map and loaded GIS datasets.

Fathom settings

Credentials related to integration with the Fathom, which provide flood hazard maps with global coverage. These credentials allow Flood Modeller to access Fathom’s services and retrieve flood risk data. These credentials consist of two parts:

• Client ID - A unique identifier assigned to your Flood Modeller instance when connecting to Fathom.

• Client secret - A confidential key used for secure communication between Flood Modeller and Fathom.

Further details on this feature can be found in this article on Fathom data.

1D model build cursor options

there are two related settings here:

• The tick box signifies whether a new node being added will be represented by its associated icon or by the mouse draw icon (a pencil icon). If the box is ticked then the node icon will be shown on screen as you drag it to the required location on the map.

• The opacity slider is relevant only if you are using node icons when adding new nodes. The slider sets how transparent the new icon will display on the map as you drag it to the required location. Slider all the way to the right will display the icon solid, whereas slider all the way left will display just a red box to outline the new node.

1D unit positioning

Building 1D networks in the map view requires you to select a 1D icon (from the 1D Build tab of the main toolbar) and then click on the map at the desired location of the new node. Once you have specified a node label then an appropriate node icon will be displayed. The size of the icon is significantly larger than if the node was represented by a point (which it can be if unit icons are turned off – main toolbar setting). By default the centre of each node icon represents the actual point location of the node. However you have the option here of instead using the lower left corner of the icon as the point location of each model node. Note that this setting does not affect the node location coordinates stored in your network files. It only affects the position of each node on the map (when using icons to represent them).

Avoid collisions when displaying gauges

Selecting this checkbox will reduce the number of gauge station icons displayed in the map depending on the zoom level selected to avoid repeated gauge icons in similar locations (that overlap at the chosen zoom level).

Show summary gauge information when selecting a gauge

Checkbox to display a label for each selected gauge providing a summary of the gauge data.

Update gauge information from file

This button allows you to browse to a file on your machine to update gauge information.

Colour selections

To set display colours for the FEH catchment polygons on the map, both when selected and not selected. Note that changes made will not affect any catchments already loaded - you must unload and reload these, or restart Flood Modeller, for the change to take affect. 

Transparency sliders

To set the displayed transparency of the FEH catchment polygons on the map, both when selected and not selected. Note that changes made will not affect any catchments already loaded - you must unload and reload these, or restart Flood Modeller, for the change to take affect.

Reset to default

Resets all options for the colour and transparency above. Note that changes made will not affect any catchments already loaded - you must unload and reload these, or restart Flood Modeller, for the change to take affect.

Remind me to backup the database every X days after the previous backup

Field to provide a number of days between database backups. After this number of days, the software will remind you to perform a backup, if the checkbox at the bottom of the tab is checked on.

Last backup date

This field displays the date of the last backup and will automatically update when another backup is performed. 

Next backup date

The date for the next backup, based on the number of days provided in the top field, and the date of the previous backup.

Backup now...

Button to perform a Hydrology+ database backup immediately. You will need to provide a filename and location, together with a description.

Restore...

Button to restore the database to a previous version. When you click on this button, Flood Modeller prompts you to select a previously created backup file. By choosing the appropriate backup, you can restore your hydrology database to the state it was in when the backup was created.

Show database backup reminder

When checked, the software will display a pop-up reminder to backup your database on the date provided in the Next backup date field above.