rompy.schism.namelists.sediment.Sed_opt#

pydantic model rompy.schism.namelists.sediment.Sed_opt[source]#

Show JSON schema
{
   "title": "Sed_opt",
   "type": "object",
   "properties": {
      "isedtype": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            1,
            1,
            1,
            1,
            1
         ],
         "description": "Sediment type for each class. 0: MUD-like (suspension only), 1: SAND-like (suspension + bedload), 2: GRAVEL-like (not available)",
         "title": "Isedtype"
      },
      "srho": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            2650.0,
            2650.0,
            2650.0,
            2650.0,
            2650.0
         ],
         "description": "Sediment grain density (kg/m3) for each sediment class",
         "title": "Srho"
      },
      "comp_ws": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag to enable/disable computation of sediment settling velocity. 0: Disabled (user-defined), 1: Enabled (computed from SAND_SD50 and SAND_SRHO)",
         "title": "Comp Ws"
      },
      "comp_tauce": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag to enable/disable computation of sediment critical shear stress. 0: Disabled (user-defined), 1: Enabled (computed from SAND_SD50 and SAND_SRHO)",
         "title": "Comp Tauce"
      },
      "wsed": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            1.06,
            3.92,
            5.43,
            10.19,
            28.65
         ],
         "description": "Particle settling velocity (mm/s) for each sediment class",
         "title": "Wsed"
      },
      "tau_ce": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.15,
            0.17,
            0.23,
            0.3,
            0.6
         ],
         "description": "Critical shear stress for erosion (Pa) for each sediment class",
         "title": "Tau Ce"
      },
      "sed_debug": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Debug flag. 0: silent, 1: output variables to outputs/nonfatal_*",
         "title": "Sed Debug"
      },
      "ised_dump": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Dumping/dredging option. 0: no, 1: needs input sed_dump.in",
         "title": "Ised Dump"
      },
      "bedload": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Bedload transport formula. 0: Disabled, 1: van Rijn (2007), 3: Soulsby and Damgaard (2005), 4: Wu and Lin (2014)",
         "title": "Bedload"
      },
      "bedload_filter": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag to enable/disable diffusive filter for bedload fluxes. 0: Disabled, 1: Enabled",
         "title": "Bedload Filter"
      },
      "bedload_limiter": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag to enable/disable limiting of bedload flux components. 0: Disabled, 1: Enabled",
         "title": "Bedload Limiter"
      },
      "suspended_load": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Flag to enable/disable suspended load transport. 0: Disabled, 1: Enabled",
         "title": "Suspended Load"
      },
      "iasym": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Iasym"
      },
      "w_asym_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.4,
         "description": "",
         "title": "W Asym Max"
      },
      "elfrink_filter": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Elfrink Filter"
      },
      "ech_uorb": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 200,
         "description": "",
         "title": "Ech Uorb"
      },
      "bedload_acc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Bedload Acc"
      },
      "bedload_acc_filter": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Bedload Acc Filter"
      },
      "kacc_hoe": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.00014,
         "description": "",
         "title": "Kacc Hoe"
      },
      "kacc_dub": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 6.31e-05,
         "description": "",
         "title": "Kacc Dub"
      },
      "thresh_acc_opt": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "",
         "title": "Thresh Acc Opt"
      },
      "acrit": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "",
         "title": "Acrit"
      },
      "tau_option": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Tau Option"
      },
      "tau_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 10.0,
         "description": "[Pa]",
         "title": "Tau Max"
      },
      "zstress": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "[m]; only used if tau_option/=1",
         "title": "Zstress"
      },
      "ierosion": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ierosion"
      },
      "slope_formulation": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 4,
         "description": "",
         "title": "Slope Formulation"
      },
      "alpha_bs": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "only used if slope_formulation=4",
         "title": "Alpha Bs"
      },
      "alpha_bn": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.5,
         "description": "only used if slope_formulation=4",
         "title": "Alpha Bn"
      },
      "ised_bc_bot": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Ised Bc Bot"
      },
      "alphd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "",
         "title": "Alphd"
      },
      "refht": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.75,
         "description": "suggested value: 0.75;",
         "title": "Refht"
      },
      "tbp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 100.0,
         "description": "suggested value: 100;",
         "title": "Tbp"
      },
      "im_pick_up": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 4,
         "description": "",
         "title": "Im Pick Up"
      },
      "sed_morph": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Sed Morph"
      },
      "sed_morph_time": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "",
         "title": "Sed Morph Time"
      },
      "morph_fac": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "for all classes",
         "title": "Morph Fac"
      },
      "drag_formulation": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Drag Formulation"
      },
      "ddensed": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ddensed"
      },
      "bedforms_rough": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Bedforms Rough"
      },
      "iwave_ripple": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Iwave Ripple"
      },
      "irough_bdld": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Irough Bdld"
      },
      "slope_avalanching": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Slope Avalanching"
      },
      "dry_slope_cr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "",
         "title": "Dry Slope Cr"
      },
      "wet_slope_cr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.3,
         "description": "",
         "title": "Wet Slope Cr"
      },
      "bedmass_filter": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Bedmass Filter"
      },
      "bedmass_threshold": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.025,
         "description": "",
         "title": "Bedmass Threshold"
      },
      "bdldiffu": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "",
         "title": "Bdldiffu"
      },
      "bedload_coeff": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "",
         "title": "Bedload Coeff"
      },
      "cdb_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-06,
         "description": "",
         "title": "Cdb Min"
      },
      "cdb_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.01,
         "description": "",
         "title": "Cdb Max"
      },
      "actv_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.05,
         "description": "",
         "title": "Actv Max"
      },
      "nbed": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Nbed"
      },
      "sedlay_ini_opt": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Sedlay Ini Opt"
      },
      "toplay_inithick": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "",
         "title": "Toplay Inithick"
      },
      "newlayer_thick": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.001,
         "description": "",
         "title": "Newlayer Thick"
      },
      "imeth_bed_evol": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "",
         "title": "Imeth Bed Evol"
      },
      "poro_option": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Poro Option"
      },
      "porosity": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.4,
         "description": "",
         "title": "Porosity"
      },
      "awooster": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.42,
         "description": "",
         "title": "Awooster"
      },
      "bwooster": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": -0.458,
         "description": "",
         "title": "Bwooster"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field acrit: float | None = 0.2#
Validated by:
field actv_max: float | None = 0.05#
Validated by:
field alpha_bn: float | None = 1.5#

only used if slope_formulation=4

Validated by:
field alpha_bs: float | None = 1.0#

only used if slope_formulation=4

Validated by:
field alphd: float | None = 1.0#
Validated by:
field awooster: float | None = 0.42#
Validated by:
field bdldiffu: float | None = 0.5#
Validated by:
field bedforms_rough: int | None = 0#
Validated by:
field bedload: int | None = 1#

Bedload transport formula. 0: Disabled, 1: van Rijn (2007), 3: Soulsby and Damgaard (2005), 4: Wu and Lin (2014)

Validated by:
field bedload_acc: int | None = 0#
Validated by:
field bedload_acc_filter: int | None = 0#
Validated by:
field bedload_coeff: float | None = 1.0#
Validated by:
field bedload_filter: int | None = 0#

Flag to enable/disable diffusive filter for bedload fluxes. 0: Disabled, 1: Enabled

Validated by:
field bedload_limiter: int | None = 0#

Flag to enable/disable limiting of bedload flux components. 0: Disabled, 1: Enabled

Validated by:
field bedmass_filter: int | None = 0#
Validated by:
field bedmass_threshold: float | None = 0.025#
Validated by:
field bwooster: float | None = -0.458#
Validated by:
field cdb_max: float | None = 0.01#
Validated by:
field cdb_min: float | None = 1e-06#
Validated by:
field comp_tauce: int | None = 0#

Flag to enable/disable computation of sediment critical shear stress. 0: Disabled (user-defined), 1: Enabled (computed from SAND_SD50 and SAND_SRHO)

Validated by:
field comp_ws: int | None = 0#

Flag to enable/disable computation of sediment settling velocity. 0: Disabled (user-defined), 1: Enabled (computed from SAND_SD50 and SAND_SRHO)

Validated by:
field ddensed: int | None = 0#
Validated by:
field drag_formulation: int | None = 1#
Validated by:
field dry_slope_cr: float | None = 1.0#
Validated by:
field ech_uorb: int | None = 200#
Validated by:
field elfrink_filter: int | None = 0#
Validated by:
field iasym: int | None = 0#
Validated by:
field ierosion: int | None = 0#
Validated by:
field im_pick_up: int | None = 4#
Validated by:
field imeth_bed_evol: int | None = 2#
Validated by:
field irough_bdld: int | None = 1#
Validated by:
field ised_bc_bot: int | None = 1#
Validated by:
field ised_dump: int | None = 0#

Dumping/dredging option. 0: no, 1: needs input sed_dump.in

Validated by:
field isedtype: list | None = [1, 1, 1, 1, 1]#

Sediment type for each class. 0: MUD-like (suspension only), 1: SAND-like (suspension + bedload), 2: GRAVEL-like (not available)

Validated by:
field iwave_ripple: int | None = 1#
Validated by:
field kacc_dub: float | None = 6.31e-05#
Validated by:
field kacc_hoe: float | None = 0.00014#
Validated by:
field morph_fac: float | None = 1.0#

for all classes

Validated by:
field nbed: int | None = 1#
Validated by:
field newlayer_thick: float | None = 0.001#
Validated by:
field poro_option: int | None = 1#
Validated by:
field porosity: float | None = 0.4#
Validated by:
field refht: float | None = 0.75#

suggested value: 0.75;

Validated by:
field sed_debug: int | None = 0#

Debug flag. 0: silent, 1: output variables to outputs/nonfatal_*

Validated by:
field sed_morph: int | None = 0#
Validated by:
field sed_morph_time: float | None = 1.0#
Validated by:
field sedlay_ini_opt: int | None = 0#
Validated by:
field slope_avalanching: int | None = 1#
Validated by:
field slope_formulation: int | None = 4#
Validated by:
field srho: list | None = [2650.0, 2650.0, 2650.0, 2650.0, 2650.0]#

Sediment grain density (kg/m3) for each sediment class

Validated by:
field suspended_load: int | None = 1#

Flag to enable/disable suspended load transport. 0: Disabled, 1: Enabled

Validated by:
field tau_ce: list | None = [0.15, 0.17, 0.23, 0.3, 0.6]#

Critical shear stress for erosion (Pa) for each sediment class

Validated by:
field tau_max: float | None = 10.0#

[Pa]

Validated by:
field tau_option: int | None = 1#
Validated by:
field tbp: float | None = 100.0#

suggested value: 100;

Validated by:
field thresh_acc_opt: int | None = 2#
Validated by:
field toplay_inithick: float | None = 0.1#
Validated by:
field w_asym_max: float | None = 0.4#
Validated by:
field wet_slope_cr: float | None = 0.3#
Validated by:
field wsed: list | None = [1.06, 3.92, 5.43, 10.19, 28.65]#

Particle settling velocity (mm/s) for each sediment class

Validated by:
field zstress: float | None = 0.2#

[m]; only used if tau_option/=1

Validated by:
validator check_tau_ce_comp_tauce  »  all fields[source]#
validator check_wsed_comp_ws  »  all fields[source]#
validator validate_bedload  »  bedload[source]#
validator validate_bedload_filter  »  bedload_filter[source]#
validator validate_bedload_limiter  »  bedload_limiter[source]#
validator validate_comp_tauce  »  comp_tauce[source]#
validator validate_comp_ws  »  comp_ws[source]#
validator validate_ised_dump  »  ised_dump[source]#
validator validate_isedtype  »  isedtype[source]#
validator validate_sed_debug  »  sed_debug[source]#
validator validate_srho  »  srho[source]#
validator validate_suspended_load  »  suspended_load[source]#
validator validate_tau_ce  »  tau_ce[source]#
validator validate_wsed  »  wsed[source]#