rompy.schism.namelists.param.Opt#

pydantic model rompy.schism.namelists.param.Opt[source]#

Show JSON schema
{
   "title": "Opt",
   "type": "object",
   "properties": {
      "ipre2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Pre-processing flag for diagnostic outputs. If non-zero, the code will output drag coefficients (Cdp) and stop.",
         "title": "Ipre2"
      },
      "itransport_only": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to solve only tracer transport. 0: off, 1 or 2: on. When 2, additional variables are needed.",
         "title": "Itransport Only"
      },
      "iloadtide": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option to add self-attracting and loading tide (SAL) into tidal potential. 0: off, 1: needs loadtide_[FREQ].gr3 inputs, 2 or 3: simple scaling for gravity approach.",
         "title": "Iloadtide"
      },
      "loadtide_coef": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "Coefficient for SAL scaling. Used only if iloadtide is 2 or 3.",
         "title": "Loadtide Coef"
      },
      "start_year": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2000,
         "description": "Starting year for the simulation.",
         "title": "Start Year"
      },
      "start_month": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Starting month for the simulation.",
         "title": "Start Month"
      },
      "start_day": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "int",
         "title": "Start Day"
      },
      "start_hour": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "double",
         "title": "Start Hour"
      },
      "utc_start": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 8,
         "description": "double",
         "title": "Utc Start"
      },
      "ics": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Coordinate option",
         "title": "Ics"
      },
      "ihot": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ihot"
      },
      "ieos_type": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ieos Type"
      },
      "ieos_pres": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "used only if ieos_type=0. 0: without pressure effects",
         "title": "Ieos Pres"
      },
      "eos_a": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": -0.1,
         "description": "needed if ieos_type=1; should be <=0",
         "title": "Eos A"
      },
      "eos_b": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1001.0,
         "description": "needed if ieos_type=1",
         "title": "Eos B"
      },
      "dramp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "ramp-up period in days for b.c. etc (no ramp-up if <=0)",
         "title": "Dramp"
      },
      "drampbc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "ramp-up period in days for baroclinic force",
         "title": "Drampbc"
      },
      "iupwind_mom": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Iupwind Mom"
      },
      "indvel": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Indvel"
      },
      "ihorcon": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ihorcon"
      },
      "hvis_coef0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.025,
         "description": "const. diffusion # if ihorcon/=0; <=0.025 for ihorcon=2, <=0.125 for ihorcon=1",
         "title": "Hvis Coef0"
      },
      "ishapiro": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "options",
         "title": "Ishapiro"
      },
      "niter_shap": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "needed if ishapiro/=0: # of iterations with Shapiro filter",
         "title": "Niter Shap"
      },
      "shapiro0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "needed only if ishapiro=1",
         "title": "Shapiro0"
      },
      "thetai": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.6,
         "description": "",
         "title": "Thetai"
      },
      "icou_elfe_wwm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Icou Elfe Wwm"
      },
      "nstep_wwm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "call WWM every this many time steps",
         "title": "Nstep Wwm"
      },
      "iwbl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "wave boundary layer formulation (used only if USE_WMM and",
         "title": "Iwbl"
      },
      "hmin_radstress": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "min. total water depth used only in radiation stress calculation [m]",
         "title": "Hmin Radstress"
      },
      "drampwafo": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "ramp-up period in days for the wave forces (no ramp-up if <=0)",
         "title": "Drampwafo"
      },
      "turbinj": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.15,
         "description": "% of depth-induced wave breaking energy injected in turbulence",
         "title": "Turbinj"
      },
      "turbinjds": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "% of wave energy dissipated through whitecapping injected in turbulence",
         "title": "Turbinjds"
      },
      "alphaw": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "for itur=4 : scaling parameter for the surface roughness z0s = alphaw*Hm0.",
         "title": "Alphaw"
      },
      "fwvor_advxy_stokes": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "--> Stokes drift advection (xy), Coriolis",
         "title": "Fwvor Advxy Stokes"
      },
      "fwvor_advz_stokes": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "--> Stokes drift advection (z) , Coriolis",
         "title": "Fwvor Advz Stokes"
      },
      "fwvor_gradpress": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "--> Pressure term",
         "title": "Fwvor Gradpress"
      },
      "fwvor_breaking": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "--> Wave breaking",
         "title": "Fwvor Breaking"
      },
      "fwvor_streaming": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "--> Wave streaming (works with iwbl /= 0)",
         "title": "Fwvor Streaming"
      },
      "fwvor_wveg": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "--> Wave dissipation by vegetation acceleration term",
         "title": "Fwvor Wveg"
      },
      "fwvor_wveg_nl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "--> Non linear intrawave vegetation force (see Dean and Bender, 2006 or van Rooijen et al., 2016 for details)",
         "title": "Fwvor Wveg Nl"
      },
      "cur_wwm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Coupling current in WWM",
         "title": "Cur Wwm"
      },
      "wafo_obcramp": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Ramp on wave forces at open boundary (1: on / 0: off)",
         "title": "Wafo Obcramp"
      },
      "imm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Imm"
      },
      "ibdef": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "needed if imm=1; # of steps used in deformation",
         "title": "Ibdef"
      },
      "slam0": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -124,
         "description": "lon - not really used",
         "title": "Slam0"
      },
      "sfea0": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 45,
         "description": "lat",
         "title": "Sfea0"
      },
      "iunder_deep": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Iunder Deep"
      },
      "h1_bcc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 50.0,
         "description": "[m]",
         "title": "H1 Bcc"
      },
      "h2_bcc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 100.0,
         "description": "[m]; >h1_bcc",
         "title": "H2 Bcc"
      },
      "hw_depth": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1000000.0,
         "description": "threshold depth in [m]",
         "title": "Hw Depth"
      },
      "hw_ratio": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "ratio",
         "title": "Hw Ratio"
      },
      "ihydraulics": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ihydraulics"
      },
      "if_source": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "If Source"
      },
      "dramp_ss": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "needed if if_source/=0; ramp-up period in days for source/sinks (no ramp-up if <=0)",
         "title": "Dramp Ss"
      },
      "meth_sink": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "options to treat sinks @ dry elem",
         "title": "Meth Sink"
      },
      "lev_tr_source__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "T",
         "title": "Lev Tr Source  1"
      },
      "lev_tr_source__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "S",
         "title": "Lev Tr Source  2"
      },
      "lev_tr_source__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "GEN",
         "title": "Lev Tr Source  3"
      },
      "lev_tr_source__4": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "AGE: set -9999. in msource's AGE section",
         "title": "Lev Tr Source  4"
      },
      "lev_tr_source__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "SED3D",
         "title": "Lev Tr Source  5"
      },
      "lev_tr_source__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "EcoSim",
         "title": "Lev Tr Source  6"
      },
      "lev_tr_source__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "ICM",
         "title": "Lev Tr Source  7"
      },
      "lev_tr_source__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "CoSINE",
         "title": "Lev Tr Source  8"
      },
      "lev_tr_source__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "Feco",
         "title": "Lev Tr Source  9"
      },
      "lev_tr_source__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "TIMOR",
         "title": "Lev Tr Source  10"
      },
      "lev_tr_source__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "FABM",
         "title": "Lev Tr Source  11"
      },
      "lev_tr_source__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": -9,
         "description": "DVD",
         "title": "Lev Tr Source  12"
      },
      "level_age": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            9,
            -999
         ],
         "description": "default: -999 (all levels)",
         "title": "Level Age"
      },
      "ihdif": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ihdif"
      },
      "nchi": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Nchi"
      },
      "dzb_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "needed if nchi=1; min. bottom boundary layer thickness [m].",
         "title": "Dzb Min"
      },
      "hmin_man": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "needed if nchi=-1: min. depth in Manning's formulation [m]",
         "title": "Hmin Man"
      },
      "ncor": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "should usually be 1 if ics=2",
         "title": "Ncor"
      },
      "rlatitude": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 46,
         "description": "if ncor=-1",
         "title": "Rlatitude"
      },
      "coricoef": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "if ncor=0",
         "title": "Coricoef"
      },
      "ic_elev": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ic Elev"
      },
      "nramp_elev": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Nramp Elev"
      },
      "inv_atm_bnd": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "0: off; 1: on",
         "title": "Inv Atm Bnd"
      },
      "prmsl_ref": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 101325.0,
         "description": "reference atmos. pressure on bnd [Pa]",
         "title": "Prmsl Ref"
      },
      "flag_ic__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "T",
         "title": "Flag Ic  1"
      },
      "flag_ic__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "S",
         "title": "Flag Ic  2"
      },
      "flag_ic__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "GEN (user defined module)",
         "title": "Flag Ic  3"
      },
      "flag_ic__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "SED3D",
         "title": "Flag Ic  5"
      },
      "flag_ic__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "EcoSim",
         "title": "Flag Ic  6"
      },
      "flag_ic__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "ICM",
         "title": "Flag Ic  7"
      },
      "flag_ic__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "CoSINE",
         "title": "Flag Ic  8"
      },
      "flag_ic__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "FIB",
         "title": "Flag Ic  9"
      },
      "flag_ic__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "TIMOR",
         "title": "Flag Ic  10"
      },
      "flag_ic__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "FABM",
         "title": "Flag Ic  11"
      },
      "flag_ic__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "DVD (must=0)",
         "title": "Flag Ic  12"
      },
      "gen_wsett": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "1.e-4",
         "title": "Gen Wsett"
      },
      "ibcc_mean": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Ibcc Mean"
      },
      "rmaxvel": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 5.0,
         "description": "",
         "title": "Rmaxvel"
      },
      "velmin_btrack": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0001,
         "description": "",
         "title": "Velmin Btrack"
      },
      "btrack_nudge": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.009013,
         "description": "",
         "title": "Btrack Nudge"
      },
      "ihhat": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Ihhat"
      },
      "inunfl": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Inunfl"
      },
      "h0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.01,
         "description": "min. water depth for wetting/drying [m]",
         "title": "H0"
      },
      "shorewafo": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Matters only if USE_WWM",
         "title": "Shorewafo"
      },
      "moitn0": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 50,
         "description": "output spool for solver info; used only with JCG",
         "title": "Moitn0"
      },
      "mxitn0": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1500,
         "description": "max. iteration allowed",
         "title": "Mxitn0"
      },
      "rtol0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-12,
         "description": "error tolerance",
         "title": "Rtol0"
      },
      "nadv": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "",
         "title": "Nadv"
      },
      "dtb_max": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 30.0,
         "description": "in sec",
         "title": "Dtb Max"
      },
      "dtb_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 10.0,
         "description": "",
         "title": "Dtb Min"
      },
      "inter_mom": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Inter Mom"
      },
      "kr_co": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "not used if inter_mom=0",
         "title": "Kr Co"
      },
      "itr_met": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 3,
         "description": "",
         "title": "Itr Met"
      },
      "h_tvd": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 5.0,
         "description": "cut-off depth (m)",
         "title": "H Tvd"
      },
      "eps1_tvd_imp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0001,
         "description": "suggested value is 1.e-4, but for large suspended load, need to use a smaller value (e.g. 1.e-9)",
         "title": "Eps1 Tvd Imp"
      },
      "eps2_tvd_imp": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-14,
         "description": "",
         "title": "Eps2 Tvd Imp"
      },
      "ielm_transport": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "1: turn on",
         "title": "Ielm Transport"
      },
      "max_subcyc": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "used only if ielm_transport/=0. Max # of subcycling per time step in transport allowed",
         "title": "Max Subcyc"
      },
      "ip_weno": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "order of accuracy: 0- upwind; 1- linear polynomial, 2nd order; 2- quadratic polynomial, 3rd order",
         "title": "Ip Weno"
      },
      "courant_weno": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "Courant number for weno transport",
         "title": "Courant Weno"
      },
      "nquad": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "number of quad points on each side, nquad= 1 or 2",
         "title": "Nquad"
      },
      "ntd_weno": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "order of temporal discretization: (1) Euler (default); (3): 3rd-order Runge-Kutta (only for benchmarking)",
         "title": "Ntd Weno"
      },
      "epsilon1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-15,
         "description": "coefficient for 2nd order weno smoother (larger values are more prone to numerical dispersion)",
         "title": "Epsilon1"
      },
      "epsilon2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-10,
         "description": "1st coefficient for 3rd order weno smoother (larger values are more prone to numerical dispersion",
         "title": "Epsilon2"
      },
      "i_prtnftl_weno": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "option for writing nonfatal errors on invalid temp. or salinity for density: (0) off; (1) on.",
         "title": "I Prtnftl Weno"
      },
      "epsilon3": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-25,
         "description": "2nd coefficient for 3rd order weno smoother (inactive at the moment)",
         "title": "Epsilon3"
      },
      "ielad_weno": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "ielad, if ielad=1, use ELAD method to suppress dispersion (inactive at the moment)",
         "title": "Ielad Weno"
      },
      "small_elad": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0001,
         "description": "small (inactive at the moment)",
         "title": "Small Elad"
      },
      "nws": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "\n        Atmos. option. Use nws=2 and USE_ATMOS for coupling with atmospheric model.\n        If nws=0, no atmos. forcing is applied. If nws=1, atmos.\n        variables are read in from wind.th. If nws=2, atmos. variables are\n        read in from sflux_ files.\n        If nws=4, ascii format is used for wind and atmos. pressure at each node (see source code).\n        If nws=-1 (requires USE_PAHM), use Holland parametric wind model (barotropic only with wind and atmos. pressure).\n        In this case, the Holland model is called every step so wtiminc is not used. An extra \n        input file is needed: hurricane-track.dat, in addition to a few parameters below.\n\n        Stress calculation:\n        If nws=2, ihconsv=1 and iwind_form=0, the stress is calculated from heat exchange\n        routine; in this case USE_ATMOS cannot be on.\n        Otherwise if iwind_form=-1, the stress is calculated from Pond & Pichard formulation;\n        if iwind_form=1, Hwang (2018) formulation (Cd tapers off at high wind).\n        If WWM is enabled and icou_elfe_wwm>0 and iwind_form=-2 or -3, stress is overwritten by WWM:\n        If iwind_form=-2, stress=rho_air*ufric^2; scaled by rho_water\n        If iwind_form=-3, the stress is calculated according to the param. of Donelan et al. (1993) based on the wave age.\n        In all cases, if USE_ICE the stress in ice-covered portion is calculated by ICE routine.\n        ",
         "title": "Nws"
      },
      "wtiminc": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 150.0,
         "description": "time step for atmos. forcing. Default: same as dt",
         "title": "Wtiminc"
      },
      "drampwind": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "ramp-up period in days for wind (no ramp-up if <=0)",
         "title": "Drampwind"
      },
      "iwindoff": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "needed only if nws/=0; '1': needs windfactor.gr3",
         "title": "Iwindoff"
      },
      "iwind_form": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "needed if nws/=0",
         "title": "Iwind Form"
      },
      "model_type_pahm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "only used if nws=-1: hurricane model type (1: Holland; 10: GAHM)",
         "title": "Model Type Pahm"
      },
      "ihconsv": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "heat exchange option",
         "title": "Ihconsv"
      },
      "isconsv": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "evaporation/precipitation model",
         "title": "Isconsv"
      },
      "i_hmin_airsea_ex": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "no effect if ihconsv=0",
         "title": "I Hmin Airsea Ex"
      },
      "hmin_airsea_ex": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "[m], no effect if ihconsv=0",
         "title": "Hmin Airsea Ex"
      },
      "i_hmin_salt_ex": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "no effect if isconsv=0",
         "title": "I Hmin Salt Ex"
      },
      "hmin_salt_ex": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.2,
         "description": "[m], no effect if isconsv=0",
         "title": "Hmin Salt Ex"
      },
      "iprecip_off_bnd": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "if /=0, precip will be turned off near land bnd",
         "title": "Iprecip Off Bnd"
      },
      "itur": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 3,
         "description": "Default: 0",
         "title": "Itur"
      },
      "dfv0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.01,
         "description": "needed if itur=0",
         "title": "Dfv0"
      },
      "dfh0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0001,
         "description": "needed if itur=0",
         "title": "Dfh0"
      },
      "mid": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "KL",
         "description": "needed if itur=3,5. Use KE if itur=5",
         "title": "Mid"
      },
      "stab": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "KC",
         "description": "needed if itur=3 or 5. Use 'GA' if turb_met='MY'; otherwise use 'KC'.",
         "title": "Stab"
      },
      "xlsc0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "needed if itur=3 or 5. Scale for surface & bottom mixing length (>0)",
         "title": "Xlsc0"
      },
      "inu_elev": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Inu Elev"
      },
      "inu_uv": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "",
         "title": "Inu Uv"
      },
      "inu_tr__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "T",
         "title": "Inu Tr  1"
      },
      "inu_tr__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "S",
         "title": "Inu Tr  2"
      },
      "inu_tr__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "GEN",
         "title": "Inu Tr  3"
      },
      "inu_tr__4": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Age",
         "title": "Inu Tr  4"
      },
      "inu_tr__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "SED3D",
         "title": "Inu Tr  5"
      },
      "inu_tr__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "EcoSim",
         "title": "Inu Tr  6"
      },
      "inu_tr__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "ICM",
         "title": "Inu Tr  7"
      },
      "inu_tr__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "CoSINE",
         "title": "Inu Tr  8"
      },
      "inu_tr__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "FIB",
         "title": "Inu Tr  9"
      },
      "inu_tr__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "TIMOR",
         "title": "Inu Tr  10"
      },
      "inu_tr__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "FABM",
         "title": "Inu Tr  11"
      },
      "inu_tr__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "DVD (must=0)",
         "title": "Inu Tr  12"
      },
      "nu_sum_mult": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "1: final relax is sum of horizontal",
         "title": "Nu Sum Mult"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field alphaw: float | None = 0.5#

for itur=4 : scaling parameter for the surface roughness z0s = alphaw*Hm0.

Validated by:
field btrack_nudge: float | None = 0.009013#
Validated by:
field coricoef: int | None = 0#

if ncor=0

Validated by:
field courant_weno: float | None = 0.5#

Courant number for weno transport

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

Coupling current in WWM

Validated by:
field dfh0: float | None = 0.0001#

needed if itur=0

Validated by:
field dfv0: float | None = 0.01#

needed if itur=0

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

ramp-up period in days for b.c. etc (no ramp-up if <=0)

Validated by:
field dramp_ss: int | None = 2#

needed if if_source/=0; ramp-up period in days for source/sinks (no ramp-up if <=0)

Validated by:
field drampbc: float | None = 0.0#

ramp-up period in days for baroclinic force

Validated by:
field drampwafo: float | None = 0.0#

ramp-up period in days for the wave forces (no ramp-up if <=0)

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

ramp-up period in days for wind (no ramp-up if <=0)

Validated by:
field dtb_max: float | None = 30.0#

in sec

Validated by:
field dtb_min: float | None = 10.0#
Validated by:
field dzb_min: float | None = 0.5#

needed if nchi=1; min. bottom boundary layer thickness [m].

Validated by:
field eos_a: float | None = -0.1#

needed if ieos_type=1; should be <=0

Validated by:
field eos_b: float | None = 1001.0#

needed if ieos_type=1

Validated by:
field eps1_tvd_imp: float | None = 0.0001#

suggested value is 1.e-4, but for large suspended load, need to use a smaller value (e.g. 1.e-9)

Validated by:
field eps2_tvd_imp: float | None = 1e-14#
Validated by:
field epsilon1: float | None = 1e-15#

coefficient for 2nd order weno smoother (larger values are more prone to numerical dispersion)

Validated by:
field epsilon2: float | None = 1e-10#

1st coefficient for 3rd order weno smoother (larger values are more prone to numerical dispersion

Validated by:
field epsilon3: float | None = 1e-25#

2nd coefficient for 3rd order weno smoother (inactive at the moment)

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

T

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

TIMOR

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

FABM

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

DVD (must=0)

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

S

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

GEN (user defined module)

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

SED3D

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

EcoSim

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

ICM

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

CoSINE

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

FIB

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

–> Stokes drift advection (xy), Coriolis

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

–> Stokes drift advection (z) , Coriolis

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

–> Wave breaking

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

–> Pressure term

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

–> Wave streaming (works with iwbl /= 0)

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

–> Wave dissipation by vegetation acceleration term

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

–> Non linear intrawave vegetation force (see Dean and Bender, 2006 or van Rooijen et al., 2016 for details)

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

1.e-4

Validated by:
field h0: float | None = 0.01#

min. water depth for wetting/drying [m]

Validated by:
field h1_bcc: float | None = 50.0#

[m]

Validated by:
field h2_bcc: float | None = 100.0#

[m]; >h1_bcc

Validated by:
field h_tvd: float | None = 5.0#

cut-off depth (m)

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

[m], no effect if ihconsv=0

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

needed if nchi=-1: min. depth in Manning’s formulation [m]

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

min. total water depth used only in radiation stress calculation [m]

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

[m], no effect if isconsv=0

Validated by:
field hvis_coef0: float | None = 0.025#

const. diffusion # if ihorcon/=0; <=0.025 for ihorcon=2, <=0.125 for ihorcon=1

Validated by:
field hw_depth: float | None = 1000000.0#

threshold depth in [m]

Validated by:
field hw_ratio: float | None = 0.5#

ratio

Validated by:
field i_hmin_airsea_ex: int | None = 2#

no effect if ihconsv=0

Validated by:
field i_hmin_salt_ex: int | None = 2#

no effect if isconsv=0

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

option for writing nonfatal errors on invalid temp. or salinity for density: (0) off; (1) on.

Validated by:
field ibcc_mean: int | None = 0#
Validated by:
field ibdef: int | None = 10#

needed if imm=1; # of steps used in deformation

Validated by:
field ic_elev: int | None = 0#
Validated by:
field icou_elfe_wwm: int | None = 0#
Validated by:
field ics: int | None = 2#

Coordinate option

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

ielad, if ielad=1, use ELAD method to suppress dispersion (inactive at the moment)

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

1: turn on

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

used only if ieos_type=0. 0: without pressure effects

Validated by:
field ieos_type: int | None = 0#
Validated by:
field if_source: int | None = 0#
Validated by:
field ihconsv: int | None = 0#

heat exchange option

Validated by:
field ihdif: int | None = 0#
Validated by:
field ihhat: int | None = 1#
Validated by:
field ihorcon: int | None = 0#
Validated by:
field ihot: int | None = 0#
Validated by:
field ihydraulics: int | None = 0#
Validated by:
field iloadtide: int | None = 0#

Option to add self-attracting and loading tide (SAL) into tidal potential. 0: off, 1: needs loadtide_[FREQ].gr3 inputs, 2 or 3: simple scaling for gravity approach.

Validated by:
field imm: int | None = 0#
Validated by:
field indvel: int | None = 0#
Validated by:
field inter_mom: int | None = 0#
Validated by:
field inu_elev: int | None = 0#
Validated by:
field inu_tr__1: int | None = 0#

T

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

TIMOR

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

FABM

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

DVD (must=0)

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

S

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

GEN

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

Age

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

SED3D

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

EcoSim

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

ICM

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

CoSINE

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

FIB

Validated by:
field inu_uv: int | None = 0#
Validated by:
field inunfl: int | None = 0#
Validated by:
field inv_atm_bnd: int | None = 0#

0: off; 1: on

Validated by:
field ip_weno: int | None = 2#

order of accuracy: 0- upwind; 1- linear polynomial, 2nd order; 2- quadratic polynomial, 3rd order

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

Pre-processing flag for diagnostic outputs. If non-zero, the code will output drag coefficients (Cdp) and stop.

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

if /=0, precip will be turned off near land bnd

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

evaporation/precipitation model

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

options

Validated by:
field itr_met: int | None = 3#
Validated by:
field itransport_only: int | None = 0#

Option to solve only tracer transport. 0: off, 1 or 2: on. When 2, additional variables are needed.

Validated by:
field itur: int | None = 3#

Default: 0

Validated by:
field iunder_deep: int | None = 0#
Validated by:
field iupwind_mom: int | None = 0#
Validated by:
field iwbl: int | None = 0#

wave boundary layer formulation (used only if USE_WMM and

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

needed if nws/=0

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

needed only if nws/=0; ‘1’: needs windfactor.gr3

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

not used if inter_mom=0

Validated by:
field lev_tr_source__1: int | None = -9#

T

Validated by:
field lev_tr_source__10: int | None = -9#

TIMOR

Validated by:
field lev_tr_source__11: int | None = -9#

FABM

Validated by:
field lev_tr_source__12: int | None = -9#

DVD

Validated by:
field lev_tr_source__2: int | None = -9#

S

Validated by:
field lev_tr_source__3: int | None = -9#

GEN

Validated by:
field lev_tr_source__4: int | None = -9#

AGE: set -9999. in msource’s AGE section

Validated by:
field lev_tr_source__5: int | None = -9#

SED3D

Validated by:
field lev_tr_source__6: int | None = -9#

EcoSim

Validated by:
field lev_tr_source__7: int | None = -9#

ICM

Validated by:
field lev_tr_source__8: int | None = -9#

CoSINE

Validated by:
field lev_tr_source__9: int | None = -9#

Feco

Validated by:
field level_age: list | None = [9, -999]#

default: -999 (all levels)

Validated by:
field loadtide_coef: float | None = 0.1#

Coefficient for SAL scaling. Used only if iloadtide is 2 or 3.

Validated by:
field max_subcyc: int | None = 10#

used only if ielm_transport/=0. Max # of subcycling per time step in transport allowed

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

options to treat sinks @ dry elem

Validated by:
field mid: str | None = 'KL'#

needed if itur=3,5. Use KE if itur=5

Validated by:
field model_type_pahm: int | None = 10#

only used if nws=-1: hurricane model type (1: Holland; 10: GAHM)

Validated by:
field moitn0: int | None = 50#

output spool for solver info; used only with JCG

Validated by:
field mxitn0: int | None = 1500#

max. iteration allowed

Validated by:
field nadv: int | None = 1#
Validated by:
field nchi: int | None = 0#
Validated by:
field ncor: int | None = 0#

should usually be 1 if ics=2

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

needed if ishapiro/=0: # of iterations with Shapiro filter

Validated by:
field nquad: int | None = 2#

number of quad points on each side, nquad= 1 or 2

Validated by:
field nramp_elev: int | None = 0#
Validated by:
field nstep_wwm: int | None = 1#

call WWM every this many time steps

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

order of temporal discretization: (1) Euler (default); (3): 3rd-order Runge-Kutta (only for benchmarking)

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

1: final relax is sum of horizontal

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

Atmos. option. Use nws=2 and USE_ATMOS for coupling with atmospheric model. If nws=0, no atmos. forcing is applied. If nws=1, atmos. variables are read in from wind.th. If nws=2, atmos. variables are read in from sflux_ files. If nws=4, ascii format is used for wind and atmos. pressure at each node (see source code). If nws=-1 (requires USE_PAHM), use Holland parametric wind model (barotropic only with wind and atmos. pressure). In this case, the Holland model is called every step so wtiminc is not used. An extra input file is needed: hurricane-track.dat, in addition to a few parameters below.

Stress calculation: If nws=2, ihconsv=1 and iwind_form=0, the stress is calculated from heat exchange routine; in this case USE_ATMOS cannot be on. Otherwise if iwind_form=-1, the stress is calculated from Pond & Pichard formulation; if iwind_form=1, Hwang (2018) formulation (Cd tapers off at high wind). If WWM is enabled and icou_elfe_wwm>0 and iwind_form=-2 or -3, stress is overwritten by WWM: If iwind_form=-2, stress=rho_air*ufric^2; scaled by rho_water If iwind_form=-3, the stress is calculated according to the param. of Donelan et al. (1993) based on the wave age. In all cases, if USE_ICE the stress in ice-covered portion is calculated by ICE routine.

Validated by:
field prmsl_ref: float | None = 101325.0#

reference atmos. pressure on bnd [Pa]

Validated by:
field rlatitude: int | None = 46#

if ncor=-1

Validated by:
field rmaxvel: float | None = 5.0#
Validated by:
field rtol0: float | None = 1e-12#

error tolerance

Validated by:
field sfea0: int | None = 45#

lat

Validated by:
field shapiro0: float | None = 0.5#

needed only if ishapiro=1

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

Matters only if USE_WWM

Validated by:
field slam0: int | None = -124#

lon - not really used

Validated by:
field small_elad: float | None = 0.0001#

small (inactive at the moment)

Validated by:
field stab: str | None = 'KC'#

needed if itur=3 or 5. Use ‘GA’ if turb_met=’MY’; otherwise use ‘KC’.

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

int

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

double

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

Starting month for the simulation.

Validated by:
field start_year: int | None = 2000#

Starting year for the simulation.

Validated by:
field thetai: float | None = 0.6#
Validated by:
field turbinj: float | None = 0.15#

% of depth-induced wave breaking energy injected in turbulence

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

% of wave energy dissipated through whitecapping injected in turbulence

Validated by:
field utc_start: int | None = 8#

double

Validated by:
field velmin_btrack: float | None = 0.0001#
Validated by:
field wafo_obcramp: int | None = 0#

Ramp on wave forces at open boundary (1: on / 0: off)

Validated by:
field wtiminc: float | None = 150.0#

time step for atmos. forcing. Default: same as dt

Validated by:
field xlsc0: float | None = 0.1#

needed if itur=3 or 5. Scale for surface & bottom mixing length (>0)

Validated by:
validator check_loadtide_coef  »  all fields[source]#
validator validate_iloadtide  »  iloadtide[source]#
validator validate_ipre2  »  ipre2[source]#
validator validate_itransport_only  »  itransport_only[source]#
validator validate_loadtide_coef  »  loadtide_coef[source]#
validator validate_start_month  »  start_month[source]#
validator validate_start_year  »  start_year[source]#
On this page

This Page