11.2 File Naming

A single hydrodynamic model may generate a large number of input, check, and result files over the course of development and execution. Establishing a clear and consistent naming convention is an important aspect of model development. Effective naming conventions support interpretation, organisation, error checking, quality control, and traceability for quality assurance purposes.

The examples provided illustrate progression from a simple naming convention to more detailed conventions that account for different events and scenarios. The focus is on naming of the .fvc control file, as this determines the prefix applied to associated check, result, and log files.

Use of concise file names, with acronyms where appropriate, supports clarity and manageability. For example, for a model of the Hawkesbury River with a simulation period from 1 January 2019 to 3 January 2019, the file name HR_20190101_20190103_001.fvc is preferable to Hawkesbury_River_01_January_2019_03_January_2019_001.fvc.

Example 1

HR_001.fvc

In its simplest form, TUFLOW FV model names consist of a short study identifier combined with a version number. The study identifier is typically used across all input files to indicate that the files are specific to a particular study. The version number is used to distinguish different iterations of the model. Each time a change is made and the model is rerun, the version number is incremented. This approach supports clear identification of which input files produced a given set of model outputs and is important for troubleshooting and quality control activities.

Example 2

HR_20190601_20190831_001.fvc

HR_20200601_20200831_001.fvc

Many hydrodynamic modelling studies require simulation of multiple events or combinations of events, such as differences in magnitude, duration, temporal pattern, or climate condition. In these cases, inclusion of an event identifier within the simulation name is preferable to relying only on version numbering.

In the examples shown, a consistent date format is used to represent Australian winter periods from 1 June 2019 to 31 August 2019 and from 1 June 2020 to 31 August 2020. The same number of characters is used for both file names. Consistent character length supports correct alphabetical ordering when files are viewed in Windows Explorer. The version number is unchanged in this example, indicating that the same model configuration was applied to two different simulation periods.

Section 11.3.3 describes the Events functionality, which supports simulation of one or more events using a single .tef control file.

Example 3

HR_20190101_20190103_EXG_001.fvc

HR_20190101_20190103_DEV_001.fvc

Many hydrodynamic modelling studies require simulation of multiple scenarios, such as existing and development conditions or sensitivity testing where one or more model parameters are varied. Including the scenario identifier within the .fvc file name distinguishes outputs associated with each scenario. The characters used to represent the scenario are typically applied consistently to scenario specific model input files.

For example, a development scenario identified as DEV may include construction of a new weir structure. In this case, a GIS layer used to represent the weir may be named 2d_ns_HR_DEV_weir_001.shp. Presence of this layer within a simulation representing the existing scenario identified as EXG indicates an inconsistency in scenario configuration.

Section 11.3.4 describes the Scenarios functionality, which supports modelling of one or more scenarios using a single .fvc control file.