rompy.schism.namelists.sediment.Sediment#

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

Show JSON schema
{
   "title": "Sediment",
   "type": "object",
   "properties": {
      "sed_core": {
         "anyOf": [
            {
               "$ref": "#/$defs/Sed_core"
            },
            {
               "type": "null"
            }
         ]
      },
      "sed_opt": {
         "anyOf": [
            {
               "$ref": "#/$defs/Sed_opt"
            },
            {
               "type": "null"
            }
         ]
      }
   },
   "$defs": {
      "Sed_core": {
         "additionalProperties": false,
         "properties": {
            "sd50": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [
                  "0.12d0",
                  "0.18d0",
                  "0.39d0",
                  "0.60d0",
                  "1.2d0"
               ],
               "description": "Median sediment grain diameter (D50) for each sediment tracer, specified in millimeters. This is a list of values corresponding to the number of sediment tracers (Ntracers).",
               "title": "Sd50"
            },
            "erate": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [
                  "1.6d-3",
                  "1.6d-3",
                  "1.6d-3",
                  "1.6d-3",
                  "1.6d-3"
               ],
               "description": "Surface erosion rate for each sediment tracer. The interpretation and units depend on the 'ierosion' parameter. If ierosion=0, the units are kg/m\u00b2/s. If ierosion=1, the units are s/m (as per M_E in Winterwerp et al. 2012, JGR, vol 117).",
               "title": "Erate"
            }
         },
         "title": "Sed_core",
         "type": "object"
      },
      "Sed_opt": {
         "additionalProperties": false,
         "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.0d0",
                  "2650.0d0",
                  "2650.0d0",
                  "2650.0d0",
                  "2650.0d0"
               ],
               "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.06d0",
                  "3.92d0",
                  "5.43d0",
                  "10.19d0",
                  "28.65d0"
               ],
               "description": "Particle settling velocity (mm/s) for each sediment class",
               "title": "Wsed"
            },
            "tau_ce": {
               "anyOf": [
                  {
                     "items": {},
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": [
                  "0.15d0",
                  "0.17d0",
                  "0.23d0",
                  "0.3d0",
                  "0.6d0"
               ],
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.4d0",
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.4d-4",
               "description": "",
               "title": "Kacc Hoe"
            },
            "kacc_dub": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.631d-4",
               "description": "",
               "title": "Kacc Dub"
            },
            "thresh_acc_opt": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 2,
               "description": "",
               "title": "Thresh Acc Opt"
            },
            "acrit": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.2d0",
               "description": "",
               "title": "Acrit"
            },
            "tau_option": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "description": "",
               "title": "Tau Option"
            },
            "tau_max": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "10.0d0",
               "description": "[Pa]",
               "title": "Tau Max"
            },
            "zstress": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.2d0",
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.0d0",
               "description": "only used if slope_formulation=4",
               "title": "Alpha Bs"
            },
            "alpha_bn": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.5d0",
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.d0",
               "description": "",
               "title": "Sed Morph Time"
            },
            "morph_fac": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.0d0",
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.0d0",
               "description": "",
               "title": "Bedload Coeff"
            },
            "cdb_min": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "1.d-6",
               "description": "",
               "title": "Cdb Min"
            },
            "cdb_max": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.01,
               "description": "",
               "title": "Cdb Max"
            },
            "actv_max": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.05d0",
               "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": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "10.0d-2",
               "description": "",
               "title": "Toplay Inithick"
            },
            "newlayer_thick": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "0.001d0",
               "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"
            }
         },
         "title": "Sed_opt",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:

field sed_core: Sed_core | None [Optional]#
Validated by:
  • __lowercase_property_keys__

field sed_opt: Sed_opt | None [Optional]#
Validated by:
  • __lowercase_property_keys__