hydromt_sfincs.components.config.SfincsConfigVariables#
- pydantic settings hydromt_sfincs.components.config.SfincsConfigVariables[source]#
SFINCS configuration variables with defaults matching sfincs_input.f90.
Create a new model by parsing and validating input data from keyword arguments.
Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.
self is explicitly positional-only to allow self as a field name.
Show JSON schema
{ "title": "SfincsConfigVariables", "description": "SFINCS configuration variables with defaults matching sfincs_input.f90.", "type": "object", "properties": { "mmax": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Number of grid cells in x-direction", "title": "Mmax" }, "nmax": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Number of grid cells in y-direction", "title": "Nmax" }, "dx": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Grid size in x-direction", "title": "Dx" }, "dy": { "anyOf": [ { "exclusiveMinimum": 0, "type": "number" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Grid size in y-direction", "title": "Dy" }, "x0": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Origin of the grid in the x-direction", "title": "X0" }, "y0": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "condition": "qtrfile is None", "default": null, "description": "Origin of the grid in the y-direction", "title": "Y0" }, "rotation": { "condition": "qtrfile is None", "default": 0.0, "description": "Rotation of the grid in degrees from the x-axis (east) in anti-clockwise direction", "exclusiveMaximum": 360, "exclusiveMinimum": -360, "title": "Rotation", "type": "number" }, "tref": { "always": true, "default": "2026-10-28T00:00:00", "description": "Reference time for simulation", "format": "date-time", "title": "Tref", "type": "string" }, "tstart": { "always": true, "default": "2026-10-28T00:00:00", "description": "Start time for the simulation", "format": "date-time", "title": "Tstart", "type": "string" }, "tstop": { "always": true, "default": "2026-10-29T00:00:00", "description": "Stop time for the simulation", "format": "date-time", "title": "Tstop", "type": "string" }, "tspinup": { "always": true, "default": 0.0, "description": "Duration of spinup period (seconds)", "minimum": 0.0, "title": "Tspinup", "type": "number" }, "t0out": { "default": -999.0, "description": "Output start time (seconds)", "title": "T0Out", "type": "number" }, "t1out": { "default": -999.0, "description": "Output stop time (seconds)", "title": "T1Out", "type": "number" }, "dthisout": { "always": true, "default": 600.0, "description": "Timeseries output interval (seconds)", "title": "Dthisout", "type": "number" }, "dtmapout": { "always": true, "default": 3600.0, "description": "Spatial map output interval (seconds)", "legacy_alias": [ [ "dtout", "2.4.1" ] ], "minimum": 0.0, "title": "Dtmapout", "type": "number" }, "dtmaxout": { "always": true, "default": 86400.0, "description": "Maximum map output interval (seconds)", "minimum": 0.0, "title": "Dtmaxout", "type": "number" }, "dtrstout": { "default": 0.0, "description": "Restart file output interval (seconds)", "minimum": 0.0, "title": "Dtrstout", "type": "number" }, "trstout": { "always": true, "default": -999.0, "description": "Restart file output after specific time (seconds)", "title": "Trstout", "type": "number" }, "dtwave": { "condition": "snapwave == 1", "default": 3600.0, "description": "Interval of running SnapWave (seconds)", "title": "Dtwave", "type": "number" }, "dtwnd": { "always": false, "default": 1800.0, "description": "Interval of updating wind forcing (seconds)", "title": "Dtwnd", "type": "number" }, "alpha": { "always": true, "default": 0.5, "description": "Numerical time step reduction for CFL-condition (-)", "maximum": 1.0, "minimum": 0.001, "title": "Alpha", "type": "number" }, "theta": { "default": 1.0, "description": "Numerical smoothing factor in momentum equation (-)", "maximum": 1.0, "minimum": 0.8, "title": "Theta", "type": "number" }, "hmin_cfl": { "default": 0.1, "description": "Minimum water depth for CFL condition (meters)", "exclusiveMinimum": 0.0, "title": "Hmin Cfl", "type": "number" }, "dtmax": { "default": 60.0, "description": "Maximum allowed internal timestep (seconds)", "exclusiveMinimum": 0.0, "title": "Dtmax", "type": "number" }, "huthresh": { "always": true, "default": 0.01, "description": "Threshold water depth (meters)", "exclusiveMaximum": 1.0, "exclusiveMinimum": 0.0, "title": "Huthresh", "type": "number" }, "huvmin": { "default": 0.0, "description": "Minimum water depth for velocity computation (meters)", "min_version": "2.3.2", "title": "Huvmin", "type": "number" }, "advection": { "always": true, "default": 1, "description": "Enable advection (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Advection", "type": "integer" }, "advlim": { "default": 1.0, "description": "Maximum value of the advection term in the momentum equation (-)", "minimum": 0.0, "title": "Advlim", "type": "number" }, "advection_scheme": { "default": "upw1", "description": "Advection scheme ('upw1' or 'original')", "title": "Advection Scheme", "type": "string" }, "advection_mask": { "default": 1, "description": "Option to turn on the advection mask (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Advection Mask", "type": "integer" }, "coriolis": { "always": true, "default": 1, "description": "Enable Coriolis term (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Coriolis", "type": "integer" }, "viscosity": { "always": true, "default": 1, "description": "Enable viscosity term (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Viscosity", "type": "integer" }, "nuvisc": { "always": false, "default": 0.01, "description": "Viscosity coefficient per metre of grid cell length (-)", "minimum": 0.0, "title": "Nuvisc", "type": "number" }, "nuviscfac": { "default": 100.0, "description": "Viscosity factor (-)", "min_version": "2.1.3", "minimum": 0.0, "title": "Nuviscfac", "type": "number" }, "friction2d": { "default": 1, "description": "2D friction component in the momentum equation (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Friction2D", "type": "integer" }, "uvlim": { "default": 10.0, "description": "Velocity limiter (m/s)", "min_version": "2.1.3", "title": "Uvlim", "type": "number" }, "uvmax": { "default": 1000.0, "description": "Maximum velocity (m/s)", "min_version": "2.1.3", "title": "Uvmax", "type": "number" }, "wiggle_suppression": { "default": 1, "description": "Wiggle suppression (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Wiggle Suppression", "type": "integer" }, "wiggle_factor": { "default": 0.1, "description": "Wiggle suppression factor (-)", "minimum": 0.0, "title": "Wiggle Factor", "type": "number" }, "wiggle_threshold": { "default": 0.1, "description": "Wiggle suppression minimum depth threshold (m)", "minimum": 0.0, "title": "Wiggle Threshold", "type": "number" }, "slopelim": { "default": 9999.9, "description": "Slope limiter (-)", "minimum": 0.0, "title": "Slopelim", "type": "number" }, "btrelax": { "default": 3600.0, "description": "Relaxation in uvmean (seconds)", "minimum": 0.0, "title": "Btrelax", "type": "number" }, "stopdepth": { "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "description": "[DEPRECATED] Minimum water depth for stopping the simulation (m)", "max_version": "2.1.2", "title": "Stopdepth" }, "manning": { "default": 0.04, "description": "Manning's n coefficient for spatially uniform roughness (s/m^(1/3))", "exclusiveMaximum": 0.5, "exclusiveMinimum": 0.0, "title": "Manning", "type": "number" }, "manning_land": { "anyOf": [ { "exclusiveMaximum": 0.5, "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Manning's n for land areas; 0.04 recommended, -999 = not set (s/m^(1/3))", "title": "Manning Land" }, "manning_sea": { "anyOf": [ { "exclusiveMaximum": 0.5, "exclusiveMinimum": 0.0, "type": "number" }, { "type": "null" } ], "default": null, "description": "Manning's n for sea areas; 0.02 recommended, -999 = not set (s/m^(1/3))", "title": "Manning Sea" }, "rgh_lev_land": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": null, "description": "Elevation level to distinguish land and sea roughness (m)", "title": "Rgh Lev Land" }, "rhoa": { "always": false, "default": 1.25, "description": "Air density (kg/m^3)", "exclusiveMinimum": 0.0, "title": "Rhoa", "type": "number" }, "rhow": { "always": false, "default": 1024.0, "description": "Water density (kg/m^3)", "exclusiveMinimum": 0.0, "title": "Rhow", "type": "number" }, "latitude": { "default": 0.0, "description": "Latitude of the grid center (degrees)", "title": "Latitude", "type": "number" }, "baro": { "always": false, "default": 1, "description": "Enable atmospheric pressure term (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Baro", "type": "integer" }, "pavbnd": { "always": false, "default": 0.0, "description": "Atmospheric pressure at boundary (Pa)", "title": "Pavbnd", "type": "number" }, "gapres": { "default": 101200.0, "description": "Background atmospheric pressure for spiderweb (Pa)", "title": "Gapres", "type": "number" }, "zsini": { "always": true, "anyOf": [ { "type": "number" }, { "type": "null" } ], "default": 0.0, "description": "Initial water level in entire domain (meters)", "title": "Zsini" }, "bndtype": { "default": 1, "description": "Boundary type (-)", "minimum": 1, "title": "Bndtype", "type": "integer" }, "btfilter": { "always": false, "default": 60.0, "description": "Water level boundary timeseries filtering period (seconds)", "minimum": 0.0, "title": "Btfilter", "type": "number" }, "use_bcafile": { "default": 1, "description": "Use tidal boundary condition file (1: on, 0: off)", "maximum": 1, "min_version": "2.3.0", "minimum": 0, "title": "Use Bcafile", "type": "integer" }, "qinf": { "always": true, "anyOf": [ { "minimum": 0.0, "type": "number" }, { "type": "null" } ], "default": 0.0, "description": "Infiltration rate, spatially uniform (mm/hr)", "title": "Qinf" }, "qinf_zmin": { "default": 0.0, "description": "Minimum elevation for spatially uniform infiltration (m)", "title": "Qinf Zmin", "type": "number" }, "sfacinf": { "default": 0.2, "description": "Curve Number initial abstraction factor (-)", "maximum": 1.0, "minimum": 0.0, "title": "Sfacinf", "type": "number" }, "horton_kr_kd": { "default": 10.0, "description": "Horton infiltration recovery vs decay ratio (-)", "title": "Horton Kr Kd", "type": "number" }, "wavemaker_nfreqs_ig": { "default": 100, "description": "Wave maker number of frequency bins IG spectrum (-)", "legacy_alias": [ [ "nfreqsig", "2.4.1" ] ], "maximum": 500, "min_version": "2.3.3", "minimum": 1, "title": "Wavemaker Nfreqs Ig", "type": "integer" }, "wavemaker_freqmin_ig": { "default": 0.0, "description": "Minimum frequency wave maker IG spectrum (Hz)", "legacy_alias": [ [ "freqminig", "2.4.1" ] ], "min_version": "2.3.3", "minimum": 0.0, "title": "Wavemaker Freqmin Ig", "type": "number" }, "wavemaker_freqmax_ig": { "default": 0.1, "description": "Maximum frequency wave maker IG spectrum (Hz)", "legacy_alias": [ [ "freqmaxig", "2.4.1" ] ], "min_version": "2.3.3", "minimum": 0.0, "title": "Wavemaker Freqmax Ig", "type": "number" }, "wavemaker_filter_time": { "default": 600.0, "description": "Filtering duration for wave maker mean water level (s)", "legacy_alias": [ [ "wmtfilter", "2.4.1" ] ], "min_version": "2.3.3", "minimum": 0.0, "title": "Wavemaker Filter Time", "type": "number" }, "wavemaker_filter_fred": { "default": 0.99, "description": "Filtering variable in wave maker (-)", "legacy_alias": [ [ "wmfred", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Filter Fred", "type": "number" }, "wavemaker_signal": { "default": "spectrum", "description": "Wavemaker signal type ('spectrum' or 'mon')", "legacy_alias": [ [ "wmsignal", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Signal", "type": "string" }, "wavemaker_hmin": { "default": 0.1, "description": "Wavemaker minimum water depth (m)", "legacy_alias": [ [ "wmhmin", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Hmin", "type": "number" }, "wavemaker_nfreqs_inc": { "default": 100, "description": "Wave maker number of frequency bins incident wave spectrum (-)", "legacy_alias": [ [ "nfreqsinc", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Nfreqs Inc", "type": "integer" }, "wavemaker_freqmin_inc": { "default": 0.04, "description": "Minimum frequency wave maker incident wave spectrum (Hz)", "legacy_alias": [ [ "freqmininc", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Freqmin Inc", "type": "number" }, "wavemaker_freqmax_inc": { "default": 1.0, "description": "Maximum frequency wave maker incident wave spectrum (Hz)", "legacy_alias": [ [ "freqmaxinc", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Freqmax Inc", "type": "number" }, "wavemaker_tinc2ig": { "default": -1.0, "description": "Wave maker ratio of IG to incident wave period; <= 0 uses Herbers (-)", "min_version": "2.3.3", "title": "Wavemaker Tinc2Ig", "type": "number" }, "wavemaker_hm0_ig_factor": { "default": 1.0, "description": "Wave maker IG wave height scale factor (-)", "min_version": "2.3.3", "title": "Wavemaker Hm0 Ig Factor", "type": "number" }, "wavemaker_hm0_inc_factor": { "default": 1.0, "description": "Wave maker incident wave height scale factor (-)", "min_version": "2.3.3", "title": "Wavemaker Hm0 Inc Factor", "type": "number" }, "wavemaker_gammax": { "default": 1.0, "description": "Wave maker maximum ratio of wave height over water depth (-)", "min_version": "2.3.3", "title": "Wavemaker Gammax", "type": "number" }, "wavemaker_tpmin": { "default": 1.0, "description": "Wave maker minimum peak wave period (s)", "min_version": "2.3.3", "title": "Wavemaker Tpmin", "type": "number" }, "wavemaker_hig": { "default": 1, "description": "Wave maker include IG waves when forced by SnapWave (1: on, 0: off)", "maximum": 1, "min_version": "2.3.3", "minimum": 0, "title": "Wavemaker Hig", "type": "integer" }, "wavemaker_hinc": { "default": 0, "description": "Wave maker include incident waves when forced by SnapWave (1: on, 0: off)", "maximum": 1, "min_version": "2.3.3", "minimum": 0, "title": "Wavemaker Hinc", "type": "integer" }, "amprblock": { "default": 1, "description": "Use ampr data as block interpolation (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Amprblock", "type": "integer" }, "spwmergefrac": { "default": 0.5, "description": "Spiderweb merge factor with background wind and pressure (-)", "exclusiveMaximum": 1.0, "exclusiveMinimum": 0.0, "title": "Spwmergefrac", "type": "number" }, "usespwprecip": { "default": 1, "description": "Use rainfall from spiderweb (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Usespwprecip", "type": "integer" }, "spinup_meteo": { "default": 0, "description": "Apply spinup to meteo forcing (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Spinup Meteo", "type": "integer" }, "waveage": { "default": -999.0, "description": "Determine Cd with wave age (-)", "title": "Waveage", "type": "number" }, "factor_wind": { "default": 1.0, "description": "Wind forcing scale factor (-)", "min_version": "2.3.0", "title": "Factor Wind", "type": "number" }, "factor_pres": { "default": 1.0, "description": "Pressure forcing scale factor (-)", "min_version": "2.3.0", "title": "Factor Pres", "type": "number" }, "factor_prcp": { "default": 1.0, "description": "Precipitation forcing scale factor (-)", "min_version": "2.3.0", "title": "Factor Prcp", "type": "number" }, "factor_spw_size": { "default": 1.0, "description": "Spiderweb size scale factor (-)", "min_version": "2.3.0", "title": "Factor Spw Size", "type": "number" }, "snapwave": { "default": 0, "description": "Enable coupled SnapWave solver (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Snapwave", "type": "integer" }, "snapwave_wind": { "condition": "snapwave == 1", "default": 0, "description": "SnapWave wind growth process (1: on, 0: off)", "maximum": 1, "min_version": "2.1.2", "minimum": 0, "title": "Snapwave Wind", "type": "integer" }, "snapwave_use_nearest": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave use nearest interpolation (1: on, 0: off)", "maximum": 1, "min_version": "2.3.0", "minimum": 0, "title": "Snapwave Use Nearest", "type": "integer" }, "snapwave_igwaves": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave IG wave computation (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Snapwave Igwaves", "type": "integer" }, "snapwave_dtheta": { "condition": "snapwave == 1", "default": 10.0, "description": "SnapWave directional resolution (degrees)", "exclusiveMinimum": 0, "title": "Snapwave Dtheta", "type": "number" }, "snapwave_crit": { "condition": "snapwave == 1", "default": 0.001, "description": "SnapWave convergence criterion (-)", "exclusiveMinimum": 0, "title": "Snapwave Crit", "type": "number" }, "snapwave_hmin": { "condition": "snapwave == 1", "default": 0.1, "description": "SnapWave minimum water depth (m)", "exclusiveMinimum": 0, "title": "Snapwave Hmin", "type": "number" }, "snapwave_vegetation": { "condition": "snapwave == 1", "default": 0, "description": "SnapWave vegetation dissipation (1: on, 0: off)", "maximum": 1, "min_version": "2.4.0", "minimum": 0, "title": "Snapwave Vegetation", "type": "integer" }, "snapwave_waveforces_ratio": { "condition": "snapwave == 1", "default": 1.0, "description": "Multiplication factor on SnapWave wave forces (-)", "legacy_alias": [ [ "snapwave_waveforces_factor", "2.3.3" ], [ "waveforces_ratio", null ] ], "min_version": "2.4.0", "title": "Snapwave Waveforces Ratio", "type": "number" }, "radstr": { "default": 0, "description": "Radiation stress forcing from SnapWave (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Radstr", "type": "integer" }, "snapwave_gamma": { "condition": "snapwave == 1", "default": 0.7, "description": "SnapWave wave breaking parameter (-)", "title": "Snapwave Gamma", "type": "number" }, "snapwave_gammax": { "condition": "snapwave == 1", "default": 999.0, "description": "SnapWave maximum ratio of wave height over water depth (-)", "min_version": "2.2.0", "title": "Snapwave Gammax", "type": "number" }, "snapwave_alpha": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave wave dissipation coefficient (-)", "title": "Snapwave Alpha", "type": "number" }, "snapwave_fw": { "condition": "snapwave == 1", "default": 0.01, "description": "SnapWave bottom friction factor incident waves (-)", "title": "Snapwave Fw", "type": "number" }, "snapwave_fwig": { "condition": "snapwave == 1", "default": 0.015, "description": "SnapWave bottom friction factor IG waves (-)", "title": "Snapwave Fwig", "type": "number" }, "snapwave_fw_ratio": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave ratio of land to sea friction factor incident waves (-)", "title": "Snapwave Fw Ratio", "type": "number" }, "snapwave_fwig_ratio": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave ratio of land to sea friction factor IG waves (-)", "title": "Snapwave Fwig Ratio", "type": "number" }, "snapwave_dt": { "condition": "snapwave == 1", "default": 36000.0, "description": "SnapWave internal time step, large value means stationary (seconds)", "title": "Snapwave Dt", "type": "number" }, "snapwave_tol": { "condition": "snapwave == 1", "default": 1000.0, "description": "SnapWave tolerance (-)", "title": "Snapwave Tol", "type": "number" }, "snapwave_niter": { "condition": "snapwave == 1", "default": 10, "description": "SnapWave maximum number of iterations (-)", "min_version": "2.1.2", "title": "Snapwave Niter", "type": "integer" }, "snapwave_baldock_ratio": { "condition": "snapwave == 1", "default": 0.2, "description": "SnapWave Baldock ratio incident waves (-)", "title": "Snapwave Baldock Ratio", "type": "number" }, "snapwave_baldock_exponent": { "condition": "snapwave == 1", "default": 2, "description": "SnapWave exponent of Baldock dissipation enhancement factor; 0 is unused (-)", "min_version": "2.4.0", "title": "Snapwave Baldock Exponent", "type": "integer" }, "snapwave_Tpini": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave initial peak wave period (s)", "min_version": "2.1.2", "title": "Snapwave Tpini", "type": "number" }, "snapwave_mwind": { "condition": "snapwave == 1", "default": 2, "description": "SnapWave wind growth option (-)", "min_version": "2.1.2", "title": "Snapwave Mwind", "type": "integer" }, "snapwave_sigmin": { "condition": "snapwave == 1", "default": 0.25132741228718347, "description": "SnapWave minimum radial frequency (rad/s)", "min_version": "2.1.2", "title": "Snapwave Sigmin", "type": "number" }, "snapwave_sigmax": { "condition": "snapwave == 1", "default": 6.283185307179586, "description": "SnapWave maximum radial frequency (rad/s)", "min_version": "2.1.2", "title": "Snapwave Sigmax", "type": "number" }, "snapwave_jadcgdx": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave include dcg/dx term (1: on, 0: off)", "maximum": 1, "min_version": "2.1.2", "minimum": 0, "title": "Snapwave Jadcgdx", "type": "integer" }, "snapwave_c_dispT": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave wave period dispersion coefficient (-)", "min_version": "2.1.2", "title": "Snapwave C Dispt", "type": "number" }, "snapwave_sector": { "condition": "snapwave == 1", "default": 180.0, "description": "SnapWave directional sector (degrees)", "min_version": "2.1.2", "title": "Snapwave Sector", "type": "number" }, "snapwave_relax_factor_DoverA": { "condition": "snapwave == 1", "default": 0.25, "description": "SnapWave underrelaxation factor for DoverA; 1.0 disables (-)", "min_version": "2.4.0", "title": "Snapwave Relax Factor Dovera", "type": "number" }, "snapwave_relax_factor_DoverE": { "condition": "snapwave == 1", "default": 0.25, "description": "SnapWave underrelaxation factor for DoverE; 1.0 disables (-)", "min_version": "2.4.0", "title": "Snapwave Relax Factor Dovere", "type": "number" }, "snapwave_alpha_ig": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave wave dissipation coefficient IG waves (-)", "title": "Snapwave Alpha Ig", "type": "number" }, "snapwave_gammaig": { "condition": "snapwave == 1", "default": 0.7, "description": "SnapWave wave breaking parameter IG waves (-)", "title": "Snapwave Gammaig", "type": "number" }, "snapwave_gamma_fac_br": { "condition": "snapwave == 1", "default": 0.45, "description": "SnapWave factor on gamma to determine the incident wave breaking point (-)", "min_version": "2.4.0", "title": "Snapwave Gamma Fac Br", "type": "number" }, "snapwave_shinc2ig": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave ratio of IG source term subtracted from incident wave energy (-)", "title": "Snapwave Shinc2Ig", "type": "number" }, "snapwave_alphaigfac": { "condition": "snapwave == 1", "default": 1.0, "description": "SnapWave multiplication factor for IG shoaling source term (-)", "title": "Snapwave Alphaigfac", "type": "number" }, "snapwave_baldock_ratio_ig": { "condition": "snapwave == 1", "default": 0.2, "description": "SnapWave Baldock ratio IG waves (-)", "title": "Snapwave Baldock Ratio Ig", "type": "number" }, "snapwave_ig_opt": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave IG wave option (-)", "title": "Snapwave Ig Opt", "type": "integer" }, "snapwave_iterative_srcig": { "condition": "snapwave == 1", "default": 0, "description": "SnapWave compute IG source term in iterative loop (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Snapwave Iterative Srcig", "type": "integer" }, "snapwave_use_herbers": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave compute IG boundary conditions with Herbers (1: on, 0: off)", "maximum": 1, "minimum": 0, "title": "Snapwave Use Herbers", "type": "integer" }, "snapwave_tpig_opt": { "condition": "snapwave == 1", "default": 1, "description": "SnapWave IG wave period option for Herbers (1: Tm01, 2: Tpsmooth, 3: Tp, 4: Tm-1,0)", "title": "Snapwave Tpig Opt", "type": "integer" }, "snapwave_jonswapgamma": { "condition": "snapwave == 1", "default": 3.3, "description": "SnapWave JONSWAP gamma of offshore spectrum for Herbers (-)", "title": "Snapwave Jonswapgamma", "type": "number" }, "snapwave_eeinc2ig": { "condition": "snapwave == 1", "default": 0.01, "description": "SnapWave ratio of IG to incident wave energy, used if snapwave_use_herbers = 0 (-)", "title": "Snapwave Eeinc2Ig", "type": "number" }, "snapwave_Tinc2ig": { "condition": "snapwave == 1", "default": 7.0, "description": "SnapWave ratio of IG to incident wave period, used if snapwave_use_herbers = 0 (-)", "title": "Snapwave Tinc2Ig", "type": "number" }, "wave_enhanced_roughness": { "default": 0, "description": "Wave enhanced roughness (1: on, 0: off)", "maximum": 1, "min_version": "2.3.0", "minimum": 0, "title": "Wave Enhanced Roughness", "type": "integer" }, "nonh": { "default": 0, "description": "Enable non-hydrostatic mode (1: on, 0: off)", "maximum": 1, "min_version": "2.2.0", "minimum": 0, "title": "Nonh", "type": "integer" }, "nh_fnudge": { "condition": "nonh == 1", "default": 0.9, "description": "Non-hydrostatic nudge factor (-)", "min_version": "2.2.0", "title": "Nh Fnudge", "type": "number" }, "nh_tstop": { "condition": "nonh == 1", "default": -999.0, "description": "Non-hydrostatic stop time (seconds)", "min_version": "2.2.0", "title": "Nh Tstop", "type": "number" }, "nh_tol": { "condition": "nonh == 1", "default": 0.001, "description": "Non-hydrostatic tolerance (-)", "min_version": "2.2.0", "title": "Nh Tol", "type": "number" }, "nh_itermax": { "condition": "nonh == 1", "default": 100, "description": "Non-hydrostatic maximum iterations (-)", "min_version": "2.2.0", "title": "Nh Itermax", "type": "integer" }, "structure_relax": { "default": 10.0, "description": "Structure relaxation factor (-)", "min_version": "2.2.0", "title": "Structure Relax", "type": "number" }, "bathtub": { "default": 0, "description": "Enable bathtub mode (1: on, 0: off)", "maximum": 1, "min_version": "2.3.2", "minimum": 0, "title": "Bathtub", "type": "integer" }, "bathtub_fachs": { "condition": "bathtub == 1", "default": 0.2, "description": "Bathtub wave height factor (-)", "min_version": "2.3.2", "title": "Bathtub Fachs", "type": "number" }, "bathtub_dt": { "condition": "bathtub == 1", "default": -999.0, "description": "Bathtub time step (seconds)", "min_version": "2.3.2", "title": "Bathtub Dt", "type": "number" }, "sfincs_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Target SFINCS kernel version; controls min_version/max_version field handling", "title": "Sfincs Version" }, "global_model": { "default": 0, "description": "Global spherical model that wraps over the edge (1: on, 0: off)", "legacy_alias": [ [ "global", "2.4.1" ] ], "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Global Model", "type": "integer" }, "crsgeo": { "default": 0, "description": "Geographical coordinate system flag (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Crsgeo", "type": "integer" }, "epsg": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "default": null, "description": "EPSG code for spatial reference system", "legacy_alias": [ [ "crs", "2.0.0" ] ], "title": "Epsg" }, "utmzone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "UTM zone for spatial reference (-)", "title": "Utmzone" }, "inputformat": { "default": "bin", "description": "Input file format (bin or asc)", "title": "Inputformat", "type": "string" }, "outputformat": { "default": "net", "description": "Output file format (net or asc or bin)", "title": "Outputformat", "type": "string" }, "outputtype_map": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Output format for map file (net or asc or bin)", "title": "Outputtype Map" }, "outputtype_his": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Output format for his file (net or asc or bin)", "title": "Outputtype His" }, "nc_deflate_level": { "default": 2, "description": "Netcdf deflate level (-)", "title": "Nc Deflate Level", "type": "integer" }, "rugdepth": { "default": 0.05, "description": "Runup gauge depth threshold (m)", "min_version": "2.3.0", "title": "Rugdepth", "type": "number" }, "h73table": { "default": 0, "description": "Use h73 table (1: on, 0: off)", "maximum": 1, "min_version": "2.2.0", "minimum": 0, "title": "H73Table", "type": "integer" }, "cdnrb": { "always": false, "default": 3, "description": "Number of wind speed ranges for drag coefficient", "title": "Cdnrb", "type": "integer" }, "cdwnd": { "always": false, "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": [ 0.0, 28.0, 50.0 ], "description": "Wind speed ranges for drag coefficient (m/s)", "title": "Cdwnd" }, "cdval": { "always": false, "anyOf": [ { "items": { "type": "number" }, "type": "array" }, { "type": "null" } ], "default": [ 0.001, 0.0025, 0.0015 ], "description": "Drag coefficient values corresponding to cdwnd", "title": "Cdval" }, "qtrfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Quadtree file", "title": "Qtrfile" }, "depfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Depth file", "title": "Depfile" }, "inifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Initial water level file", "title": "Inifile" }, "rstfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Restart file", "title": "Rstfile" }, "mskfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Mask file", "title": "Mskfile" }, "indexfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Index file", "title": "Indexfile" }, "sbgfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Subgrid file", "title": "Sbgfile" }, "thdfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Thin dam structure file", "title": "Thdfile" }, "weirfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Weir structure file", "title": "Weirfile" }, "manningfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Manning's n file", "title": "Manningfile" }, "drnfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Drainage structure file", "title": "Drnfile" }, "volfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Storage volume file", "title": "Volfile" }, "dkbfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Dike breaches file", "min_version": "2.5.0", "title": "Dkbfile" }, "urbfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Urban drainage zones file", "min_version": "2.5.0", "title": "Urbfile" }, "vegfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Vegetation characteristics file", "legacy_alias": [ [ "vegetationfile", "2.4.1" ] ], "min_version": "2.5.0", "title": "Vegfile" }, "vegtype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Vegetation type lookup table file (toml)", "legacy_alias": [ [ "vegetationtype_toml", "2.4.1" ] ], "min_version": "2.5.0", "title": "Vegtype" }, "bndfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Water level boundary points file", "title": "Bndfile" }, "bzsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Water level time-series file", "title": "Bzsfile" }, "bcafile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Tidal boundary component file", "min_version": "2.3.0", "title": "Bcafile" }, "bzifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Individual wave water level file", "title": "Bzifile" }, "bdrfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Downstream river boundary file", "min_version": "2.3.0", "title": "Bdrfile" }, "wavemaker_wfpfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wavemaker location points file", "legacy_alias": [ [ "wfpfile", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Wfpfile" }, "wavemaker_whifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wavemaker IG wave height file", "legacy_alias": [ [ "whifile", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Whifile" }, "wavemaker_wtifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wavemaker IG wave period file", "legacy_alias": [ [ "wtifile", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Wtifile" }, "wavemaker_wstfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wavemaker setup file", "legacy_alias": [ [ "wstfile", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Wstfile" }, "srcfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Discharge input points file", "title": "Srcfile" }, "disfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Discharge input time-series file", "title": "Disfile" }, "spwfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Spiderweb tropical cyclone file", "title": "Spwfile" }, "wndfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Spatially uniform wind file", "title": "Wndfile" }, "prcfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Spatially uniform precipitation file", "legacy_alias": [ [ "precipfile", "2.4.1" ] ], "title": "Prcfile" }, "amufile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wind u-component file", "title": "Amufile" }, "amvfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wind v-component file", "title": "Amvfile" }, "ampfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Atmospheric pressure file", "title": "Ampfile" }, "amprfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Precipitation file", "legacy_alias": [ [ "amrfile", null ] ], "title": "Amprfile" }, "z0lfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wind reduction over land file", "title": "Z0Lfile" }, "wavemaker_wvmfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wave maker input points file", "legacy_alias": [ [ "wvmfile", "2.4.1" ] ], "min_version": "2.3.3", "title": "Wavemaker Wvmfile" }, "wavemaker_timeseries_wvmfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Wave maker input points file, forced by IG time series", "min_version": "2.4.1", "title": "Wavemaker Timeseries Wvmfile" }, "qinffile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Name of the spatially-varying, constant in time infiltration file", "title": "Qinffile" }, "inffile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Infiltration parameters NetCDF file", "legacy_alias": [ [ "infiltrationfile", null ], [ "infiltration_file", "2.4.1" ] ], "min_version": "2.5.0", "title": "Inffile" }, "inftype": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Infiltration type (con, c2d, cna, cnb, gai, hor, bkt, r2d)", "legacy_alias": [ [ "infiltrationtype", null ], [ "infiltration_type", "2.4.1" ] ], "min_version": "2.5.0", "title": "Inftype" }, "scsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Curve Number max soil moisture file", "title": "Scsfile" }, "smaxfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Curve Number max storage file", "title": "Smaxfile" }, "sefffile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Curve Number initial storage file", "title": "Sefffile" }, "psifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Green-Ampt suction head file", "title": "Psifile" }, "sigmafile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Green-Ampt max moisture deficit file", "title": "Sigmafile" }, "ksfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Green-Ampt hydraulic conductivity file", "title": "Ksfile" }, "f0file": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Horton max infiltration capacity file", "title": "F0File" }, "fcfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Horton min infiltration rate file", "title": "Fcfile" }, "kdfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Horton decay constant file", "title": "Kdfile" }, "netbndbzsbzifile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf water level input file", "title": "Netbndbzsbzifile" }, "netsrcdisfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf discharge input file", "title": "Netsrcdisfile" }, "netamuamvfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf wind input file", "title": "Netamuamvfile" }, "netamprfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf precipitation input file", "title": "Netamprfile" }, "netampfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf atmospheric pressure input file", "title": "Netampfile" }, "netspwfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf spiderweb input file", "title": "Netspwfile" }, "snapwave_bndfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave boundary points file", "title": "Snapwave Bndfile" }, "snapwave_bhsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave wave height file", "title": "Snapwave Bhsfile" }, "snapwave_btpfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave wave period file", "title": "Snapwave Btpfile" }, "snapwave_bwdfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave wave direction file", "title": "Snapwave Bwdfile" }, "snapwave_bdsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave wave spreading file", "title": "Snapwave Bdsfile" }, "netsnapwavefile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Netcdf SnapWave boundary file", "title": "Netsnapwavefile" }, "snapwave_jonswapfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave JONSWAP boundary conditions file", "title": "Snapwave Jonswapfile" }, "snapwave_encfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave enclosure file", "title": "Snapwave Encfile" }, "snapwave_upwfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave upwind neighbours file", "title": "Snapwave Upwfile" }, "snapwave_mskfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave mask file", "title": "Snapwave Mskfile" }, "snapwave_depfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave depth file", "title": "Snapwave Depfile" }, "snapwave_ncfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "condition": "snapwave == 1", "default": null, "description": "SnapWave netcdf grid file", "title": "Snapwave Ncfile" }, "obsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Observation points file", "title": "Obsfile" }, "crsfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Cross-section lines file", "title": "Crsfile" }, "rugfile": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": null, "description": "Runup gauges file", "min_version": "2.3.0", "title": "Rugfile" }, "storevelmax": { "default": 0, "description": "Write max velocity output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storevelmax", "type": "integer" }, "storefluxmax": { "default": 0, "description": "Write max flux output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storefluxmax", "type": "integer" }, "storevel": { "always": true, "default": 0, "description": "Write instantaneous velocity output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storevel", "type": "integer" }, "storecumprcp": { "always": true, "default": 0, "description": "Write cumulative precipitation output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storecumprcp", "type": "integer" }, "storetwet": { "default": 0, "description": "Write time-wet output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storetwet", "type": "integer" }, "storehsubgrid": { "default": 0, "description": "Write subgrid depth output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storehsubgrid", "type": "integer" }, "storehmean": { "default": 0, "description": "Write mean water depth output (1: yes, 0: no)", "maximum": 1, "min_version": "2.2.0", "minimum": 0, "title": "Storehmean", "type": "integer" }, "storemeteo": { "always": true, "default": 0, "description": "Write meteo output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storemeteo", "type": "integer" }, "storemaxwind": { "default": 0, "description": "Write max wind speed output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storemaxwind", "type": "integer" }, "storefw": { "default": 0, "description": "Write wave forces output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storefw", "type": "integer" }, "storewavdir": { "default": 0, "description": "Write wave direction output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storewavdir", "type": "integer" }, "storeqdrain": { "default": 1, "description": "[DEPRECATED] Write drainage discharge output (1: yes, 0: no)", "max_version": "2.4.1", "maximum": 1, "minimum": 0, "title": "Storeqdrain", "type": "integer" }, "storezvolume": { "default": 0, "description": "Write storage volume output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Storezvolume", "type": "integer" }, "storestoragevolume": { "default": 0, "description": "Write total storage volume output (1: yes, 0: no)", "maximum": 1, "min_version": "2.3.0", "minimum": 0, "title": "Storestoragevolume", "type": "integer" }, "store_tsunami_arrival_time": { "default": 0, "description": "Write tsunami arrival time output (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Store Tsunami Arrival Time", "type": "integer" }, "store_dynamic_bed_level": { "default": 0, "description": "Write dynamic bed level output (1: yes, 0: no)", "maximum": 1, "min_version": "2.1.3", "minimum": 0, "title": "Store Dynamic Bed Level", "type": "integer" }, "storetzsmax": { "always": true, "default": 0, "description": "Write time of maximum water level output (1: yes, 0: no)", "maximum": 1, "min_version": "2.3.0", "minimum": 0, "title": "Storetzsmax", "type": "integer" }, "storezvolmax": { "default": 1, "description": "Write maximum subgrid cell volume output, subgrid only (1: yes, 0: no)", "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Storezvolmax", "type": "integer" }, "store_river_discharge": { "default": 0, "description": "Write river point discharge output (1: yes, 0: no)", "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Store River Discharge", "type": "integer" }, "store_urban_drainage_discharge": { "default": 0, "description": "Write urban drainage discharge output (1: yes, 0: no)", "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Store Urban Drainage Discharge", "type": "integer" }, "store_cumulative_urban_drainage": { "default": 0, "description": "Write cumulative urban drainage output (1: yes, 0: no)", "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Store Cumulative Urban Drainage", "type": "integer" }, "storesnapwavegrid": { "condition": "snapwave == 1", "default": 0, "description": "Write SnapWave grid output (1: yes, 0: no)", "maximum": 1, "min_version": "2.4.0", "minimum": 0, "title": "Storesnapwavegrid", "type": "integer" }, "writeruntime": { "default": 0, "description": "Write runtimes.txt at the end of the simulation (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Writeruntime", "type": "integer" }, "output_on_quadtree_mesh": { "default": 0, "description": "Write quadtree without refinement on quadtree mesh (1: yes) or regular grid (0: no)", "legacy_alias": [ [ "regular_output_on_mesh", "2.4.1" ] ], "maximum": 1, "min_version": "2.5.0", "minimum": 0, "title": "Output On Quadtree Mesh", "type": "integer" }, "twet_threshold": { "default": 0.01, "description": "Time-wet minimum depth threshold (m)", "minimum": 0.0, "title": "Twet Threshold", "type": "number" }, "timestep_analysis": { "always": true, "default": 0, "description": "Enable timestep analysis output (1: yes, 0: no)", "maximum": 1, "min_version": "2.3.2", "minimum": 0, "title": "Timestep Analysis", "type": "integer" }, "debug": { "default": 0, "description": "Debug mode \u2014 write every timestep (1: yes, 0: no)", "maximum": 1, "minimum": 0, "title": "Debug", "type": "integer" }, "percentage_done": { "default": 5, "description": "Percentage done output interval (%)", "min_version": "2.1.3", "minimum": 1, "title": "Percentage Done", "type": "integer" } }, "additionalProperties": true }
- Config:
extra: str = allow
- Fields:
advection (int)advection_mask (int)advection_scheme (str)advlim (float)alpha (float)ampfile (str | None)amprblock (int)amprfile (str | None)amufile (str | None)amvfile (str | None)baro (int)bathtub (int)bathtub_dt (float)bathtub_fachs (float)bcafile (str | None)bdrfile (str | None)bndfile (str | None)bndtype (int)btfilter (float)btrelax (float)bzifile (str | None)bzsfile (str | None)cdnrb (int)cdval (list[float] | None)cdwnd (list[float] | None)coriolis (int)crsfile (str | None)crsgeo (int)debug (int)depfile (str | None)disfile (str | None)dkbfile (str | None)drnfile (str | None)dthisout (float)dtmapout (float)dtmax (float)dtmaxout (float)dtrstout (float)dtwave (float)dtwnd (float)dx (float | None)dy (float | None)epsg (int | None)f0file (str | None)factor_prcp (float)factor_pres (float)factor_spw_size (float)factor_wind (float)fcfile (str | None)friction2d (int)gapres (float)global_model (int)h73table (int)hmin_cfl (float)horton_kr_kd (float)huthresh (float)huvmin (float)indexfile (str | None)inffile (str | None)inftype (str | None)inifile (str | None)inputformat (str)kdfile (str | None)ksfile (str | None)latitude (float)manning (float)manning_land (float | None)manning_sea (float | None)manningfile (str | None)mmax (int | None)mskfile (str | None)nc_deflate_level (int)netampfile (str | None)netamprfile (str | None)netamuamvfile (str | None)netbndbzsbzifile (str | None)netsnapwavefile (str | None)netspwfile (str | None)netsrcdisfile (str | None)nh_fnudge (float)nh_itermax (int)nh_tol (float)nh_tstop (float)nmax (int | None)nonh (int)nuvisc (float)nuviscfac (float)obsfile (str | None)output_on_quadtree_mesh (int)outputformat (str)outputtype_his (str | None)outputtype_map (str | None)pavbnd (float)percentage_done (int)prcfile (str | None)psifile (str | None)qinf (float | None)qinf_zmin (float)qinffile (str | None)qtrfile (str | None)radstr (int)rgh_lev_land (float | None)rhoa (float)rhow (float)rotation (float)rstfile (str | None)rugdepth (float)rugfile (str | None)sbgfile (str | None)scsfile (str | None)sefffile (str | None)sfacinf (float)sfincs_version (str | None)sigmafile (str | None)slopelim (float)smaxfile (str | None)snapwave (int)snapwave_Tinc2ig (float)snapwave_Tpini (float)snapwave_alpha (float)snapwave_alpha_ig (float)snapwave_alphaigfac (float)snapwave_baldock_exponent (int)snapwave_baldock_ratio (float)snapwave_baldock_ratio_ig (float)snapwave_bdsfile (str | None)snapwave_bhsfile (str | None)snapwave_bndfile (str | None)snapwave_btpfile (str | None)snapwave_bwdfile (str | None)snapwave_c_dispT (float)snapwave_crit (float)snapwave_depfile (str | None)snapwave_dt (float)snapwave_dtheta (float)snapwave_eeinc2ig (float)snapwave_encfile (str | None)snapwave_fw (float)snapwave_fw_ratio (float)snapwave_fwig (float)snapwave_fwig_ratio (float)snapwave_gamma (float)snapwave_gamma_fac_br (float)snapwave_gammaig (float)snapwave_gammax (float)snapwave_hmin (float)snapwave_ig_opt (int)snapwave_igwaves (int)snapwave_iterative_srcig (int)snapwave_jadcgdx (int)snapwave_jonswapfile (str | None)snapwave_jonswapgamma (float)snapwave_mskfile (str | None)snapwave_mwind (int)snapwave_ncfile (str | None)snapwave_niter (int)snapwave_relax_factor_DoverA (float)snapwave_relax_factor_DoverE (float)snapwave_sector (float)snapwave_shinc2ig (float)snapwave_sigmax (float)snapwave_sigmin (float)snapwave_tol (float)snapwave_tpig_opt (int)snapwave_upwfile (str | None)snapwave_use_herbers (int)snapwave_use_nearest (int)snapwave_vegetation (int)snapwave_waveforces_ratio (float)snapwave_wind (int)spinup_meteo (int)spwfile (str | None)spwmergefrac (float)srcfile (str | None)stopdepth (float | None)store_cumulative_urban_drainage (int)store_dynamic_bed_level (int)store_river_discharge (int)store_tsunami_arrival_time (int)store_urban_drainage_discharge (int)storecumprcp (int)storefluxmax (int)storefw (int)storehmean (int)storehsubgrid (int)storemaxwind (int)storemeteo (int)storeqdrain (int)storesnapwavegrid (int)storestoragevolume (int)storetwet (int)storetzsmax (int)storevel (int)storevelmax (int)storewavdir (int)storezvolmax (int)storezvolume (int)structure_relax (float)t0out (float)t1out (float)thdfile (str | None)theta (float)timestep_analysis (int)tref (datetime.datetime)trstout (float)tspinup (float)tstart (datetime.datetime)tstop (datetime.datetime)twet_threshold (float)urbfile (str | None)use_bcafile (int)usespwprecip (int)utmzone (str | None)uvlim (float)uvmax (float)vegfile (str | None)vegtype (str | None)viscosity (int)volfile (str | None)wave_enhanced_roughness (int)waveage (float)wavemaker_filter_fred (float)wavemaker_filter_time (float)wavemaker_freqmax_ig (float)wavemaker_freqmax_inc (float)wavemaker_freqmin_ig (float)wavemaker_freqmin_inc (float)wavemaker_gammax (float)wavemaker_hig (int)wavemaker_hinc (int)wavemaker_hm0_ig_factor (float)wavemaker_hm0_inc_factor (float)wavemaker_hmin (float)wavemaker_nfreqs_ig (int)wavemaker_nfreqs_inc (int)wavemaker_signal (str)wavemaker_timeseries_wvmfile (str | None)wavemaker_tinc2ig (float)wavemaker_tpmin (float)wavemaker_wfpfile (str | None)wavemaker_whifile (str | None)wavemaker_wstfile (str | None)wavemaker_wtifile (str | None)wavemaker_wvmfile (str | None)weirfile (str | None)wiggle_factor (float)wiggle_suppression (int)wiggle_threshold (float)wndfile (str | None)writeruntime (int)x0 (float | None)y0 (float | None)z0lfile (str | None)zsini (float | None)
- Validators:
parse_custom_datetime»trefparse_custom_datetime»tstartparse_custom_datetime»tstopparse_space_separated_floats»cdvalparse_space_separated_floats»cdwnd
- field advection_mask: int = 1#
Option to turn on the advection mask (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field advlim: float = 1.0#
Maximum value of the advection term in the momentum equation (-)
- Constraints:
ge = 0.0
- field alpha: float = 0.5#
Numerical time step reduction for CFL-condition (-)
- Constraints:
ge = 0.001
le = 1.0
- field amprblock: int = 1#
Use ampr data as block interpolation (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field btfilter: float = 60.0#
Water level boundary timeseries filtering period (seconds)
- Constraints:
ge = 0.0
- field cdval: list[float] | None = [0.001, 0.0025, 0.0015]#
Drag coefficient values corresponding to cdwnd
- field crsgeo: int = 0#
Geographical coordinate system flag (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field friction2d: int = 1#
2D friction component in the momentum equation (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field global_model: int = 0#
Global spherical model that wraps over the edge (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field manning: float = 0.04#
Manning’s n coefficient for spatially uniform roughness (s/m^(1/3))
- Constraints:
gt = 0.0
lt = 0.5
- field manning_land: float | None = None#
Manning’s n for land areas; 0.04 recommended, -999 = not set (s/m^(1/3))
- Constraints:
gt = 0.0
lt = 0.5
- field manning_sea: float | None = None#
Manning’s n for sea areas; 0.02 recommended, -999 = not set (s/m^(1/3))
- Constraints:
gt = 0.0
lt = 0.5
- field nuvisc: float = 0.01#
Viscosity coefficient per metre of grid cell length (-)
- Constraints:
ge = 0.0
- field output_on_quadtree_mesh: int = 0#
Write quadtree without refinement on quadtree mesh (1: yes) or regular grid (0: no)
- Constraints:
ge = 0
le = 1
- field qinffile: str | None = None#
Name of the spatially-varying, constant in time infiltration file
- field radstr: int = 0#
Radiation stress forcing from SnapWave (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field rotation: float = 0.0#
Rotation of the grid in degrees from the x-axis (east) in anti-clockwise direction
- Constraints:
gt = -360
lt = 360
- field sfacinf: float = 0.2#
Curve Number initial abstraction factor (-)
- Constraints:
ge = 0.0
le = 1.0
- field sfincs_version: str | None = None#
Target SFINCS kernel version; controls min_version/max_version field handling
- field snapwave_Tinc2ig: float = 7.0#
SnapWave ratio of IG to incident wave period, used if snapwave_use_herbers = 0 (-)
- field snapwave_alphaigfac: float = 1.0#
SnapWave multiplication factor for IG shoaling source term (-)
- field snapwave_baldock_exponent: int = 2#
SnapWave exponent of Baldock dissipation enhancement factor; 0 is unused (-)
- field snapwave_dt: float = 36000.0#
SnapWave internal time step, large value means stationary (seconds)
- field snapwave_eeinc2ig: float = 0.01#
SnapWave ratio of IG to incident wave energy, used if snapwave_use_herbers = 0 (-)
- field snapwave_fw_ratio: float = 1.0#
SnapWave ratio of land to sea friction factor incident waves (-)
- field snapwave_gamma_fac_br: float = 0.45#
SnapWave factor on gamma to determine the incident wave breaking point (-)
- field snapwave_igwaves: int = 1#
SnapWave IG wave computation (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_iterative_srcig: int = 0#
SnapWave compute IG source term in iterative loop (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_jadcgdx: int = 1#
SnapWave include dcg/dx term (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_jonswapgamma: float = 3.3#
SnapWave JONSWAP gamma of offshore spectrum for Herbers (-)
- field snapwave_relax_factor_DoverA: float = 0.25#
SnapWave underrelaxation factor for DoverA; 1.0 disables (-)
- field snapwave_relax_factor_DoverE: float = 0.25#
SnapWave underrelaxation factor for DoverE; 1.0 disables (-)
- field snapwave_shinc2ig: float = 1.0#
SnapWave ratio of IG source term subtracted from incident wave energy (-)
- field snapwave_tpig_opt: int = 1#
SnapWave IG wave period option for Herbers (1: Tm01, 2: Tpsmooth, 3: Tp, 4: Tm-1,0)
- field snapwave_use_herbers: int = 1#
SnapWave compute IG boundary conditions with Herbers (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_use_nearest: int = 1#
SnapWave use nearest interpolation (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_vegetation: int = 0#
SnapWave vegetation dissipation (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field snapwave_wind: int = 0#
SnapWave wind growth process (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field spinup_meteo: int = 0#
Apply spinup to meteo forcing (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field spwmergefrac: float = 0.5#
Spiderweb merge factor with background wind and pressure (-)
- Constraints:
gt = 0.0
lt = 1.0
- field stopdepth: float | None = None#
[DEPRECATED] Minimum water depth for stopping the simulation (m)
- Constraints:
ge = 0.0
- field store_cumulative_urban_drainage: int = 0#
Write cumulative urban drainage output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field store_dynamic_bed_level: int = 0#
Write dynamic bed level output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field store_river_discharge: int = 0#
Write river point discharge output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field store_tsunami_arrival_time: int = 0#
Write tsunami arrival time output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field store_urban_drainage_discharge: int = 0#
Write urban drainage discharge output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storecumprcp: int = 0#
Write cumulative precipitation output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storeqdrain: int = 1#
[DEPRECATED] Write drainage discharge output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storesnapwavegrid: int = 0#
Write SnapWave grid output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storestoragevolume: int = 0#
Write total storage volume output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storetzsmax: int = 0#
Write time of maximum water level output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storevel: int = 0#
Write instantaneous velocity output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field storezvolmax: int = 1#
Write maximum subgrid cell volume output, subgrid only (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field theta: float = 1.0#
Numerical smoothing factor in momentum equation (-)
- Constraints:
ge = 0.8
le = 1.0
- field timestep_analysis: int = 0#
Enable timestep analysis output (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- field use_bcafile: int = 1#
Use tidal boundary condition file (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field wave_enhanced_roughness: int = 0#
Wave enhanced roughness (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field wavemaker_filter_time: float = 600.0#
Filtering duration for wave maker mean water level (s)
- Constraints:
ge = 0.0
- field wavemaker_freqmax_ig: float = 0.1#
Maximum frequency wave maker IG spectrum (Hz)
- Constraints:
ge = 0.0
- field wavemaker_freqmin_ig: float = 0.0#
Minimum frequency wave maker IG spectrum (Hz)
- Constraints:
ge = 0.0
- field wavemaker_hig: int = 1#
Wave maker include IG waves when forced by SnapWave (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field wavemaker_hinc: int = 0#
Wave maker include incident waves when forced by SnapWave (1: on, 0: off)
- Constraints:
ge = 0
le = 1
- field wavemaker_nfreqs_ig: int = 100#
Wave maker number of frequency bins IG spectrum (-)
- Constraints:
ge = 1
le = 500
- field wavemaker_nfreqs_inc: int = 100#
Wave maker number of frequency bins incident wave spectrum (-)
- field wavemaker_timeseries_wvmfile: str | None = None#
Wave maker input points file, forced by IG time series
- field wavemaker_tinc2ig: float = -1.0#
Wave maker ratio of IG to incident wave period; <= 0 uses Herbers (-)
- field wiggle_threshold: float = 0.1#
Wiggle suppression minimum depth threshold (m)
- Constraints:
ge = 0.0
- field writeruntime: int = 0#
Write runtimes.txt at the end of the simulation (1: yes, 0: no)
- Constraints:
ge = 0
le = 1
- classmethod read(filename: str | Path) SfincsConfigVariables[source]#
Read a SFINCS input file (sfincs.inp) into a validated instance.
Keywords are kept as read (and written back as such), except those that are not valid for the
sfincs_versionin the file or, withoutsfincs_version, that predateMIN_SUPPORTED_SFINCS_VERSION; these are replaced or removed with a warning.
- classmethod resolve_key(key: str) str[source]#
Return the current field name for a (legacy) keyword, e.g. ‘wvmfile’.
- model_post_init(context: Any, /) None#
This function is meant to behave like a BaseModel method to initialize private attributes.
It takes context as an argument since that’s what pydantic-core passes when calling it.
- Args:
self: The BaseModel instance. context: The context.
- set_value(key: str, value, skip_validation: bool = False) SfincsConfigVariables[source]#
Return a new, validated instance with a single attribute updated.
Parameters:#
- key (str):
The key to set the value for.
- value (Any):
The value to set.
- skip_validation (bool):
If True, skips pydantic validation of the new value.
- set_values(updates: dict, skip_validation: bool = False) SfincsConfigVariables[source]#
Return a new, validated instance with multiple attributes updated.
Parameters:#
- updates (dict):
Mapping of key-value pairs to update. Legacy keywords (e.g. ‘wvmfile’) are set on their current field and written as such, unless the targeted
sfincs_versiondoes not read them.- skip_validation (bool):
If True, skips pydantic validation of the new values.
- to_dict(explicit_only: bool = False) dict[source]#
Return the configuration as a plain dict of native Python values.
Unlike
model_dump(), this is not filtered or formatted for the sfincs.inp file: every set field (including conditionally-irrelevant or default-valued ones) is included with its native Python type (e.g.datetime,list[float]), making it suitable for introspection.- Parameters:
(bool) (explicit_only) – If True, return only fields explicitly read or set. Default is False.
- write(filename: str | Path, write_description: bool = False, write_comments: bool = False, explicit_only: bool = False, update_to_latest: bool = False) None[source]#
Write the configuration variables to a SFINCS input file (sfincs.inp).
Parameters:#
- filename (str | Path):
The file to write the configuration to.
- write_description (bool):
If True, append the schema field description as a trailing comment. Default is False.
- write_comments (bool):
If True, append the original inline comment read from the source file (if any) as a trailing comment, taking priority over write_description for keys that have one. Default is False.
- explicit_only (bool):
If True, write only fields explicitly read or set. Default is False.
- update_to_latest (bool):
If True, write the configuration for
LATEST_SFINCS_VERSION: current keywords instead of legacy ones, no deprecated fields andsfincs_versionset to that version. The configuration itself is not changed. Default is False, which writes keywords as read or set.