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
| Flag | Description |
|---|---|
| Activates rainfall forcing over the domain | |
| Uses spatially distributed rainfall instead of uniform rainfall | |
| Activates evapotranspiration computation via meteorological forcing | |
| Uses raster-based rainfall input (e.g., satellite or gridded products) | |
| Under Development | |
| Under Development | |
| Activates inflow hydrograph boundary conditions | |
| Uses satellite-derived rainfall products | |
| Activates Alternating Block design storm method | |
| Activates Huff storm distribution method | |
| Applies stage (water level) boundary condition | |
| Uses raster-based evapotranspiration inputs |
Hydrologic–Hydrodynamic–Water Quality Flags
| Flag | Description |
|---|---|
| Activates infiltration into the soil | |
| Limits flow velocity to the critical flow (Froude = 1) | |
| Activates D8 flow routing scheme | |
| Activates Cellular Automata routing | |
| Activates Local Inertial shallow water equations (recommended default) | |
| Distributed mass balance errors in inflow cells (default 0) | |
| Activates water quality transport module | |
| Activates reservoir internal boundary conditions | |
| Defines which wash-off model to use | |
| Activates groundwater recharge computation | |
| Enables real-time satellite rainfall ingestion with Persiann | |
| (Under Development) | |
| Activates human stability hazard modeling | |
| Enforce all boundary cells as outlet cells | |
| 1: local inertial model, 2: upwind scheme, 3: central scheme | |
| 1: normal flow, 2: critical flow | |
| Celerity-based, 2: Celerity + Advection-based stability criteria (1 as default) | |
| Disables infiltration in river cells | |
| Activates subgrid hydraulic representation | |
| Uses spatially distributed albedo instead of uniform values | |
| Uses raster-based river geometry inputs | |
| Solves 2D Boussinesq Equation for Aquifers | |
| Activates kinematic wave approximation | |
| Activates diffusive wave routing | |
| Uses digital terrain model corrections or processing | |
| Activates water abstraction or withdrawal processes | |
| Activates floodplain overflow dynamics with a subgrid model | |
| Activates snow accumulation and melt processes | |
| Uses raster-based pollutant inputs |
Performance Flags
| Flag | Description |
|---|---|
| Enables GPU acceleration | |
| Uses single precision arithmetic for performance optimization |
Initial Condition Flags
| Flag | Description |
|---|---|
| Activates model warm-up period to stabilize initial conditions | |
| Initializes pollutant buildup conditions |
DEM Treatment Tools
| Flag | Description |
|---|---|
| Activates raster resampling to target resolution | |
| Applies DEM smoothing filter | |
| Smooth only the main river trunk from DEM | |
| Fills sinks in DEM for hydrological consistency | |
| Applies cell-level smoothing to terrain | |
| Reduces DEM resolution at river cells |
Extra Flags
| Flag | Description |
|---|---|
| Enables export of raster outputs | |
| Activates dashboard-style outputs or visualization | |
| Tracks simulation runtime | |
| 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.