read_restart_file

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

Reads data from a TUFLOW FV restart file.

Parameters:

• restart_file (str or Path) – Path of the restart file to read.

• precision ({'single', 'double'}, optional) – Floating-point precision used when reading fv_data. Defaults to ‘single’.

Returns:

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

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

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

• cell_Zb (ndarray) – Cell bed elevation as a (nc2,) array.

• fv_data (ndarray) – Conserved 3D variables as a (nc3, nv) array where columns are (depth, V_x, V_y, SAL, TEMP, SED_1, …, SED_N).