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": {
         "always": true,
         "anyOf": [
            {
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid cells in x-direction",
         "title": "Mmax"
      },
      "nmax": {
         "always": true,
         "anyOf": [
            {
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid cells in y-direction",
         "title": "Nmax"
      },
      "dx": {
         "always": true,
         "anyOf": [
            {
               "exclusiveMinimum": 0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Grid size in x-direction",
         "title": "Dx"
      },
      "dy": {
         "always": true,
         "anyOf": [
            {
               "exclusiveMinimum": 0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Grid size in y-direction",
         "title": "Dy"
      },
      "x0": {
         "always": true,
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Origin of the grid in the x-direction",
         "title": "X0"
      },
      "y0": {
         "always": true,
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Origin of the grid in the y-direction",
         "title": "Y0"
      },
      "rotation": {
         "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-04-16T00:00:00",
         "description": "Reference time for simulation",
         "format": "date-time",
         "title": "Tref",
         "type": "string"
      },
      "tstart": {
         "always": true,
         "default": "2026-04-16T00:00:00",
         "description": "Start time for the simulation",
         "format": "date-time",
         "title": "Tstart",
         "type": "string"
      },
      "tstop": {
         "always": true,
         "default": "2026-04-17T00: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": 0.0,
         "description": "Spatial map output interval (seconds)",
         "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": true,
         "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)",
         "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": true,
         "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 (-)",
         "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)",
         "title": "Uvlim",
         "type": "number"
      },
      "uvmax": {
         "default": 1000.0,
         "description": "Maximum velocity (m/s)",
         "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"
      },
      "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": {
         "default": 0.04,
         "description": "Manning's n for land areas; -999 = not set (s/m^(1/3))",
         "title": "Manning Land",
         "type": "number"
      },
      "manning_sea": {
         "default": 0.02,
         "description": "Manning's n for sea areas; -999 = not set (s/m^(1/3))",
         "title": "Manning Sea",
         "type": "number"
      },
      "rgh_lev_land": {
         "default": 0.0,
         "description": "Elevation level to distinguish land and sea roughness (m)",
         "title": "Rgh Lev Land",
         "type": "number"
      },
      "rhoa": {
         "always": true,
         "default": 1.25,
         "description": "Air density (kg/m^3)",
         "exclusiveMinimum": 0.0,
         "title": "Rhoa",
         "type": "number"
      },
      "rhow": {
         "always": true,
         "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": true,
         "default": 1,
         "description": "Enable atmospheric pressure term (1: yes, 0: no)",
         "maximum": 1,
         "minimum": 0,
         "title": "Baro",
         "type": "integer"
      },
      "pavbnd": {
         "always": true,
         "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,
         "default": 0.0,
         "description": "Initial water level in entire domain (meters)",
         "title": "Zsini",
         "type": "number"
      },
      "bndtype": {
         "default": 1,
         "description": "Boundary type (-)",
         "minimum": 1,
         "title": "Bndtype",
         "type": "integer"
      },
      "btfilter": {
         "always": true,
         "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,
         "minimum": 0,
         "title": "Use Bcafile",
         "type": "integer"
      },
      "qinf": {
         "default": 0.0,
         "description": "Infiltration rate, spatially uniform (mm/hr)",
         "minimum": 0.0,
         "title": "Qinf",
         "type": "number"
      },
      "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"
      },
      "nfreqsig": {
         "default": 100,
         "description": "Wave maker number of frequency bins IG spectrum (-)",
         "maximum": 500,
         "minimum": 1,
         "title": "Nfreqsig",
         "type": "integer"
      },
      "freqminig": {
         "default": 0.0,
         "description": "Minimum frequency wave maker IG spectrum (Hz)",
         "minimum": 0.0,
         "title": "Freqminig",
         "type": "number"
      },
      "freqmaxig": {
         "default": 0.1,
         "description": "Maximum frequency wave maker IG spectrum (Hz)",
         "minimum": 0.0,
         "title": "Freqmaxig",
         "type": "number"
      },
      "wmtfilter": {
         "default": 600.0,
         "description": "Filtering duration for wave maker mean water level (s)",
         "minimum": 0.0,
         "title": "Wmtfilter",
         "type": "number"
      },
      "wmfred": {
         "default": 0.99,
         "description": "Filtering variable in wave maker (-)",
         "title": "Wmfred",
         "type": "number"
      },
      "wmsignal": {
         "default": "spectrum",
         "description": "Wavemaker signal type ('spectrum' or 'mon')",
         "title": "Wmsignal",
         "type": "string"
      },
      "wmhmin": {
         "default": 0.1,
         "description": "Wavemaker minimum water depth (m)",
         "title": "Wmhmin",
         "type": "number"
      },
      "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 (-)",
         "title": "Factor Wind",
         "type": "number"
      },
      "factor_pres": {
         "default": 1.0,
         "description": "Pressure forcing scale factor (-)",
         "title": "Factor Pres",
         "type": "number"
      },
      "factor_prcp": {
         "default": 1.0,
         "description": "Precipitation forcing scale factor (-)",
         "title": "Factor Prcp",
         "type": "number"
      },
      "factor_spw_size": {
         "default": 1.0,
         "description": "Spiderweb size scale factor (-)",
         "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,
         "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,
         "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_nrsweeps": {
         "condition": "snapwave == 1",
         "default": 4,
         "description": "SnapWave maximum number of sweeps (-)",
         "minimum": 1,
         "title": "Snapwave Nrsweeps",
         "type": "integer"
      },
      "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"
      },
      "wave_enhanced_roughness": {
         "default": 0,
         "description": "Wave enhanced roughness (1: on, 0: off)",
         "maximum": 1,
         "minimum": 0,
         "title": "Wave Enhanced Roughness",
         "type": "integer"
      },
      "nonh": {
         "default": 0,
         "description": "Enable non-hydrostatic mode (1: on, 0: off)",
         "maximum": 1,
         "minimum": 0,
         "title": "Nonh",
         "type": "integer"
      },
      "nh_fnudge": {
         "condition": "nonh == 1",
         "default": 0.9,
         "description": "Non-hydrostatic nudge factor (-)",
         "title": "Nh Fnudge",
         "type": "number"
      },
      "nh_tstop": {
         "condition": "nonh == 1",
         "default": -999.0,
         "description": "Non-hydrostatic stop time (seconds)",
         "title": "Nh Tstop",
         "type": "number"
      },
      "nh_tol": {
         "condition": "nonh == 1",
         "default": 0.001,
         "description": "Non-hydrostatic tolerance (-)",
         "title": "Nh Tol",
         "type": "number"
      },
      "nh_itermax": {
         "condition": "nonh == 1",
         "default": 100,
         "description": "Non-hydrostatic maximum iterations (-)",
         "title": "Nh Itermax",
         "type": "integer"
      },
      "structure_relax": {
         "default": 10.0,
         "description": "Structure relaxation factor (-)",
         "title": "Structure Relax",
         "type": "number"
      },
      "bathtub": {
         "default": 0,
         "description": "Enable bathtub mode (1: on, 0: off)",
         "maximum": 1,
         "minimum": 0,
         "title": "Bathtub",
         "type": "integer"
      },
      "bathtub_fachs": {
         "condition": "bathtub == 1",
         "default": 0.2,
         "description": "Bathtub wave height factor (-)",
         "title": "Bathtub Fachs",
         "type": "number"
      },
      "bathtub_dt": {
         "condition": "bathtub == 1",
         "default": -999.0,
         "description": "Bathtub time step (seconds)",
         "title": "Bathtub Dt",
         "type": "number"
      },
      "global": {
         "default": 0,
         "description": "Global spherical model that wraps over the edge (1: on, 0: off)",
         "maximum": 1,
         "minimum": 0,
         "title": "Global",
         "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",
         "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)",
         "title": "Rugdepth",
         "type": "number"
      },
      "h73table": {
         "default": 0,
         "description": "Use h73 table (1: on, 0: off)",
         "maximum": 1,
         "minimum": 0,
         "title": "H73Table",
         "type": "integer"
      },
      "cdnrb": {
         "always": true,
         "default": 0,
         "description": "Number of wind speed ranges for drag coefficient",
         "title": "Cdnrb",
         "type": "integer"
      },
      "cdwnd": {
         "always": true,
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wind speed ranges for drag coefficient (m/s)",
         "title": "Cdwnd"
      },
      "cdval": {
         "always": true,
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "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"
      },
      "ncinifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Netcdf initial water level file",
         "title": "Ncinifile"
      },
      "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"
      },
      "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",
         "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",
         "title": "Bdrfile"
      },
      "wfpfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker location points file",
         "title": "Wfpfile"
      },
      "whifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker IG wave height file",
         "title": "Whifile"
      },
      "wtifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker IG wave period file",
         "title": "Wtifile"
      },
      "wstfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker setup file",
         "title": "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",
         "title": "Prcfile"
      },
      "precipfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "LEGACY precipitation file (use prcfile)",
         "title": "Precipfile"
      },
      "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",
         "title": "Amprfile"
      },
      "z0lfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wind reduction over land file",
         "title": "Z0Lfile"
      },
      "wvmfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wave maker input points file",
         "title": "Wvmfile"
      },
      "qinffile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Infiltration file",
         "title": "Qinffile"
      },
      "infiltration_file": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Infiltration file (alternative)",
         "title": "Infiltration File"
      },
      "infiltration_type": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Infiltration type",
         "title": "Infiltration Type"
      },
      "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"
      },
      "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",
         "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,
         "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": "Write drainage discharge output (1: yes, 0: no)",
         "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,
         "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,
         "minimum": 0,
         "title": "Store Dynamic Bed Level",
         "type": "integer"
      },
      "regular_output_on_mesh": {
         "default": 0,
         "description": "Write regular grid on quadtree mesh output (1: yes, 0: no)",
         "maximum": 1,
         "minimum": 0,
         "title": "Regular Output On Mesh",
         "type": "integer"
      },
      "twet_threshold": {
         "default": 0.01,
         "description": "Time-wet minimum depth threshold (m)",
         "minimum": 0.0,
         "title": "Twet Threshold",
         "type": "number"
      },
      "tsunami_arrival_threshold": {
         "default": 0.01,
         "description": "Tsunami arrival minimum depth threshold (m)",
         "minimum": 0.0,
         "title": "Tsunami Arrival Threshold",
         "type": "number"
      },
      "timestep_analysis": {
         "default": 0,
         "description": "Enable timestep analysis output (1: yes, 0: no)",
         "maximum": 1,
         "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 (%)",
         "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)
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)
freqmaxig (float)
freqminig (float)
friction2d (int)
gapres (float)
global_ (int)
h73table (int)
hmin_cfl (float)
horton_kr_kd (float)
huthresh (float)
huvmin (float)
indexfile (str | None)
infiltration_file (str | None)
infiltration_type (str | None)
inifile (str | None)
inputformat (str)
kdfile (str | None)
ksfile (str | None)
latitude (float)
manning (float)
manning_land (float)
manning_sea (float)
manningfile (str | None)
mmax (int | None)
mskfile (str | None)
nc_deflate_level (int)
ncinifile (str | None)
netampfile (str | None)
netamprfile (str | None)
netamuamvfile (str | None)
netbndbzsbzifile (str | None)
netsnapwavefile (str | None)
netspwfile (str | None)
netsrcdisfile (str | None)
nfreqsig (int)
nh_fnudge (float)
nh_itermax (int)
nh_tol (float)
nh_tstop (float)
nmax (int | None)
nonh (int)
nuvisc (float)
nuviscfac (float)
obsfile (str | None)
outputformat (str)
outputtype_his (str | None)
outputtype_map (str | None)
pavbnd (float)
percentage_done (int)
prcfile (str | None)
precipfile (str | None)
psifile (str | None)
qinf (float)
qinf_zmin (float)
qinffile (str | None)
qtrfile (str | None)
regular_output_on_mesh (int)
rgh_lev_land (float)
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)
sigmafile (str | None)
slopelim (float)
smaxfile (str | None)
snapwave (int)
snapwave_bdsfile (str | None)
snapwave_bhsfile (str | None)
snapwave_bndfile (str | None)
snapwave_btpfile (str | None)
snapwave_bwdfile (str | None)
snapwave_crit (float)
snapwave_dtheta (float)
snapwave_hmin (float)
snapwave_igwaves (int)
snapwave_nrsweeps (int)
snapwave_use_nearest (int)
snapwave_wind (int)
spinup_meteo (int)
spwfile (str | None)
spwmergefrac (float)
srcfile (str | None)
store_dynamic_bed_level (int)
store_tsunami_arrival_time (int)
storecumprcp (int)
storefluxmax (int)
storefw (int)
storehmean (int)
storehsubgrid (int)
storemaxwind (int)
storemeteo (int)
storeqdrain (int)
storestoragevolume (int)
storetwet (int)
storevel (int)
storevelmax (int)
storewavdir (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)
tsunami_arrival_threshold (float)
twet_threshold (float)
use_bcafile (int)
usespwprecip (int)
utmzone (str | None)
uvlim (float)
uvmax (float)
viscosity (int)
volfile (str | None)
wave_enhanced_roughness (int)
waveage (float)
weirfile (str | None)
wfpfile (str | None)
whifile (str | None)
wiggle_factor (float)
wiggle_suppression (int)
wiggle_threshold (float)
wmfred (float)
wmhmin (float)
wmsignal (str)
wmtfilter (float)
wndfile (str | None)
wstfile (str | None)
wtifile (str | None)
wvmfile (str | None)
x0 (float | None)
y0 (float | None)
z0lfile (str | None)
zsini (float)

Validators:

parse_custom_datetime » tref
parse_custom_datetime » tstart
parse_custom_datetime » tstop

field advection: int = 1#

Enable advection (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field advection_mask: int = 1#

Option to turn on the advection mask (1: on, 0: off)

Constraints:

ge = 0
le = 1

field advection_scheme: str = 'upw1'#: Advection scheme (‘upw1’ or ‘original’)

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 ampfile: str | None = None#: Atmospheric pressure file

field amprblock: int = 1#

Use ampr data as block interpolation (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field amprfile: str | None = None#: Precipitation file

field amufile: str | None = None#: Wind u-component file

field amvfile: str | None = None#: Wind v-component file

field baro: int = 1#

Enable atmospheric pressure term (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field bathtub: int = 0#

Enable bathtub mode (1: on, 0: off)

Constraints:

ge = 0
le = 1

field bathtub_dt: float = -999.0#: Bathtub time step (seconds)

field bathtub_fachs: float = 0.2#: Bathtub wave height factor (-)

field bcafile: str | None = None#: Tidal boundary component file

field bdrfile: str | None = None#: Downstream river boundary file

field bndfile: str | None = None#: Water level boundary points file

field bndtype: int = 1#

Boundary type (-)

Constraints:

ge = 1

field btfilter: float = 60.0#

Water level boundary timeseries filtering period (seconds)

Constraints:

ge = 0.0

field btrelax: float = 3600.0#

Relaxation in uvmean (seconds)

Constraints:

ge = 0.0

field bzifile: str | None = None#: Individual wave water level file

field bzsfile: str | None = None#: Water level time-series file

field cdnrb: int = 0#: Number of wind speed ranges for drag coefficient

field cdval: list[float] | None = None#: Drag coefficient values corresponding to cdwnd

field cdwnd: list[float] | None = None#: Wind speed ranges for drag coefficient (m/s)

field coriolis: int = 1#

Enable Coriolis term (1: on, 0: off)

Constraints:

ge = 0
le = 1

field crsfile: str | None = None#: Cross-section lines file

field crsgeo: int = 0#

Geographical coordinate system flag (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field debug: int = 0#

Debug mode — write every timestep (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field depfile: str | None = None#: Depth file

field disfile: str | None = None#: Discharge input time-series file

field drnfile: str | None = None#: Drainage structure file

field dthisout: float = 600.0#: Timeseries output interval (seconds)

field dtmapout: float = 0.0#

Spatial map output interval (seconds)

Constraints:

ge = 0.0

field dtmax: float = 60.0#

Maximum allowed internal timestep (seconds)

Constraints:

gt = 0.0

field dtmaxout: float = 86400.0#

Maximum map output interval (seconds)

Constraints:

ge = 0.0

field dtrstout: float = 0.0#

Restart file output interval (seconds)

Constraints:

ge = 0.0

field dtwave: float = 3600.0#: Interval of running SnapWave (seconds)

field dtwnd: float = 1800.0#: Interval of updating wind forcing (seconds)

field dx: float | None = None#

Grid size in x-direction

Constraints:

gt = 0

field dy: float | None = None#

Grid size in y-direction

Constraints:

gt = 0

field epsg: int | None = None#: EPSG code for spatial reference system

field f0file: str | None = None#: Horton max infiltration capacity file

field factor_prcp: float = 1.0#: Precipitation forcing scale factor (-)

field factor_pres: float = 1.0#: Pressure forcing scale factor (-)

field factor_spw_size: float = 1.0#: Spiderweb size scale factor (-)

field factor_wind: float = 1.0#: Wind forcing scale factor (-)

field fcfile: str | None = None#: Horton min infiltration rate file

field freqmaxig: float = 0.1#

Maximum frequency wave maker IG spectrum (Hz)

Constraints:

ge = 0.0

field freqminig: float = 0.0#

Minimum frequency wave maker IG spectrum (Hz)

Constraints:

ge = 0.0

field friction2d: int = 1#

2D friction component in the momentum equation (1: on, 0: off)

Constraints:

ge = 0
le = 1

field gapres: float = 101200.0#: Background atmospheric pressure for spiderweb (Pa)

field global_: int = 0 (alias 'global')#

Global spherical model that wraps over the edge (1: on, 0: off)

Constraints:

ge = 0
le = 1

field h73table: int = 0#

Use h73 table (1: on, 0: off)

Constraints:

ge = 0
le = 1

field hmin_cfl: float = 0.1#

Minimum water depth for CFL condition (meters)

Constraints:

gt = 0.0

field horton_kr_kd: float = 10.0#: Horton infiltration recovery vs decay ratio (-)

field huthresh: float = 0.01#

Threshold water depth (meters)

Constraints:

gt = 0.0
lt = 1.0

field huvmin: float = 0.0#: Minimum water depth for velocity computation (meters)

field indexfile: str | None = None#: Index file

field infiltration_file: str | None = None#: Infiltration file (alternative)

field infiltration_type: str | None = None#: Infiltration type

field inifile: str | None = None#: Initial water level file

field inputformat: str = 'bin'#: Input file format (bin or asc)

field kdfile: str | None = None#: Horton decay constant file

field ksfile: str | None = None#: Green-Ampt hydraulic conductivity file

field latitude: float = 0.0#: Latitude of the grid center (degrees)

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 = 0.04#: Manning’s n for land areas; -999 = not set (s/m^(1/3))

field manning_sea: float = 0.02#: Manning’s n for sea areas; -999 = not set (s/m^(1/3))

field manningfile: str | None = None#: Manning’s n file

field mmax: int | None = None#

Number of grid cells in x-direction

Constraints:

ge = 1

field mskfile: str | None = None#: Mask file

field nc_deflate_level: int = 2#: Netcdf deflate level (-)

field ncinifile: str | None = None#: Netcdf initial water level file

field netampfile: str | None = None#: Netcdf atmospheric pressure input file

field netamprfile: str | None = None#: Netcdf precipitation input file

field netamuamvfile: str | None = None#: Netcdf wind input file

field netbndbzsbzifile: str | None = None#: Netcdf water level input file

field netsnapwavefile: str | None = None#: Netcdf SnapWave boundary file

field netspwfile: str | None = None#: Netcdf spiderweb input file

field netsrcdisfile: str | None = None#: Netcdf discharge input file

field nfreqsig: int = 100#

Wave maker number of frequency bins IG spectrum (-)

Constraints:

ge = 1
le = 500

field nh_fnudge: float = 0.9#: Non-hydrostatic nudge factor (-)

field nh_itermax: int = 100#: Non-hydrostatic maximum iterations (-)

field nh_tol: float = 0.001#: Non-hydrostatic tolerance (-)

field nh_tstop: float = -999.0#: Non-hydrostatic stop time (seconds)

field nmax: int | None = None#

Number of grid cells in y-direction

Constraints:

ge = 1

field nonh: int = 0#

Enable non-hydrostatic mode (1: on, 0: off)

Constraints:

ge = 0
le = 1

field nuvisc: float = 0.01#

Viscosity coefficient per metre of grid cell length (-)

Constraints:

ge = 0.0

field nuviscfac: float = 100.0#

Viscosity factor (-)

Constraints:

ge = 0.0

field obsfile: str | None = None#: Observation points file

field outputformat: str = 'net'#: Output file format (net or asc or bin)

field outputtype_his: str | None = None#: Output format for his file (net or asc or bin)

field outputtype_map: str | None = None#: Output format for map file (net or asc or bin)

field pavbnd: float = 0.0#: Atmospheric pressure at boundary (Pa)

field percentage_done: int = 5#

Percentage done output interval (%)

Constraints:

ge = 1

field prcfile: str | None = None#: Spatially uniform precipitation file

field precipfile: str | None = None#: LEGACY precipitation file (use prcfile)

field psifile: str | None = None#: Green-Ampt suction head file

field qinf: float = 0.0#

Infiltration rate, spatially uniform (mm/hr)

Constraints:

ge = 0.0

field qinf_zmin: float = 0.0#: Minimum elevation for spatially uniform infiltration (m)

field qinffile: str | None = None#: Infiltration file

field qtrfile: str | None = None#: Quadtree file

field regular_output_on_mesh: int = 0#

Write regular grid on quadtree mesh output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field rgh_lev_land: float = 0.0#: Elevation level to distinguish land and sea roughness (m)

field rhoa: float = 1.25#

Air density (kg/m^3)

Constraints:

gt = 0.0

field rhow: float = 1024.0#

Water density (kg/m^3)

Constraints:

gt = 0.0

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 rstfile: str | None = None#: Restart file

field rugdepth: float = 0.05#: Runup gauge depth threshold (m)

field rugfile: str | None = None#: Runup gauges file

field sbgfile: str | None = None#: Subgrid file

field scsfile: str | None = None#: Curve Number max soil moisture file

field sefffile: str | None = None#: Curve Number initial storage file

field sfacinf: float = 0.2#

Curve Number initial abstraction factor (-)

Constraints:

ge = 0.0
le = 1.0

field sigmafile: str | None = None#: Green-Ampt max moisture deficit file

field slopelim: float = 9999.9#

Slope limiter (-)

Constraints:

ge = 0.0

field smaxfile: str | None = None#: Curve Number max storage file

field snapwave: int = 0#

Enable coupled SnapWave solver (1: on, 0: off)

Constraints:

ge = 0
le = 1

field snapwave_bdsfile: str | None = None#: SnapWave wave spreading file

field snapwave_bhsfile: str | None = None#: SnapWave wave height file

field snapwave_bndfile: str | None = None#: SnapWave boundary points file

field snapwave_btpfile: str | None = None#: SnapWave wave period file

field snapwave_bwdfile: str | None = None#: SnapWave wave direction file

field snapwave_crit: float = 0.001#

SnapWave convergence criterion (-)

Constraints:

gt = 0

field snapwave_dtheta: float = 10.0#

SnapWave directional resolution (degrees)

Constraints:

gt = 0

field snapwave_hmin: float = 0.1#

SnapWave minimum water depth (m)

Constraints:

gt = 0

field snapwave_igwaves: int = 1#

SnapWave IG wave computation (1: on, 0: off)

Constraints:

ge = 0
le = 1

field snapwave_nrsweeps: int = 4#

SnapWave maximum number of sweeps (-)

Constraints:

ge = 1

field snapwave_use_nearest: int = 1#

SnapWave use nearest interpolation (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 spwfile: str | None = None#: Spiderweb tropical cyclone file

field spwmergefrac: float = 0.5#

Spiderweb merge factor with background wind and pressure (-)

Constraints:

gt = 0.0
lt = 1.0

field srcfile: str | None = None#: Discharge input points file

field store_dynamic_bed_level: int = 0#

Write dynamic bed level 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 storecumprcp: int = 0#

Write cumulative precipitation output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storefluxmax: int = 0#

Write max flux output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storefw: int = 0#

Write wave forces output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storehmean: int = 0#

Write mean water depth output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storehsubgrid: int = 0#

Write subgrid depth output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storemaxwind: int = 0#

Write max wind speed output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storemeteo: int = 0#

Write meteo output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storeqdrain: int = 1#

Write drainage discharge 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 storetwet: int = 0#

Write time-wet 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 storevelmax: int = 0#

Write max velocity output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storewavdir: int = 0#

Write wave direction output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storezvolume: int = 0#

Write storage volume output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field structure_relax: float = 10.0#: Structure relaxation factor (-)

field t0out: float = -999.0#: Output start time (seconds)

field t1out: float = -999.0#: Output stop time (seconds)

field thdfile: str | None = None#: Thin dam structure file

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 tref: datetime = datetime.datetime(2026, 4, 16, 0, 0)#: Reference time for simulation

field trstout: float = -999.0#: Restart file output after specific time (seconds)

field tspinup: float = 0.0#

Duration of spinup period (seconds)

Constraints:

ge = 0.0

field tstart: datetime = datetime.datetime(2026, 4, 16, 0, 0)#: Start time for the simulation

field tstop: datetime = datetime.datetime(2026, 4, 17, 0, 0)#: Stop time for the simulation

field tsunami_arrival_threshold: float = 0.01#

Tsunami arrival minimum depth threshold (m)

Constraints:

ge = 0.0

field twet_threshold: float = 0.01#

Time-wet minimum depth threshold (m)

Constraints:

ge = 0.0

field use_bcafile: int = 1#

Use tidal boundary condition file (1: on, 0: off)

Constraints:

ge = 0
le = 1

field usespwprecip: int = 1#

Use rainfall from spiderweb (1: on, 0: off)

Constraints:

ge = 0
le = 1

field utmzone: str | None = None#: UTM zone for spatial reference (-)

field uvlim: float = 10.0#: Velocity limiter (m/s)

field uvmax: float = 1000.0#: Maximum velocity (m/s)

field viscosity: int = 1#

Enable viscosity term (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field volfile: str | None = None#: Storage volume file

field wave_enhanced_roughness: int = 0#

Wave enhanced roughness (1: on, 0: off)

Constraints:

ge = 0
le = 1

field waveage: float = -999.0#: Determine Cd with wave age (-)

field weirfile: str | None = None#: Weir structure file

field wfpfile: str | None = None#: Wavemaker location points file

field whifile: str | None = None#: Wavemaker IG wave height file

field wiggle_factor: float = 0.1#

Wiggle suppression factor (-)

Constraints:

ge = 0.0

field wiggle_suppression: int = 1#

Wiggle suppression (1: on, 0: off)

Constraints:

ge = 0
le = 1

field wiggle_threshold: float = 0.1#

Wiggle suppression minimum depth threshold (m)

Constraints:

ge = 0.0

field wmfred: float = 0.99#: Filtering variable in wave maker (-)

field wmhmin: float = 0.1#: Wavemaker minimum water depth (m)

field wmsignal: str = 'spectrum'#: Wavemaker signal type (‘spectrum’ or ‘mon’)

field wmtfilter: float = 600.0#

Filtering duration for wave maker mean water level (s)

Constraints:

ge = 0.0

field wndfile: str | None = None#: Spatially uniform wind file

field wstfile: str | None = None#: Wavemaker setup file

field wtifile: str | None = None#: Wavemaker IG wave period file

field wvmfile: str | None = None#: Wave maker input points file

field x0: float | None = None#: Origin of the grid in the x-direction

field y0: float | None = None#: Origin of the grid in the y-direction

field z0lfile: str | None = None#: Wind reduction over land file

field zsini: float = 0.0#: Initial water level in entire domain (meters)

class Config[source]#

validator parse_custom_datetime » tstop, tref, tstart[source]#