8.10 Model Outputs

8.10.1 Command Status

Optional - ST features can be optionally added to the model output implementations specifed during 2D HD, 3D HD or AD model construction.

8.10.2 Description

Sediment related outputs are generated in the same manner described in Sections 5.18, 6.11 and 7.13. These can be written together with other outputs (such as water levels) or in standalone output files.

8.10.2.1 Output Block

There are no additional output block commands for the ST simulation class.

8.10.2.1.1 Output Parameters

Table 8.10 lists the sediment output parameters available through the Output Parameters command. These parameters can be used with the standard output types that require user specified parameters, such as mesh, points and profiles and are suitable for general post processing in GIS software such as QGIS.

Table 8.11 lists multidimensional sediment variables available through the Output Parameters command. These are written as number of sediment fractions by number of cells arrays and are supported for NetCDF mesh outputs only. They are not intended for standard GIS workflows and are typically accessed using the TUFLOW FV Python Toolbox, TUFLOW FV MATLAB toolbox or an equivalent multidimensional NetCDF handling library.

Output parameters are not required for flux, mass or mass balance outputs so the tables below do not apply to those output types.

Table 8.10: **Output Parameters - Sediment Simulation Class**
Ouptut Parameter	Description	Units (Metric)
KSC	Current related effective bed roughness.	m
KSW	Wave related effective bed roughness.	m
KSA	Apparent bed roughness.	m
TAUC	Current related effective bed shear stress component.	N/m²
TAUW	Wave related effective bed shear stress component.	N/m²
TAUCW	Combined effective current/wave bed shear stress.	N/m²
DZB	Change in elevation between current output time and model start time (Current ZB – Start ZB).	m
ZB	Bed elevation at current ouput time.	m
THICK	Total bed thickness.	m
D10_LAYER_#	Tenth percentile (d10) sediment grain size for layer #.	m
D50_LAYER_#	Median (d50) sediment grain size for layer #.	m
D90_LAYER_#	Ninetieth percentile (d90) sediment grain size for layer #.	m
SED_#	Suspended concentration of sediment fraction #.	g/m^3
TSS	Total suspended solids concentration of all fractions.	g/m^3
DEPOSITION_TOTAL	Total deposition rate of suspended sediment.	g/m²/s
PICKUP_TOTAL	Total pick up rate of suspended sediment.	g/m²/s
NETSEDRATE_TOTAL	Sum of the total deposition and pick up rates.	g/m²/s
BED_MASS_TOTAL	Total bed mass.	kg/m²
BED_MASS_LAYER_#_TOTAL	Bed mass of all fractions in layer #.	kg/m²
BED_MASS_LAYER_#SED#	Bed mass of sediment fraction # in bed layer #.	kg/m²
SUSPLOAD_TOTAL	Vector components of total suspended load.	g/m/s
SUSPLOAD_SED_#	Vector components of suspended load of sediment fraction #.	g/m/s
BEDLOAD_TOTAL	Vector components of total bedload.	g/m/s
BEDLOAD_SED_#	Vector components of bedload for sediment fraction #.	g/m/s
SEDLOAD_TOTAL	Vector components of total sediment load	g/m/s

Table 8.11: **Multidimensional Output Parameters - Sediment Simulation Class**
Ouptut Parameter	Description	Units (Metric)
SETRATE	Settling velocity.	m/s
DEPOSITION	Deposition rate of each suspended sediment fraction.	g/m²/s
PICKUP	Pickup rate of each suspended sediment fraction.	g/m²/s
NETSEDRATE	Net rate of each suspended sediment fraction (Deposition-Pickup).	g/m²/s
BED_MASS	Bed mass of each sediment fraction over all bed layer.	kg/m²
BED_MASS_LAYER_#	Bed mass of each sediment fraction in bed layer #.	kg/m²
SUSPLOAD	Vector components of suspended sediment load for each sediment fraction.	g/m/s
BEDLOAD	Vector components of beload for each sediment fraction.	g/m/s
SEDLOAD	Vector components of total sediment load for each sediment fraction.	g/m/s

8.10.3 Mesh

Mesh output blocks are described in Section 5.18.3 and Section 6.11.3. These can be extended to include sediment output parameters from Table 8.10. The multidimensional output parameters listed in Table 8.11 are supported for NetCDF mesh outputs only. XMDF and datv do not support these variables.

The example below writes a sediment focused mesh output file containing water level, velocity, two sediment fractions, bed depth and total bed mass.

! Sediment NetCDF mesh output
Output == netcdf ! Mesh output written to NetCDF
Output Parameters == h, v, sed_1, sed_2, db, bed_mass_total ! Water level (mRL), velocity (m/s), sediment fraction 1 (g/m^3), sediment fraction 2 (g/m^3), bed elevation (mRL) and total bed mass (kg/m^2)
Output Interval == 3600. ! {0.0} Output interval (s)
Suffix == SED ! {No default} Output file suffix
End Output

8.10.4 Points

Point output blocks are described in Section 5.18.4 and Section 6.11.4. These can be extended with inclusion of the sediment keywords (see Section 8.10.2.1.1), or entirely new blocks can be created with only these quantities as needed. If depth averaging is applied then water column based output variables (such as sediment concentrations) are computed accordingly. Bed related output variables are reported without respect to averaging commands.

Outputs are additional columns to the output csv file. Column headers are an underscore separated concatenation of each point name and output variable name followed by the units of the reported numbers in square brackets.

! Lake Outlet
Output == Point ! CSV timeseries at each output point
Read GIS PO == ..\model\gis\3d_po_ML_001_P.shp ! Point locations
Output Parameters == h, sed_1, sed_2, zb, bed_mass_total ! Water level (mRL), sediment fraction 1 (g/m^3), sediment fraction 2 (g/m^3), bed elevation (mRL) and total bed mass (kg/m^2) Output Interval == 900. ! {0.0} Output interval (s)
End Output

8.10.5 Profiles

Profile outputs are configured in the same manner as points. The only exception is use of Output == Profile.

! Lake Outlet
Output == Profile ! NETCDF profile at each output point
Read GIS PO == ..\model\gis\3d_po_ML_001_P.shp ! Point locations
Output Parameters == v, sed_1, sed_2 ! Velocity (m/s), sediment fraction 1 (g/m^3) and sediment fraction 2 (g/m^3)
Output Interval == 900. ! {0.0} Output interval (s)
End Output

8.10.6 Polyline

Polyline (also referred to as flux) output blocks are described in Sections 5.18.5 and 7.13.6. These automatically include reporting of fluxes of all simulated quantities and do not require specification of sediment keywords. Outputs are additional columns to the output csv file with the following units.

Suspended sediment: tonnes/s
Bedload sediment: tonnes/s

The number of new columns is the product of the number of polylines specified in the GIS polyline layer(s) and the number of sediment fractions simulated. Column headers are an underscore separated concatenation of each polyline name, constituent name and _FLUX_ (e.g. Bridge_SED_1_FLUX) followed by the units of the reported numbers in square brackets (e.g. [g/s]).

8.10.7 Structure

The structure output type (also referred to as structflux output) is described in Sections 5.18.6 and 7.13.7. These automatically include reporting of fluxes of all simulated quantities through structures and do not require specification of sediment keywords. Outputs are additional columns to the output csv file with the following units.

Suspended sediment: tonnes/s

Bedload is not currently transferred through structures.

The number of new columns is the product of the number of structures specified in the model and the number of sediment fractions simulated. Column headers are an underscore separated concatenation of each structure number, constituent name and _FLUX_ (e.g. STRUCTURE_1_SED_1_FLUX) followed by the units of the reported numbers in square brackets (e.g. [tonnes/s]). The structure number is determined by the order that the structure block appears in the .fvc file.

8.10.7.1 Bubble Plumes

If bubble plume diffusers are simulated then an additional suite of columns are automatically included in the structure output. These describe the flux of each sediment fraction entrained by each bubble plume structure with the following units.

Suspended sediment: tonnes/s

The number of new columns is the product of the number of bubble plume structures specified and the number of sediment fractions simulated. Column headers are an underscore separated concatenation of each structure number, _BUBBLER_ENTRAINED_, constituent name and _FLUX_ (e.g. STRUCTURE_1_BUBBLER_ENTRAINED_SED_1_FLUX) followed by the units of the reported numbers in square brackets (e.g. [tonnes/s]). The structure number is determined by the order that each bubble plume structure block appears in the .fvc file. For example, if a bubble plume structure is declared after a weir structure, it will be designated as structure two.

8.10.8 Mass Balance

Mass balance output was described in Section 7.13.8. Additional output files are generated for sediment mass which track sediment mass fluxes into and out of the model domain, including inflows and boundary exchanges, for all fractions. FC boundaries are not included in mass balance calculations. For each simulated quantity, a dedicated CSV file is written containing time series of accumulated fluxes, mass flux estimates for each relevant process, percentage error diagnostics and turnover times. The headers of these files are presented in Appendix B.11.1.3.

There is no need to specify map output parameters for mass balance output. All relevant outputs are automatically generated.

8.10.9 Mass

Mass output tracks the mass of all sediment fractions in the model with the following units.

Suspended sediment: tonnes

This output is a subset of the mass balance output and may be used if only total mass diagnostic output is required. There is no need to specify output parameters for mass output.

Outputs are additional columns to the output csv file. Column headers are an underscore separated concatenation of ‘SED_N’ and ‘_MASS’, followed by the units of the reported numbers in square brackets.

8.10.10 Restart File

Restart files were described in Sections 5.18.10 and 7.13.10. When sediment simulation is activated, these files also store fields for each sediment fraction.