14.3 Simulations .log
TUFLOW activity (when simulations are started, finished, interrupted) is written to two log files:
- A local file named “\_ TUFLOW Simulations.log”, located in the same folder as the .tcf file. This file is described in Section 14.3.1.
- A global log file that can optionally be located in a fixed location on your organisation’s intranet. By default this is written to “C:\ProgramData\TUFLOW\
\log\_All TUFLOW Simulations.log”. To alter the location of this, use the Simulations Log Folder tcf command. This global log file can also be disabled by setting the Simulations Log Folder command to “DO NOT USE”. This file is described in Section 14.3.2.
14.3.1 Local .log File
The “\_ TUFLOW Simulations.log” file is a text file containing a record of every simulation initiated from that folder, and is located in the same folder as the .tcf file(s). For the 2023-03 release, information contained in the file includes the following:
- Date and time of the log entry;
- Dongle ID (if applicable);
- Type of TUFLOW licence. The notation on the type of licence varies depending on the licence origin as follows:
- WIBU Licence:
- LOC3/4 for a Local (Standalone) Licence (the numbers in this example indicate it was the third licence out of four available).
- NWK03/10 for a Network Licence (the numbers in this example indicate it was the third licence out of ten available).
- LOC3/4 for a Local (Standalone) Licence (the numbers in this example indicate it was the third licence out of four available).
- Jacobs (Flood Modeller) Software Licence:
- “HalcS” for a local Standalone licence
- “HalcN” for a network licence
- “HalcS” for a local Standalone licence
- XP-Software Licence:
- “XP” for all types of licences.
- “XP” for all types of licences.
- A Tutorial Model (no dongle required):
- “TUT” for all tutorial or demo models.
- “TUT” for all tutorial or demo models.
- WIBU Licence:
- Computer Name on which the simulation is being run;
- TUFLOW Build ID;
- Time:
- Clock time “CT” after initialisation;
- Processor time “PT” after initialisation;
- Clock time “CT” at end of simulation;
- Processor time “PT” at end of simulation;
Note that the processor time is summed across all threads and includes GPU hardware. If parallel processing is used in model initialisation or solver this number may be larger than clock time.
- Hardware type and number of processor used:
- “CPUx1” for a model run using one CPU thread;
- “GPUx1” for a model run using one GPU card;
- Simulation status as one of the following:
- “Started”;
- “Finished”;
- “Interrupted” (the simulation was stopped by pressing Ctrl+C);
- UNSTABLE (the simulation became unstable based on the water level exceedance
checks).
- “Started”;
- Simulation name;
- Performance for “Finished” or “Interrupted” simulations:
- “HPC Solver Used” for models using the HPC Solver.
- For models using the Classic Solver:
- “fCME” is the Final Cumulative Mass Error at the end of the simulation.
- “pCME” is the Peak CME throughout the whole simulation.
- “pCME5” is the Peak CME for the period of the simulation that the flow in and out of the model exceeds 5% of the peak flow in and out (this value generally excludes any initial high ME values that may occur at the start of some simulations).
- “pddV” is the Peak change in dV (change in volume) over one timestep divided by the peak dV value expressed as a percentage.
- “pddV5” is the same as pddV but over the period of the simulation where the flow in and out of the model exceeds 5% of the peak flow in and out.
- “fCME” is the Final Cumulative Mass Error at the end of the simulation.
- .tcf filename;
- .tlf filepath.
It is strongly recommended that this file is not deleted or edited as it could provide a valuable trace back to past simulations.
Excerpts from a local “\_ TUFLOW Simulations.log” file are shown below:
2024-May-30 13:46 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Started: M05_001_CLA M05_001.tcf “D:\TUFLOW\runs\log\M05_001_CLA.tlf”
2024-May-30 13:47 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Ini: 0:00:01 CT 0:00:00 PT Tot: 0:00:41 CT 0:00:00 PT CPUx1 Finished:M05_001_CLA fCME = -0.78% pCME = -2.12% pCME5 = -0.78% pddV = 3% pddV5 = 2% M05_001.tcf “D:\TUFLOW\runs\log\M05_001_CLA.tlf”
2024-May-30 13:47 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Started: M05_001_HPC M05_001.tcf “D:\TUFLOW\runs\log\M05_001_HPC.tlf”
2024-May-30 13:47 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Ini: 0:00:02 CT 0:00:00 PT Tot: 0:00:17 CT ——- PT GPUx1 Finished: M05_001_HPC HPC Solver Used. M05_001.tcf “D:\TUFLOW\runs\log\M05_001_HPC.tlf”
2024-May-30 13:47 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Started: M05_001_HPC_CPU M05_001.tcf “D:\TUFLOW\runs\log\M05_001_HPC_CPU.tlf”
2024-May-30 13:48 Don: 00004465001 NWK 01/20 BMT-1 Build: 2023-03-AE-iSP-w64 Ini: 0:00:01 CT 0:00:00 PT Tot: 0:01:18 CT 0:02:16 PT CPUx4 Finished: M05_001_HPC_CPU HPC Solver Used. M05_001.tcf “D:\TUFLOW\runs\log\M05_001_HPC_CPU.tlf”
14.3.2 Global .log File
This file is named “\_ All TUFLOW Simulations.log” and by default is located in a folder called “C:\ProgramData\TUFLOW\
The path to the global .log file can be changed using the following options:
- For all types of licenses use the Simulations Log Folder command in the Dongle Control File (see Section 13.4.1.2).
- Alternatively, use Simulations Log Folder in the .tcf file (this option is given priority over the option above).
- For either of the options above, if the keywords “DO NOT USE” occur within the folder path or URL name, writing to the global .log file is disabled.
The entries to the global .log file are as described for the local .log file above, but will be for all simulations carried out across the organisation (provided they are all referencing the same folder).