Input and output data

This article gives the lists of input and output data of SynxFlow model.

Date: 31/03/2025

User-Provided Input Files & Data

This table lists inputs typically provided by the user either as files or defined directly in their Python setup script, noting solver specificity.

User Input Type	Example Data/Format	Purpose	Notes
Files Provided by User:
DEM File	Raster file (.gz, .asc, .tif)	Defines the topography/elevation	Required for all simulation types.
Rain Mask File (Flood and Debris only)	Raster file (.gz, .asc, .tif)	Assigns rainfall source indices to grid cells	Primarily for flood and debris models via set_rainfall.
Rain Source File (Flood and Debris only)	CSV file (.csv) with columns: time(s), rate_src0(m/s), …	Provides time series of rainfall rates for each source	Primarily for flood and debris models via set_rainfall.
Land Cover File	Raster file (.gz, .asc, .tif)	Assigns land cover type indices for parameter variation	Used by set_landcover / set_grid_parameter. Applicable if parameters vary spatially.
Data Defined in Script:
Initial Conditions	Scalar or NumPy array (e.g., for h0, hU0x, hU0y)	Sets initial material depth/mass (h0), momentum(velocity times depth) (hU0x, hU0y)	Passed to set_initial_condition(). Needed for all types. Default values are 0.
Boundary Conditions	Python List of Dictionaries (defining location, type, time series h/hU / C )	Defines where/how water enters/leaves the domain	Set via set_boundary_condition().
Grid Parameters:	Set via set_grid_parameter(). Can be Scalar, NumPy array, or Dict (if using Landcover)	Defines physical properties across the grid
Manning’s n (Flood/Debris)	Scalar/Array/Dict	Surface roughness / flow resistance	Flood and debris models only.
Infiltration Params (Flood)	Scalar/Array/Dict (e.g., hydraulic_conductivity, capillary_head, water_content_diff, sewer_sink)	Parameters for Green-Ampt infiltration and drainage loss	Flood model only.
Debris Flow Params (Debris)	Scalar/Array/Dict (e.g., erodible depth, Concentration, dynamic friction, static friction)	Defines debris flow parametres	Specific to Debris Flow solver. Set via add_user_defined_parameter().
Gauge Positions	NumPy array (Nx2) of X, Y coordinates	Specifies locations for time series output	Passed to set_gauges_position().
Runtime Settings	Python List/NumPy array [start, end, output_interval, backup_interval] (s)	Controls simulation duration and output timing	Passed to set_runtime().
Landslide Config (Landslide)	Python variables passed to write_landslide_config: rheology_type, rheology_params, gravity_correction_type, curvature_on, …	Defines physics and numerical options specific to the landslide solver	Specific to Landslide solver. Written to setup.conf.

Output Files

This table lists output files generated by the simulation engine, usually found in the output/ directory.

File Name/Type	Data Type/Content	Format	Notes
h_gauges.dat	Time series output for water depth (h) at specified gauge locations. Columns: Time(s), Gauge1_h, Gauge2_h, …	Text (.dat), space-separated columns	Read by OutputModel.read_gauges_file(file_tag='h').
eta_gauges.dat	Time series output for water surface elevation (eta) at gauges. Columns: Time(s), Gauge1_eta, Gauge2_eta, …	Text (.dat), space-separated columns	Read by OutputModel.read_gauges_file(file_tag='eta').
hU_gauges.dat	Time series output for momentum (hU) components at gauges. Columns: Time(s), G1_hUx, G1_hUy, G2_hUx, G2_hUy, …	Text (.dat), space-separated columns	Read by OutputModel.read_gauges_file(file_tag='hU').
C_gauges.dat (Debris)	Time series output for concentration (C). Columns: Time(s), G1_C, G2_C, …	Text (.dat), space-separated columns	Read by OutputModel.read_gauges_file(file_tag='C'). Debris model only.
[variable]_[time].asc	Grid (snapshot) of an output variable’s values at a specific simulation time ([time] in seconds). Examples: h_900.asc, hU_1800.asc	Esri ASCII (.asc)	Read by OutputModel.read_grid_file(). [variable] depends on simulation output. Flood and landslide models have h and hU, debris model has also z (surface elevation) and C.
h_max_[time].asc	Grid showing the maximum value of depth reached at each cell up to a specific time ([time] in seconds). Example: h_max_7200.asc	Esri ASCII (.asc)	Read by OutputModel.read_grid_file().