9.5 Data Output

9.5.1 TUFLOW AD Log Files

TUFLOW AD log files are written to the location specified by Log Folder command in the .tcf file, or if this command is not used the same location as the .tcf file. The following logs are available:

  • An AD simulation log file (.adlf);
  • A CFL condition log file - output when using Write CFL == ON, for TUFLOW Classic only; and
  • A mass balance log file - output when using Write Mass == ON.

9.5.1.1 Simulation Log File

This file is named ‘TCF name.adlf’. It contains commentary of input reading, constituent specification etc. as the simulation sets itself up.

Following model initialisation, if Write Iterations == ON is used, for TUFLOW Classic only, the following is output at each timestep. For example:

Simulation time (h) 0.0125
Finished constituent Tracer_01 at AD substep iteration number 1
Finished constituent Tracer_02 at AD substep iteration number 1
Finished constituent Tracer_02 at AD substep iteration number 2
Finished constituent Tracer_02 at AD substep iteration number 3

These lines show information regarding the simulation time for each constituent. In particular, the number of AD sub-steps needed to be executed to maintain stability under CFL and Peclet conditions is reported. In the above example, constituent Tracer_01 required no substepping, whilst constituent Tracer_02 required 3 substep iterations to maintain stability. This is caused by Tracer_02 being set up with greater dispersion coefficients than Tracer_01 in the AD Global Database. Additional rows are added as required by the number of constituents simulated.

This TUFLOW AD timestep information is not available for TUFLOW HPC, or needs review by the modeller, due to the fact the TUFLOW HPC hydraulic engine and advection dispersion calculations are performed on the same timestep and with the same scheme. See Section 9.3.4 for discussion regarding timestep differences relating to TUFLOW Classic and TUFLOW HPC.

9.5.1.2 CFL Log File

This file is named ‘TCF name_ADcfl.csv’. It can be output when using TUFLOW Classic in conjunction with the Write CFL == ON command. It contains commentary on CFL and Peclet numbers, maximum dispersion coefficients and number of substep iterations. The column data is as per Table 9.6:

Table 9.6: _ADcfl.csv File Columns
Column Description
time (h) The simulation time in hours.
Constituent Name The name of the constituent as specified in the AD global database.
Max_CFL_u The maximum CFL for u velocities anywhere in the computational domain at that timestep.
Max_CFL_v The maximum CFL for v velocities anywhere in the computational domain at that timestep.
Max_Peclet_u The maximum Peclet number for u dispersion anywhere in the computational domain at that timestep.
Max_Peclet_v The maximum Peclet number for v dispersion anywhere in the computational domain at that timestep.
Max_sum_u The maximum of the sum of CFL and Peclet numbers in the x (u) direction anywhere in the computational domain.
Max_sum_v The maximum of the sum of CFL and Peclet numbers in the y (v) direction anywhere in the computational domain.
Max_Disp_x The maximum dispersion coefficient in the x (u) direction anywhere in the computational domain.
Max_Disp_y The maximum dispersion coefficient in the y (v) direction anywhere in the computational domain.
Num_iterations The number of iterations required by TUFLOW AD to remain stable. This can vary from constituent to constituent if different dispersion coefficients are applied.

As per the TUFLOW AD timestep information in the ‘.adlf’ file. This log information is not available for TUFLOW HPC, or needs review by the modeller, due to the fact the TUFLOW HPC hydraulic engine and advection dispersion calculations are performed on the same timestep and with the same scheme. See Section 9.3.4 for discussion regarding timestep differences relating to TUFLOW Classic and TUFLOW HPC.

9.5.1.3 Mass Log File

This file is named ‘TCF name_ADmass.csv’. It can be output when using TUFLOW Classic or TUFLOW HPC in conjunction with the Write Mass == ON command. It contains commentary on mass conservation. Specifically, the column data is as per Table 9.7:

Table 9.7: _ADmass.csv File Columns
Column Description
time (h) The simulation time in hours.
Constituent Name 1 The total mass of that constituent in the computational domain. TUFLOW AD assumes that the constituent concentrations are specified in mg/L, and this number is then in tonnes of constituent. If the concentration is g/L, then this number should be multiplied by 1000 to be in units of tonnes.
Constituent Name 2 As per constituent 1. Column repeated until all constituents have been accounted for

9.5.2 Check Files

When using the AD module, a _AD_check file is generated. For more information, see the TUFLOW Wiki Check Files 2d ad check page.

9.5.3 Result Files

Result files contain the computed spatial and temporal evolution of simulated constituents. The output is a temporal format (maximums are not available) and will be output in the format specified by the Map Output Format command. For example, if Map Output Format == XMDF is used, the XMDF output will contain a result type called “Conc Tracer_X”.

The AD output will automatically be produced unless the Map Output Data Types command is set to “AD OFF”. This off option can also be set on a Map Output format basis (e.g. FLT Map Output Data Types == AD OFF).

Plot Outputs are currently not supported for TUFLOW AD outputs.