Skip to main content

Configuration Parameters

This page documents all variables defined in General_Data.xlsx.

Each parameter controls a specific aspect of HydroPol2D, including:

  • simulation timing
  • numerical stability
  • hydrological processes
  • hydraulic routing
  • input datasets
  • output control

Running Control

VariableUnitsDescription
time_step_model\mathrm{time\_step\_model}s\mathrm{s}Initial model time step used in the simulation
min_time_step\mathrm{min\_time\_step}s\mathrm{s}Minimum allowable adaptive time step for numerical stability
max_time_step\mathrm{max\_time\_step}s\mathrm{s}Maximum allowable adaptive time step
time_step_change\mathrm{time\_step\_change}s\mathrm{s}Increment used to adjust the adaptive time step
αmin\alpha_{\min}Minimum Courant-like stability coefficient
αmax\alpha_{\max}Maximum Courant-like stability coefficient
date_begin\mathrm{date\_begin}Simulation start date and time
date_end\mathrm{date\_end}Simulation end date and time

Normal Flow Boundary Condition

VariableUnitsDescription
slope_outlet\mathrm{slope\_outlet}mm1\mathrm{m\,m^{-1}}Prescribed slope used to estimate normal flow conditions at the outlet boundary

Maps and Plots Control

VariableUnitsDescription
record_time_maps\mathrm{record\_time\_maps}min\mathrm{min}Time interval for saving raster outputs
record_time_hydrographs\mathrm{record\_time\_hydrographs}min\mathrm{min}Time interval for saving hydrograph outputs
Pol_min\mathrm{Pol\_min}mgL1\mathrm{mg\,L^{-1}}Minimum pollutant concentration threshold for visualization
depth_wse\mathrm{depth\_wse}m\mathrm{m}Threshold depth used to define water surface elevation outputs
flag_wse\mathrm{flag\_wse}Flag to activate water surface elevation outputs instead of depth
record_time_spatial_rainfall\mathrm{record\_time\_spatial\_rainfall}min\mathrm{min}Time interval for exporting spatial rainfall maps
time_save_ETP\mathrm{time\_save\_ETP}min\mathrm{min}Time interval for saving evapotranspiration outputs
record_time_spatial_ETP\mathrm{record\_time\_spatial\_ETP}min\mathrm{min}Time interval for exporting spatial ETP fields

River Geometry Parameters

If flag_reduce_dem is activated, river cells elevation are reduced to account for river bathymetry. A set of 4 parameters are then required to describe the flow width and depth. These parameters are valid to convert flow accumulation area [km2\mathrm{km^2}] into flow depth [m\mathrm{m}] and width [m\mathrm{m}].

VariableUnitsDescription
α1\alpha_1Empirical coefficient controlling channel geometry scaling
α2\alpha_2Secondary coefficient for hydraulic geometry relationships
β1\beta_1Exponent controlling width or hydraulic scaling behavior
β2\beta_2Secondary exponent for hydraulic scaling relationships
nnsm1/3\mathrm{s\,m^{-1/3}}Manning’s roughness coefficient for channel and surface flow

Water Quality Inputs

VariableUnitsDescription
ADD\mathrm{ADD}days\mathrm{days}Antecedent dry days used in pollutant buildup modeling
min_Bt\mathrm{min\_Bt}gm2\mathrm{g\,m^{-2}}Minimum pollutant buildup threshold
Bmin\mathrm{Bmin}gm2\mathrm{g\,m^{-2}}Minimum allowable pollutant mass
Bmax\mathrm{Bmax}gm2\mathrm{g\,m^{-2}}Maximum pollutant buildup capacity

DEM Processing and Terrain Controls

VariableUnitsDescription
min_area\mathrm{min\_area}km2\mathrm{km^2}Minimum drainage area threshold for channel initiation
τ\tauSmoothing parameter controlling DEM filtering intensity
K_value\mathrm{K\_value}Parameter controlling terrain processing or hydraulic scaling
sl\mathrm{sl}mm1\mathrm{m\,m^{-1}}Minimum slope threshold used in DEM conditioning
resolution_resample\mathrm{resolution\_resample}m\mathrm{m}Target resolution for DEM resampling
slope_DTM\mathrm{slope\_DTM}%\%Slope threshold used for terrain correction or filtering

File Paths and Input Data

VariableUnitsDescription
topo_path\mathrm{topo\_path}Path to TopoToolbox directory
DEM_path\mathrm{DEM\_path}Path to Digital Elevation Model
LULC_path\mathrm{LULC\_path}Path to Land Use / Land Cover raster
SOIL_path\mathrm{SOIL\_path}Path to soil classification raster
Warmup_Depth_path\mathrm{Warmup\_Depth\_path}Path to initial warm-up water depth condition
Initial_Buildup_path\mathrm{Initial\_Buildup\_path}Path to initial pollutant buildup map
Initial_Soil_Moisture_path\mathrm{Initial\_Soil\_Moisture\_path}Path to initial soil moisture condition
Albedo_path\mathrm{Albedo\_path}Path to albedo raster
LAI_path\mathrm{LAI\_path}Path to leaf area index raster
RiverWidths_path\mathrm{RiverWidths\_path}Path to river width raster
RiverDepths_path\mathrm{RiverDepths\_path}Path to river depth raster
DTB_path\mathrm{DTB\_path}Path to depth-to-bedrock raster
B1_path\mathrm{B1\_path}Path to pollutant-related parameter raster
B2_path\mathrm{B2\_path}Path to pollutant-related parameter raster
W1_path\mathrm{W1\_path}Path to pollutant wash-off parameter raster
W2_path\mathrm{W2\_path}Path to pollutant wash-off parameter raster
Subgrid_DEM_path\mathrm{Subgrid\_DEM\_path}Path to high-resolution DEM for subgrid computations
hydropol2d_tools\mathrm{hydropol2d\_tools}Path to HydroPol2D function library

Human Instability Parameters

VariableUnitsDescription
μ\muFriction coefficient between human body and ground
CdC_dDrag coefficient for human body in flow
ρperson\rho_{\mathrm{person}}kgm3\mathrm{kg\,m^{-3}}Density of human body
weight_person\mathrm{weight\_person}kg\mathrm{kg}Average human weight
height_person\mathrm{height\_person}m\mathrm{m}Average human height
width1_person\mathrm{width1\_person}m\mathrm{m}Characteristic frontal width
width2_person\mathrm{width2\_person}m\mathrm{m}Secondary width parameter
ρwater\rho_{\mathrm{water}}kgm3\mathrm{kg\,m^{-3}}Density of water
ggms2\mathrm{m\,s^{-2}}Gravitational acceleration

Observation Points

VariableUnitsDescription
Gauge\mathrm{Gauge}Gauge identifier
Easting\mathrm{Easting}m\mathrm{m}Easting coordinate
Northing\mathrm{Northing}m\mathrm{m}Northing coordinate
Label Name\mathrm{Label\ Name}Output label for time series

Design Storm Parameters

VariableUnitsDescription
RP\mathrm{RP}years\mathrm{years}Return period of design storm
Rainfall Duration\mathrm{Rainfall\ Duration}min\mathrm{min}Total storm duration
KKIntensity–duration–frequency coefficient
aaIDF curve parameter
bbIDF curve parameter
ccIDF curve parameter
dt_design\mathrm{dt\_design}min\mathrm{min}Time resolution of synthetic storm

Satellite or Radar Rainfall

VariableUnitsDescription
Time\mathrm{Time}min\mathrm{min}Time step of rainfall raster
Raster Directory\mathrm{Raster\ Directory}Path to rainfall raster files

Satellite Transpiration

VariableUnitsDescription
Time\mathrm{Time}day\mathrm{day}Time index for transpiration data
Raster Directory\mathrm{Raster\ Directory}Path to transpiration rasters

Satellite Evaporation

VariableUnitsDescription
Time\mathrm{Time}day\mathrm{day}Time index for evaporation data
Raster Directory\mathrm{Raster\ Directory}Path to evaporation rasters

Notes

The descriptions provided here represent the functional role of each parameter within HydroPol2D.

Final definitions should be refined based on:

  • spreadsheet comments
  • calibration strategy
  • application context

This table serves as the central reference for model configuration.