Skip to main content

Model Flags

HydroPol2D is controlled through a set of binary and categorical flags defined in General_Data.xlsx.

These flags determine:

  • which physical processes are active
  • how forcing is applied
  • which numerical schemes are used
  • how outputs are generated

Each flag must be set consistently with the selected modeling approach.


Boundary Condition Flags

FlagDescription
flag_rainfall\mathrm{flag\_rainfall}Activates rainfall forcing over the domain
flag_spatial_rainfall\mathrm{flag\_spatial\_rainfall}Uses spatially distributed rainfall instead of uniform rainfall
flag_ETP\mathrm{flag\_ETP}Activates evapotranspiration computation via meteorological forcing
flag_input_rainfall_map\mathrm{flag\_input\_rainfall\_map}Uses raster-based rainfall input (e.g., satellite or gridded products)
flag_rainfall_multiple_runs\mathrm{flag\_rainfall\_multiple\_runs}Under Development
flag_data_source\mathrm{flag\_data\_source}Under Development
flag_inflow\mathrm{flag\_inflow}Activates inflow hydrograph boundary conditions
flag_satellite_rainfall\mathrm{flag\_satellite\_rainfall}Uses satellite-derived rainfall products
flag_alternated_blocks\mathrm{flag\_alternated\_blocks}Activates Alternating Block design storm method
flag_huff\mathrm{flag\_huff}Activates Huff storm distribution method
flag_stage_hydrograph\mathrm{flag\_stage\_hydrograph}Applies stage (water level) boundary condition
flag_input_ETP_map\mathrm{flag\_input\_ETP\_map}Uses raster-based evapotranspiration inputs

Hydrologic–Hydrodynamic–Water Quality Flags

FlagDescription
flag_infiltration\mathrm{flag\_infiltration}Activates infiltration into the soil
flag_critical\mathrm{flag\_critical}Limits flow velocity to the critical flow (Froude = 1)
flag_D8\mathrm{flag\_D8}Activates D8 flow routing scheme
flag_CA\mathrm{flag\_CA}Activates Cellular Automata routing
flag_inertial\mathrm{flag\_inertial}Activates Local Inertial shallow water equations (recommended default)
flag_waterbalance\mathrm{flag\_waterbalance}Distributed mass balance errors in inflow cells (default 0)
flag_waterquality\mathrm{flag\_waterquality}Activates water quality transport module
flag_reservoir\mathrm{flag\_reservoir}Activates reservoir internal boundary conditions
flag_wq_model\mathrm{flag\_wq\_model}Defines which wash-off model to use
flag_groundwater_modeling\mathrm{flag\_groundwater\_modeling}Activates groundwater recharge computation
flag_real_time_satellite_rainfall\mathrm{flag\_real\_time\_satellite\_rainfall}Enables real-time satellite rainfall ingestion with Persiann
flag_dam_break\mathrm{flag\_dam\_break}(Under Development)
flag_human_instability\mathrm{flag\_human\_instability}Activates human stability hazard modeling
flag_boundary\mathrm{flag\_boundary}Enforce all boundary cells as outlet cells
flag_numerical_scheme\mathrm{flag\_numerical\_scheme}1: local inertial model, 2: upwind scheme, 3: central scheme
flag_outlet_type\mathrm{flag\_outlet\_type}1: normal flow, 2: critical flow
flag_adaptive_timestepping\mathrm{flag\_adaptive\_timestepping}Celerity-based, 2: Celerity + Advection-based stability criteria (1 as default)
flag_neglect_infiltration_river\mathrm{flag\_neglect\_infiltration\_river}Disables infiltration in river cells
flag_subgrid\mathrm{flag\_subgrid}Activates subgrid hydraulic representation
flag_spatial_albedo\mathrm{flag\_spatial\_albedo}Uses spatially distributed albedo instead of uniform values
flag_river_rasters\mathrm{flag\_river\_rasters}Uses raster-based river geometry inputs
flag_baseflow\mathrm{flag\_baseflow}Solves 2D Boussinesq Equation for Aquifers
flag_kinematic\mathrm{flag\_kinematic}Activates kinematic wave approximation
flag_diffusive\mathrm{flag\_diffusive}Activates diffusive wave routing
flag_DTM\mathrm{flag\_DTM}Uses digital terrain model corrections or processing
flag_abstraction\mathrm{flag\_abstraction}Activates water abstraction or withdrawal processes
flag_overbanks\mathrm{flag\_overbanks}Activates floodplain overflow dynamics with a subgrid model
flag_snow_modeling\mathrm{flag\_snow\_modeling}Activates snow accumulation and melt processes
flag_WQ_Rasters\mathrm{flag\_WQ\_Rasters}Uses raster-based pollutant inputs

Performance Flags

FlagDescription
flag_GPU\mathrm{flag\_GPU}Enables GPU acceleration
flag_single\mathrm{flag\_single}Uses single precision arithmetic for performance optimization

Initial Condition Flags

FlagDescription
flag_warmup\mathrm{flag\_warmup}Activates model warm-up period to stabilize initial conditions
flag_initial_buildup\mathrm{flag\_initial\_buildup}Initializes pollutant buildup conditions

DEM Treatment Tools

FlagDescription
flag_resample\mathrm{flag\_resample}Activates raster resampling to target resolution
flag_smoothening\mathrm{flag\_smoothening}Applies DEM smoothing filter
flag_trunk\mathrm{flag\_trunk}Smooth only the main river trunk from DEM
flag_fill_DEM\mathrm{flag\_fill\_DEM}Fills sinks in DEM for hydrological consistency
flag_smooth_cells\mathrm{flag\_smooth\_cells}Applies cell-level smoothing to terrain
flag_reduce_DEM\mathrm{flag\_reduce\_DEM}Reduces DEM resolution at river cells

Extra Flags

FlagDescription
flag_export_maps\mathrm{flag\_export\_maps}Enables export of raster outputs
flag_dashboard\mathrm{flag\_dashboard}Activates dashboard-style outputs or visualization
flag_elapsed_time\mathrm{flag\_elapsed\_time}Tracks simulation runtime
flag_obs_gauges\mathrm{flag\_obs\_gauges}Activates output extraction at observation gauge locations

Notes

  • Flags must be used consistently to avoid conflicting configurations
  • Only one routing scheme should be active at a time (e.g., inertial vs diffusive vs kinematic)
  • Subgrid and raster-based river options should not be combined unless explicitly supported
  • Adaptive time stepping is strongly recommended for numerical stability
  • GPU execution requires compatible data structures and hardware

Summary

Flags define the structure of a HydroPol2D simulation.

They control:

  • physics
  • numerics
  • forcing
  • outputs

Correct configuration of these flags is essential for stable and physically meaningful simulations.