hydromt_sfincs.components.config.SfincsConfigVariables#

pydantic settings hydromt_sfincs.components.config.SfincsConfigVariables[source]#

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",
   "type": "object",
   "properties": {
      "mmax": {
         "anyOf": [
            {
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid cells in x-direction",
         "examples": 10,
         "title": "Mmax"
      },
      "nmax": {
         "anyOf": [
            {
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of grid cells in y-direction",
         "examples": 10,
         "title": "Nmax"
      },
      "dx": {
         "anyOf": [
            {
               "exclusiveMinimum": 0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Grid size in x-direction",
         "examples": 10.0,
         "title": "Dx"
      },
      "dy": {
         "anyOf": [
            {
               "exclusiveMinimum": 0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Grid size in y-direction",
         "examples": 10.0,
         "title": "Dy"
      },
      "x0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Origin of the grid in the x-direction",
         "examples": 0.0,
         "title": "X0"
      },
      "y0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Origin of the grid in the y-direction",
         "examples": 0.0,
         "title": "Y0"
      },
      "rotation": {
         "anyOf": [
            {
               "exclusiveMaximum": 360,
               "exclusiveMinimum": -360,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Rotation of the grid in degrees from the x-axis (east) in anti-clockwise direction",
         "examples": 0.0,
         "title": "Rotation"
      },
      "tref": {
         "default": "2025-11-25T00:00:00",
         "description": "Reference time for simulation (datetime)",
         "format": "date-time",
         "title": "Tref",
         "type": "string"
      },
      "tstart": {
         "default": "2025-11-25T00:00:00",
         "description": "Start time for the simulation (datetime)",
         "format": "date-time",
         "title": "Tstart",
         "type": "string"
      },
      "tstop": {
         "default": "2025-11-26T00:00:00",
         "description": "Stop time for the simulation (datetime)",
         "format": "date-time",
         "title": "Tstop",
         "type": "string"
      },
      "tspinup": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Duration of spinup period for boundary conditions after tstart (seconds)",
         "examples": 0.0,
         "title": "Tspinup"
      },
      "t0out": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Output start time (seconds)",
         "examples": -999.0,
         "title": "T0Out"
      },
      "t1out": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Output stop time (seconds)",
         "examples": -999.0,
         "title": "T1Out"
      },
      "dtmapout": {
         "default": 3600.0,
         "description": "Spatial map output interval (seconds)",
         "minimum": 0.0,
         "title": "Dtmapout",
         "type": "number"
      },
      "dtmaxout": {
         "default": 86400.0,
         "description": "Maximum map output interval (seconds)",
         "minimum": 0.0,
         "title": "Dtmaxout",
         "type": "number"
      },
      "dtrstout": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Restart file output interval (seconds)",
         "examples": 0.0,
         "title": "Dtrstout"
      },
      "trstout": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Restart file output after specific time (seconds)",
         "examples": -999.0,
         "title": "Trstout"
      },
      "dthisout": {
         "default": 600.0,
         "description": "Timeseries output interval (seconds)",
         "title": "Dthisout",
         "type": "number"
      },
      "dtwave": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Interval of running SnapWave (seconds)",
         "examples": 1800.0,
         "title": "Dtwave"
      },
      "dtwnd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Interval of updating wind forcing (seconds)",
         "examples": 1800.0,
         "title": "Dtwnd"
      },
      "alpha": {
         "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": {
         "anyOf": [
            {
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Minimum water depth for cfl condition in max timestep determination (meters)",
         "examples": 0.1,
         "title": "Hmin Cfl"
      },
      "manning": {
         "anyOf": [
            {
               "exclusiveMaximum": 0.5,
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Manning's n coefficient for spatially uniform roughness, if no other manning options specified (s/m^(1/3))",
         "examples": 0.04,
         "title": "Manning"
      },
      "manning_land": {
         "anyOf": [
            {
               "exclusiveMaximum": 0.5,
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.04,
         "description": "Manning's n coefficient for land areas, if no other manning options specified (s/m^(1/3))",
         "title": "Manning Land"
      },
      "manning_sea": {
         "anyOf": [
            {
               "exclusiveMaximum": 0.5,
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.02,
         "description": "Manning's n coefficient for sea areas, if no other manning options specified (s/m^(1/3))",
         "title": "Manning Sea"
      },
      "rgh_lev_land": {
         "anyOf": [
            {
               "exclusiveMaximum": 9999,
               "exclusiveMinimum": -9999,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Elevation level to distinguish land and sea roughness (meters above reference level)",
         "title": "Rgh Lev Land"
      },
      "zsini": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Initial water level in entire domain - where above bed level (meters)",
         "title": "Zsini"
      },
      "qinf": {
         "anyOf": [
            {
               "exclusiveMaximum": 20.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Infiltration rate, spatially uniform and constant in time (mm/hr)",
         "title": "Qinf"
      },
      "dtmax": {
         "anyOf": [
            {
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Maximum allowed internal timestep (seconds)",
         "examples": 1000.0,
         "title": "Dtmax"
      },
      "huthresh": {
         "default": 0.01,
         "description": "Threshold water depth (meters)",
         "exclusiveMaximum": 1.0,
         "exclusiveMinimum": 0.0,
         "title": "Huthresh",
         "type": "number"
      },
      "rhoa": {
         "anyOf": [
            {
               "exclusiveMaximum": 1.5,
               "exclusiveMinimum": 1.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Air density (kg/m^3)",
         "examples": 1.15,
         "title": "Rhoa"
      },
      "rhow": {
         "anyOf": [
            {
               "exclusiveMaximum": 1100.0,
               "exclusiveMinimum": 1000.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Water density (kg/m^3)",
         "examples": 1024.0,
         "title": "Rhow"
      },
      "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 file format for spatial map file (net or asc or bin)",
         "examples": "net",
         "title": "Outputtype Map"
      },
      "outputtype_his": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Output file format for observation his file (net or asc or bin)",
         "examples": "net",
         "title": "Outputtype His"
      },
      "nc_deflate_level": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Netcdf deflate level (-))",
         "examples": 2,
         "title": "Nc Deflate Level"
      },
      "bndtype": {
         "anyOf": [
            {
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Boundary type, only bndtype=1 is supported currently (-)",
         "ls": 1,
         "title": "Bndtype"
      },
      "advection": {
         "default": 1,
         "description": "Enable advection (1: yes, 0: no)",
         "maximum": 1,
         "minimum": 0,
         "title": "Advection",
         "type": "integer"
      },
      "nfreqsig": {
         "anyOf": [
            {
               "maximum": 500,
               "minimum": 1,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wave maker number of frequency bins IG spectrum (-)",
         "examples": 100,
         "title": "Nfreqsig"
      },
      "freqminig": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Minimum frequency wave maker IG spectrum (Hz)",
         "examples": 0.001,
         "title": "Freqminig"
      },
      "freqmaxig": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Maximum frequency wave maker IG spectrum (Hz)",
         "examples": 0.1,
         "title": "Freqmaxig"
      },
      "latitude": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Latitude of the grid center (degrees), needed for Coriolis term for projected coordinate systems",
         "title": "Latitude"
      },
      "pavbnd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Atmospheric pressure at boundary (Pa)",
         "examples": 101300.0,
         "title": "Pavbnd"
      },
      "gapres": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Background atmospheric pressure used by spiderweb pressure conversion (Pa)",
         "examples": 101300.0,
         "title": "Gapres"
      },
      "baro": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Enable atmospheric pressure term (1: yes, 0: no)",
         "title": "Baro"
      },
      "utmzone": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "UTM zone for spatial reference (-)",
         "title": "Utmzone"
      },
      "epsg": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "EPSG code for spatial reference system",
         "title": "Epsg"
      },
      "advlim": {
         "anyOf": [
            {
               "maximum": 9999.9,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Maximum value of the advection term in the momentum equation (-)",
         "examples": 1.0,
         "title": "Advlim"
      },
      "slopelim": {
         "anyOf": [
            {
               "maximum": 9999.9,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": ">currently not used< (-)",
         "examples": 9999.9,
         "title": "Slopelim"
      },
      "qinf_zmin": {
         "anyOf": [
            {
               "maximum": 100,
               "minimum": -100,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Minimum elevation level above for what cells the spatially uniform, constant in time infiltration rate 'qinf' is added (meters above reference)",
         "examples": 1.0,
         "title": "Qinf Zmin"
      },
      "btfilter": {
         "anyOf": [
            {
               "maximum": 3600.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Water level boundary timeseries filtering period (seconds)",
         "examples": 60.0,
         "title": "Btfilter"
      },
      "sfacinf": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Curve Number infiltration initial abstraction or the amount of water before runoff, such as infiltration, or rainfall interception by vegetation.",
         "examples": 0.2,
         "title": "Sfacinf"
      },
      "crsgeo": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Geographical coordinate system flag (1: yes, 0: no)",
         "examples": 1,
         "title": "Crsgeo"
      },
      "coriolis": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Ability to turn off Coriolis term, only if crsgeo = True and latitude specified for projected CRS (1: on, 0: off)",
         "title": "Coriolis"
      },
      "amprblock": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Use data in ampr file as block rather than linear interpolation (1: yes, 0: no)",
         "examples": 1,
         "title": "Amprblock"
      },
      "spwmergefrac": {
         "anyOf": [
            {
               "exclusiveMaximum": 1.0,
               "exclusiveMinimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Spiderweb merge factor with background wind and pressure (-)",
         "examples": 0.5,
         "title": "Spwmergefrac"
      },
      "usespwprecip": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Ability to use rainfall from spiderweb  (1: on, 0: off)",
         "examples": 1,
         "title": "Usespwprecip"
      },
      "global": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Ability to make a global spherical SFINCS model that wraps 'over the edge' (1: on, 0: off)",
         "title": "Global"
      },
      "nuvisc": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Viscosity coefficient 'per meter of grid cell length', used if 'viscosity=1' and multiplied internally with the grid cell size (per quadtree level in quadtree mesh mode) (-)",
         "examples": 0.01,
         "title": "Nuvisc"
      },
      "viscosity": {
         "default": 1,
         "description": "Enable viscosity term (1: yes, 0: no)",
         "maximum": 1,
         "minimum": 0,
         "title": "Viscosity",
         "type": "integer"
      },
      "spinup_meteo": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to also apply spinup to the meteo forcing (1: on, 0: off)",
         "examples": 1,
         "title": "Spinup Meteo"
      },
      "waveage": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Determine Cd with wave age based on LGX method (-)",
         "examples": -999.0,
         "title": "Waveage"
      },
      "snapwave": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on the determination of spectral wave conditions and include incident wave-induced setup through the coupled internal SnapWave solver (1: on, 0: off)",
         "examples": 0,
         "title": "Snapwave"
      },
      "wmtfilter": {
         "anyOf": [
            {
               "maximum": 3600.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filtering duration for wave maker to determine mean water level component (-)",
         "examples": 600.0,
         "title": "Wmtfilter"
      },
      "wmfred": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Filtering variable in wave maker to determine mean water level component (-)",
         "examples": 0.99,
         "title": "Wmfred"
      },
      "wmsignal": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker options ('spectrum' or 'mon(ochromatic)')",
         "examples": "spectrum",
         "title": "Wmsignal"
      },
      "advection_scheme": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wavemaker options ('upw1' or 'original')",
         "examples": "upw1",
         "title": "Advection Scheme"
      },
      "btrelax": {
         "anyOf": [
            {
               "maximum": 10800.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Internal parameter of SFINCS for relaxation in uvmean (s)",
         "examples": 3600.0,
         "title": "Btrelax"
      },
      "wiggle_suppression": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on the wiggle surpression (1: on, 0: off)",
         "examples": 1,
         "title": "Wiggle Suppression"
      },
      "wiggle_factor": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wiggle suppresion factor (-)",
         "examples": 0.1,
         "title": "Wiggle Factor"
      },
      "wiggle_threshold": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wiggle suppresion minimum depth threshold (-)",
         "examples": 0.1,
         "title": "Wiggle Threshold"
      },
      "friction2d": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on the 2D friction component in the momentum equation (1: on, 0: off)",
         "title": "Friction2D"
      },
      "advection_mask": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on the advection_mask(1: on, 0: off)",
         "examples": 1,
         "title": "Advection Mask"
      },
      "use_bcafile": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on the use of the tidal boundary condition file (1: on, 0: off)",
         "examples": 1,
         "title": "Use Bcafile"
      },
      "qtrfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the quadtree file",
         "examples": "sfincs.nc",
         "title": "Qtrfile"
      },
      "depfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the depth file",
         "title": "Depfile"
      },
      "inifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the initial water level condition file",
         "title": "Inifile"
      },
      "rstfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the restart file",
         "title": "Rstfile"
      },
      "ncinifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf initial water level condition file",
         "title": "Ncinifile"
      },
      "mskfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the mask file",
         "title": "Mskfile"
      },
      "indexfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the index file",
         "title": "Indexfile"
      },
      "sbgfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the subgrid file",
         "title": "Sbgfile"
      },
      "thdfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the thin dam structure file",
         "title": "Thdfile"
      },
      "weirfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the weir structure file",
         "title": "Weirfile"
      },
      "manningfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Manning's n file",
         "title": "Manningfile"
      },
      "drnfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the drainage structure file",
         "title": "Drnfile"
      },
      "volfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the storage volume file",
         "title": "Volfile"
      },
      "bndfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the water level boundary points file",
         "title": "Bndfile"
      },
      "bzsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the water level time-series file",
         "title": "Bzsfile"
      },
      "bcafile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the tidal boundary component file",
         "title": "Bcafile"
      },
      "bzifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the individual wave water level time-series file",
         "title": "Bzifile"
      },
      "bdrfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the downstream river boundary input file",
         "title": "Bdrfile"
      },
      "wfpfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wavemaker location input points file",
         "title": "Wfpfile"
      },
      "whifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wavemaker IG wave height input file",
         "title": "Whifile"
      },
      "wtifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wavemaker IG wave period input file",
         "title": "Wtifile"
      },
      "wstfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wavemaker setup input file",
         "title": "Wstfile"
      },
      "srcfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the discharge input points file",
         "title": "Srcfile"
      },
      "disfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the discharge input time-series file",
         "title": "Disfile"
      },
      "spwfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the spiderweb tropical cyclone file",
         "title": "Spwfile"
      },
      "wndfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the spatially uniform wind file",
         "title": "Wndfile"
      },
      "prcfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the spatially uniform precipitation file",
         "title": "Prcfile"
      },
      "precipfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "LEGACY OPTION - Name of the spatially uniform precipitation file > now use: prcfile",
         "title": "Precipfile"
      },
      "amufile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the u-component of the wind file",
         "title": "Amufile"
      },
      "amvfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the v-component of the wind file",
         "title": "Amvfile"
      },
      "ampfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the atmospheric pressure file",
         "title": "Ampfile"
      },
      "amprfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the precipitation file",
         "title": "Amprfile"
      },
      "z0lfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wind reduction over land input file",
         "title": "Z0Lfile"
      },
      "wvmfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the wave maker input points file",
         "title": "Wvmfile"
      },
      "qinffile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the spatially-uniform, constant in time infiltration file",
         "title": "Qinffile"
      },
      "scsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Curve Number infiltration method A - maximum soil moisture storage capacity file",
         "title": "Scsfile"
      },
      "smaxfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Curve Number infiltration method B - maximum soil moisture storage capacity file",
         "title": "Smaxfile"
      },
      "sefffile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Curve Number infiltration method B - initial soil moisture storage capacity file",
         "title": "Sefffile"
      },
      "psifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Green and Ampt infiltration  method - suction head file",
         "title": "Psifile"
      },
      "sigmafile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Green and Ampt infiltration method - maximum moisture deficit file",
         "title": "Sigmafile"
      },
      "ksfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Green and Ampt infiltration method - saturated hydraulic conductivity file",
         "title": "Ksfile"
      },
      "f0file": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Horton infiltration method - Maximum (Initial) Infiltration Capacity file",
         "title": "F0File"
      },
      "fcfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Horton infiltration method - Minimum (Asymptotic) Infiltration Rate file",
         "title": "Fcfile"
      },
      "kdfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Horton infiltration method - empirical constant (hr-1) of decay file",
         "title": "Kdfile"
      },
      "horton_kr_kd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Horton infiltration recovery vs decay ration (-)",
         "title": "Horton Kr Kd"
      },
      "netbndbzsbzifile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type water level input file",
         "title": "Netbndbzsbzifile"
      },
      "netsrcdisfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type discharge input file",
         "title": "Netsrcdisfile"
      },
      "netamuamvfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type wind amu-amv input file",
         "title": "Netamuamvfile"
      },
      "netamprfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type precipitation input file",
         "title": "Netamprfile"
      },
      "netampfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type atmoshperic pressure input file",
         "title": "Netampfile"
      },
      "netspwfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the Netcdf type spiderweb tropical cyclone input file",
         "title": "Netspwfile"
      },
      "obsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the observation points input file",
         "title": "Obsfile"
      },
      "crsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the cross-section lines input file",
         "title": "Crsfile"
      },
      "storevelmax": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write maximum velocity output to netcdf map output (1: yes, 0: no)",
         "title": "Storevelmax"
      },
      "storefluxmax": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write maximum flux output to netcdf map output (1: yes, 0: no)",
         "title": "Storefluxmax"
      },
      "storevel": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write instantaneous velocity output to netcdf map output (1: yes, 0: no)",
         "title": "Storevel"
      },
      "storecumprcp": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write cumulative precipitation output to netcdf map output (1: yes, 0: no)",
         "title": "Storecumprcp"
      },
      "storetwet": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write 'twet' time wet output to netcdf map output (1: yes, 0: no)",
         "examples": 0,
         "title": "Storetwet"
      },
      "storehsubgrid": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write -approximated- depth output for Subgrid models to netcdf map output (1: yes, 0: no)",
         "examples": 0,
         "title": "Storehsubgrid"
      },
      "twet_threshold": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Time wet 'twet' minimum depth threshold (m)",
         "examples": 0.01,
         "title": "Twet Threshold"
      },
      "store_tsunami_arrival_time": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write tsunami arrival time output to netcdf map output (1: yes, 0: no)",
         "title": "Store Tsunami Arrival Time"
      },
      "tsunami_arrival_threshold": {
         "anyOf": [
            {
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Tsunami arrival time minimum depth threshold (m)",
         "title": "Tsunami Arrival Threshold"
      },
      "storeqdrain": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write discharge through drainage structure output to netcdf map output (1: yes, 0: no)",
         "title": "Storeqdrain"
      },
      "storezvolume": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write storage volume output to netcdf map output (1: yes, 0: no)",
         "title": "Storezvolume"
      },
      "debug": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to turn on debug mode and write every timestep to netcdf map output (1: yes, 0: no)",
         "examples": 0,
         "title": "Debug"
      },
      "storemeteo": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write meteo output to netcdf map output (1: yes, 0: no)",
         "title": "Storemeteo"
      },
      "storemaxwind": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to write maximum wind speed output to netcdf map output (1: yes, 0: no)",
         "title": "Storemaxwind"
      },
      "storefw": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write wave forces to netcdf map output (1: yes, 0: no)",
         "title": "Storefw"
      },
      "storewavdir": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write wave direction to netcdf map output (1: yes, 0: no)",
         "title": "Storewavdir"
      },
      "regular_output_on_mesh": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option to write regular grid model on quadtree mesh type output in netcdf map output (1: yes, 0: no)",
         "title": "Regular Output On Mesh"
      },
      "snapwave_wind": {
         "anyOf": [
            {
               "maximum": 1,
               "minimum": 0,
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Option in integrated SnapWave solver to turn on wind growth process (1: yes, 0: no)",
         "title": "Snapwave Wind"
      },
      "snapwave_bndfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the SnapWave boundary points file",
         "title": "Snapwave Bndfile"
      },
      "snapwave_bhsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the SnapWave wave height time-series file",
         "title": "Snapwave Bhsfile"
      },
      "snapwave_btpfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the SnapWave wave period time-series file",
         "title": "Snapwave Btpfile"
      },
      "snapwave_bwdfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the SnapWave wave direction time-series file",
         "title": "Snapwave Bwdfile"
      },
      "snapwave_bdsfile": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Name of the SnapWave wave spreading time-series file",
         "title": "Snapwave Bdsfile"
      },
      "cdnrb": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Number of wind speed ranges for drag coefficient",
         "examples": 3,
         "title": "Cdnrb"
      },
      "cdwnd": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Wind speed ranges for drag coefficient (m/s)",
         "examples": [
            0.0,
            28.0,
            50.0
         ],
         "title": "Cdwnd"
      },
      "cdval": {
         "anyOf": [
            {
               "items": {
                  "type": "number"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Drag coefficient values corresponding to cdwnd",
         "examples": [
            0.001,
            0.0025,
            0.0015
         ],
         "title": "Cdval"
      }
   },
   "additionalProperties": true
}

Config:

extra: str = allow

Fields:

advection (int)
advection_mask (int | None)
advection_scheme (str | None)
advlim (float | None)
alpha (float)
ampfile (str | None)
amprblock (int | None)
amprfile (str | None)
amufile (str | None)
amvfile (str | None)
baro (int | None)
bcafile (str | None)
bdrfile (str | None)
bndfile (str | None)
bndtype (int | None)
btfilter (float | None)
btrelax (float | None)
bzifile (str | None)
bzsfile (str | None)
cdnrb (int | None)
cdval (List[float] | None)
cdwnd (List[float] | None)
coriolis (int | None)
crsfile (str | None)
crsgeo (int | None)
debug (int | None)
depfile (str | None)
disfile (str | None)
drnfile (str | None)
dthisout (float)
dtmapout (float)
dtmax (float | None)
dtmaxout (float)
dtrstout (float | None)
dtwave (float | None)
dtwnd (float | None)
dx (float | None)
dy (float | None)
epsg (int | None)
f0file (str | None)
fcfile (str | None)
freqmaxig (float | None)
freqminig (float | None)
friction2d (int | None)
gapres (float | None)
global_ (int | None)
hmin_cfl (float | None)
horton_kr_kd (float | None)
huthresh (float)
indexfile (str | None)
inifile (str | None)
inputformat (str)
kdfile (str | None)
ksfile (str | None)
latitude (float | None)
manning (float | None)
manning_land (float | None)
manning_sea (float | None)
manningfile (str | None)
mmax (int | None)
mskfile (str | None)
nc_deflate_level (int | None)
ncinifile (str | None)
netampfile (str | None)
netamprfile (str | None)
netamuamvfile (str | None)
netbndbzsbzifile (str | None)
netspwfile (str | None)
netsrcdisfile (str | None)
nfreqsig (int | None)
nmax (int | None)
nuvisc (float | None)
obsfile (str | None)
outputformat (str)
outputtype_his (str | None)
outputtype_map (str | None)
pavbnd (float | None)
prcfile (str | None)
precipfile (str | None)
psifile (str | None)
qinf (float | None)
qinf_zmin (float | None)
qinffile (str | None)
qtrfile (str | None)
regular_output_on_mesh (int | None)
rgh_lev_land (float | None)
rhoa (float | None)
rhow (float | None)
rotation (float | None)
rstfile (str | None)
sbgfile (str | None)
scsfile (str | None)
sefffile (str | None)
sfacinf (float | None)
sigmafile (str | None)
slopelim (float | None)
smaxfile (str | None)
snapwave (int | None)
snapwave_bdsfile (str | None)
snapwave_bhsfile (str | None)
snapwave_bndfile (str | None)
snapwave_btpfile (str | None)
snapwave_bwdfile (str | None)
snapwave_wind (int | None)
spinup_meteo (int | None)
spwfile (str | None)
spwmergefrac (float | None)
srcfile (str | None)
store_tsunami_arrival_time (int | None)
storecumprcp (int | None)
storefluxmax (int | None)
storefw (int | None)
storehsubgrid (int | None)
storemaxwind (int | None)
storemeteo (int | None)
storeqdrain (int | None)
storetwet (int | None)
storevel (int | None)
storevelmax (int | None)
storewavdir (int | None)
storezvolume (int | None)
t0out (float | None)
t1out (float | None)
thdfile (str | None)
theta (float)
tref (datetime.datetime)
trstout (float | None)
tspinup (float | None)
tstart (datetime.datetime)
tstop (datetime.datetime)
tsunami_arrival_threshold (float | None)
twet_threshold (float | None)
use_bcafile (int | None)
usespwprecip (int | None)
utmzone (str | None)
viscosity (int)
volfile (str | None)
waveage (float | None)
weirfile (str | None)
wfpfile (str | None)
whifile (str | None)
wiggle_factor (float | None)
wiggle_suppression (int | None)
wiggle_threshold (float | None)
wmfred (float | None)
wmsignal (str | None)
wmtfilter (float | None)
wndfile (str | None)
wstfile (str | None)
wtifile (str | None)
wvmfile (str | None)
x0 (float | None)
y0 (float | None)
z0lfile (str | None)
zsini (float | None)

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 | None = None#

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

Constraints:

ge = 0
le = 1

field advection_scheme: str | None = None#: Wavemaker options (‘upw1’ or ‘original’)

field advlim: float | None = None#

Maximum value of the advection term in the momentum equation (-)

Constraints:

ge = 0.0
le = 9999.9

field alpha: float = 0.5#

Numerical time step reduction for CFL-condition (-)

Constraints:

ge = 0.001
le = 1.0

field ampfile: str | None = None#: Name of the atmospheric pressure file

field amprblock: int | None = None#

Use data in ampr file as block rather than linear interpolation (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field amprfile: str | None = None#: Name of the precipitation file

field amufile: str | None = None#: Name of the u-component of the wind file

field amvfile: str | None = None#: Name of the v-component of the wind file

field baro: int | None = 1#: Enable atmospheric pressure term (1: yes, 0: no)

field bcafile: str | None = None#: Name of the tidal boundary component file

field bdrfile: str | None = None#: Name of the downstream river boundary input file

field bndfile: str | None = None#: Name of the water level boundary points file

field bndtype: int | None = None#

Boundary type, only bndtype=1 is supported currently (-)

Constraints:

ge = 1

field btfilter: float | None = None#

Water level boundary timeseries filtering period (seconds)

Constraints:

ge = 0.0
le = 3600.0

field btrelax: float | None = None#

Internal parameter of SFINCS for relaxation in uvmean (s)

Constraints:

ge = 0.0
le = 10800.0

field bzifile: str | None = None#: Name of the individual wave water level time-series file

field bzsfile: str | None = None#: Name of the water level time-series file

field cdnrb: int | None = None#: 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 | None = 1#: Ability to turn off Coriolis term, only if crsgeo = True and latitude specified for projected CRS (1: on, 0: off)

field crsfile: str | None = None#: Name of the cross-section lines input file

field crsgeo: int | None = None#: Geographical coordinate system flag (1: yes, 0: no)

field debug: int | None = None#

Option to turn on debug mode and write every timestep to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field depfile: str | None = None#: Name of the depth file

field disfile: str | None = None#: Name of the discharge input time-series file

field drnfile: str | None = None#: Name of the drainage structure file

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

field dtmapout: float = 3600.0#

Spatial map output interval (seconds)

Constraints:

ge = 0.0

field dtmax: float | None = None#

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 | None = None#

Restart file output interval (seconds)

Constraints:

ge = 0.0

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

field dtwnd: float | None = None#: 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#: Name of the Horton infiltration method - Maximum (Initial) Infiltration Capacity file

field fcfile: str | None = None#: Name of the Horton infiltration method - Minimum (Asymptotic) Infiltration Rate file

field freqmaxig: float | None = None#

Maximum frequency wave maker IG spectrum (Hz)

Constraints:

ge = 0.0
le = 1.0

field freqminig: float | None = None#

Minimum frequency wave maker IG spectrum (Hz)

Constraints:

ge = 0.0
le = 1.0

field friction2d: int | None = None#

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

Constraints:

ge = 0
le = 1

field gapres: float | None = None#: Background atmospheric pressure used by spiderweb pressure conversion (Pa)

field global_: int | None = None (alias 'global')#

Ability to make a global spherical SFINCS model that wraps ‘over the edge’ (1: on, 0: off)

Constraints:

ge = 0
le = 1

field hmin_cfl: float | None = None#

Minimum water depth for cfl condition in max timestep determination (meters)

Constraints:

gt = 0.0

field horton_kr_kd: float | None = None#: Horton infiltration recovery vs decay ration (-)

field huthresh: float = 0.01#

Threshold water depth (meters)

Constraints:

gt = 0.0
lt = 1.0

field indexfile: str | None = None#: Name of the index file

field inifile: str | None = None#: Name of the initial water level condition file

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

field kdfile: str | None = None#: Name of the Horton infiltration method - empirical constant (hr-1) of decay file

field ksfile: str | None = None#: Name of the Green and Ampt infiltration method - saturated hydraulic conductivity file

field latitude: float | None = 0.0#: Latitude of the grid center (degrees), needed for Coriolis term for projected coordinate systems

field manning: float | None = None#

Manning’s n coefficient for spatially uniform roughness, if no other manning options specified (s/m^(1/3))

Constraints:

gt = 0.0
lt = 0.5

field manning_land: float | None = 0.04#

Manning’s n coefficient for land areas, if no other manning options specified (s/m^(1/3))

Constraints:

gt = 0.0
lt = 0.5

field manning_sea: float | None = 0.02#

Manning’s n coefficient for sea areas, if no other manning options specified (s/m^(1/3))

Constraints:

gt = 0.0
lt = 0.5

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

field mmax: int | None = None#

Number of grid cells in x-direction

Constraints:

ge = 1

field mskfile: str | None = None#: Name of the mask file

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

field ncinifile: str | None = None#: Name of the Netcdf initial water level condition file

field netampfile: str | None = None#: Name of the Netcdf type atmoshperic pressure input file

field netamprfile: str | None = None#: Name of the Netcdf type precipitation input file

field netamuamvfile: str | None = None#: Name of the Netcdf type wind amu-amv input file

field netbndbzsbzifile: str | None = None#: Name of the Netcdf type water level input file

field netspwfile: str | None = None#: Name of the Netcdf type spiderweb tropical cyclone input file

field netsrcdisfile: str | None = None#: Name of the Netcdf type discharge input file

field nfreqsig: int | None = None#

Wave maker number of frequency bins IG spectrum (-)

Constraints:

ge = 1
le = 500

field nmax: int | None = None#

Number of grid cells in y-direction

Constraints:

ge = 1

field nuvisc: float | None = None#

Viscosity coefficient ‘per meter of grid cell length’, used if ‘viscosity=1’ and multiplied internally with the grid cell size (per quadtree level in quadtree mesh mode) (-)

Constraints:

ge = 0.0

field obsfile: str | None = None#: Name of the observation points input file

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

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

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

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

field prcfile: str | None = None#: Name of the spatially uniform precipitation file

field precipfile: str | None = None#: LEGACY OPTION - Name of the spatially uniform precipitation file > now use: prcfile

field psifile: str | None = None#: Name of the Green and Ampt infiltration method - suction head file

field qinf: float | None = 0.0#

Infiltration rate, spatially uniform and constant in time (mm/hr)

Constraints:

ge = 0.0
lt = 20.0

field qinf_zmin: float | None = None#

Minimum elevation level above for what cells the spatially uniform, constant in time infiltration rate ‘qinf’ is added (meters above reference)

Constraints:

ge = -100
le = 100

field qinffile: str | None = None#: Name of the spatially-uniform, constant in time infiltration file

field qtrfile: str | None = None#: Name of the quadtree file

field regular_output_on_mesh: int | None = None#

Option to write regular grid model on quadtree mesh type output in netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field rgh_lev_land: float | None = 0.0#

Elevation level to distinguish land and sea roughness (meters above reference level)

Constraints:

gt = -9999
lt = 9999

field rhoa: float | None = None#

Air density (kg/m^3)

Constraints:

gt = 1.0
lt = 1.5

field rhow: float | None = None#

Water density (kg/m^3)

Constraints:

gt = 1000.0
lt = 1100.0

field rotation: float | None = None#

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#: Name of the restart file

field sbgfile: str | None = None#: Name of the subgrid file

field scsfile: str | None = None#: Name of the Curve Number infiltration method A - maximum soil moisture storage capacity file

field sefffile: str | None = None#: Name of the Curve Number infiltration method B - initial soil moisture storage capacity file

field sfacinf: float | None = None#

Curve Number infiltration initial abstraction or the amount of water before runoff, such as infiltration, or rainfall interception by vegetation.

Constraints:

ge = 0.0
le = 1.0

field sigmafile: str | None = None#: Name of the Green and Ampt infiltration method - maximum moisture deficit file

field slopelim: float | None = None#

>currently not used< (-)

Constraints:

ge = 0.0
le = 9999.9

field smaxfile: str | None = None#: Name of the Curve Number infiltration method B - maximum soil moisture storage capacity file

field snapwave: int | None = None#

Option to turn on the determination of spectral wave conditions and include incident wave-induced setup through the coupled internal SnapWave solver (1: on, 0: off)

Constraints:

ge = 0
le = 1

field snapwave_bdsfile: str | None = None#: Name of the SnapWave wave spreading time-series file

field snapwave_bhsfile: str | None = None#: Name of the SnapWave wave height time-series file

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

field snapwave_btpfile: str | None = None#: Name of the SnapWave wave period time-series file

field snapwave_bwdfile: str | None = None#: Name of the SnapWave wave direction time-series file

field snapwave_wind: int | None = None#

Option in integrated SnapWave solver to turn on wind growth process (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field spinup_meteo: int | None = None#

Option to also apply spinup to the meteo forcing (1: on, 0: off)

Constraints:

ge = 0
le = 1

field spwfile: str | None = None#: Name of the spiderweb tropical cyclone file

field spwmergefrac: float | None = None#

Spiderweb merge factor with background wind and pressure (-)

Constraints:

gt = 0.0
lt = 1.0

field srcfile: str | None = None#: Name of the discharge input points file

field store_tsunami_arrival_time: int | None = None#

Option to write tsunami arrival time output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storecumprcp: int | None = 0#

Option to write cumulative precipitation output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storefluxmax: int | None = 0#

Option to write maximum flux output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storefw: int | None = None#

Option to write wave forces to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storehsubgrid: int | None = None#

Option to write -approximated- depth output for Subgrid models to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storemaxwind: int | None = 0#

Option to write maximum wind speed output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storemeteo: int | None = 0#

Option to write meteo output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storeqdrain: int | None = None#

Option to write discharge through drainage structure output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storetwet: int | None = None#

Option to write ‘twet’ time wet output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storevel: int | None = 0#

Option to write instantaneous velocity output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storevelmax: int | None = 0#

Option to write maximum velocity output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storewavdir: int | None = None#

Option to write wave direction to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field storezvolume: int | None = None#

Option to write storage volume output to netcdf map output (1: yes, 0: no)

Constraints:

ge = 0
le = 1

field t0out: float | None = None#: Output start time (seconds)

field t1out: float | None = None#: Output stop time (seconds)

field thdfile: str | None = None#: Name of the thin dam structure file

field theta: float = 1.0#

Numerical smoothing factor in momentum equation (-)

Constraints:

ge = 0.8
le = 1.0

field tref: datetime = datetime.datetime(2025, 11, 25, 0, 0)#: Reference time for simulation (datetime)

field trstout: float | None = None#: Restart file output after specific time (seconds)

field tspinup: float | None = None#

Duration of spinup period for boundary conditions after tstart (seconds)

Constraints:

ge = 0.0

field tstart: datetime = datetime.datetime(2025, 11, 25, 0, 0)#: Start time for the simulation (datetime)

field tstop: datetime = datetime.datetime(2025, 11, 26, 0, 0)#: Stop time for the simulation (datetime)

field tsunami_arrival_threshold: float | None = None#

Tsunami arrival time minimum depth threshold (m)

Constraints:

ge = 0.0

field twet_threshold: float | None = None#

Time wet ‘twet’ minimum depth threshold (m)

Constraints:

ge = 0.0

field use_bcafile: int | None = None#

Option to turn on the use of the tidal boundary condition file (1: on, 0: off)

Constraints:

ge = 0
le = 1

field usespwprecip: int | None = None#

Ability to use rainfall from spiderweb (1: on, 0: off)

Constraints:

ge = 0
le = 1

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

field viscosity: int = 1#

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

Constraints:

ge = 0
le = 1

field volfile: str | None = None#: Name of the storage volume file

field waveage: float | None = None#: Determine Cd with wave age based on LGX method (-)

field weirfile: str | None = None#: Name of the weir structure file

field wfpfile: str | None = None#: Name of the wavemaker location input points file

field whifile: str | None = None#: Name of the wavemaker IG wave height input file

field wiggle_factor: float | None = None#

Wiggle suppresion factor (-)

Constraints:

ge = 0.0

field wiggle_suppression: int | None = None#

Option to turn on the wiggle surpression (1: on, 0: off)

Constraints:

ge = 0
le = 1

field wiggle_threshold: float | None = None#

Wiggle suppresion minimum depth threshold (-)

Constraints:

ge = 0.0

field wmfred: float | None = None#: Filtering variable in wave maker to determine mean water level component (-)

field wmsignal: str | None = None#: Wavemaker options (‘spectrum’ or ‘mon(ochromatic)’)

field wmtfilter: float | None = None#

Filtering duration for wave maker to determine mean water level component (-)

Constraints:

ge = 0.0
le = 3600.0

field wndfile: str | None = None#: Name of the spatially uniform wind file

field wstfile: str | None = None#: Name of the wavemaker setup input file

field wtifile: str | None = None#: Name of the wavemaker IG wave period input file

field wvmfile: str | None = None#: Name of the 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#: Name of the wind reduction over land input file

field zsini: float | None = 0.0#: Initial water level in entire domain - where above bed level (meters)

class Config[source]#

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