read_bed_restart_file

tfv.restart.read_bed_restart_file(restart_file, precision='single')

Read TUFLOW FV Bed Restart File.

Function to read a bed restart binary file.

Parameters:

• restart_file (str or Path) – Full path to the sediment restart file.

• precision ({'single', 'double'}, optional) – Floating-point precision of the restart file. Defaults to ‘single’.

Returns:

• nc2 (int) – Number of 2D cells in the model.

• nc3 (int) – Number of 3D cells in the model.

• time_stamp (float) – Simulation time in hours since 1990-01-01.

• ng (int) – Number of sediment grain-size fractions.

• maxnl (int) – Maximum number of bed layers across all cells.

• bed_mass (np.ndarray) – Bed mass array with shape (nc2, maxnl, ng). Cells with fewer than maxnl layers are padded with zeros.