rompy.schism.namelists.param.Schout#

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

Show JSON schema
{
   "title": "Schout",
   "type": "object",
   "properties": {
      "nc_out": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Main switch to control netcdf output. If 0, SCHISM won't output nc files at all.",
         "title": "Nc Out"
      },
      "iof_ugrid": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "UGRID option for 3D outputs. If non-zero, 3D outputs will have UGRID metadata.",
         "title": "Iof Ugrid"
      },
      "nhot": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option for hotstart outputs. If 1, outputs hotstart every 'nhot_write' steps.",
         "title": "Nhot"
      },
      "nhot_write": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 8640,
         "description": "Number of steps between hotstart outputs. Must be a multiple of ihfskip if nhot=1.",
         "title": "Nhot Write"
      },
      "iout_sta": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Station output option. If non-zero, requires output skip (nspool_sta) and a station.in file.",
         "title": "Iout Sta"
      },
      "nspool_sta": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 10,
         "description": "Number of steps between station outputs. Required if iout_sta is non-zero.",
         "title": "Nspool Sta"
      },
      "iof_hydro__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "0: off; 1: on - elev. [m]  {elevation}  2D",
         "title": "Iof Hydro  1"
      },
      "iof_hydro__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "air pressure [Pa]  {airPressure}  2D",
         "title": "Iof Hydro  2"
      },
      "iof_hydro__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "air temperature [C] {airTemperature}  2D",
         "title": "Iof Hydro  3"
      },
      "iof_hydro__4": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Specific humidity [-] {specificHumidity}  2D",
         "title": "Iof Hydro  4"
      },
      "iof_hydro__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Net downward solar (shortwave) radiation after albedo [W/m/m] {solarRadiation}  2D",
         "title": "Iof Hydro  5"
      },
      "iof_hydro__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "sensible flux (positive upward) [W/m/m]  {sensibleHeat}  2D",
         "title": "Iof Hydro  6"
      },
      "iof_hydro__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "latent heat flux (positive upward) [W/m/m] {latentHeat}  2D",
         "title": "Iof Hydro  7"
      },
      "iof_hydro__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "upward longwave radiation (positive upward) [W/m/m] {upwardLongwave}  2D",
         "title": "Iof Hydro  8"
      },
      "iof_hydro__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "downward longwave radiation (positive downward) [W/m/m] {downwardLongwave}  2D",
         "title": "Iof Hydro  9"
      },
      "iof_hydro__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "total flux=-flsu-fllu-(radu-radd) [W/m/m] {totalHeat}  2D",
         "title": "Iof Hydro  10"
      },
      "iof_hydro__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "evaporation rate [kg/m/m/s] {evaporationRate}  2D",
         "title": "Iof Hydro  11"
      },
      "iof_hydro__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "precipitation rate [kg/m/m/s] {precipitationRate}  2D",
         "title": "Iof Hydro  12"
      },
      "iof_hydro__13": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Bottom stress vector [kg/m/s^2(Pa)] {bottomStressX,Y}  2D vector",
         "title": "Iof Hydro  13"
      },
      "iof_hydro__14": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "wind velocity vector [m/s] {windSpeedX,Y}  2D vector",
         "title": "Iof Hydro  14"
      },
      "iof_hydro__15": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "wind stress vector [m^2/s/s] {windStressX,Y}  2D vector",
         "title": "Iof Hydro  15"
      },
      "iof_hydro__16": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "depth-averaged vel vector [m/s] {depthAverageVelX,Y}  2D vector",
         "title": "Iof Hydro  16"
      },
      "iof_hydro__17": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "vertical velocity [m/s] {verticalVelocity}  3D",
         "title": "Iof Hydro  17"
      },
      "iof_hydro__18": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "water temperature [C] {temperature}  3D",
         "title": "Iof Hydro  18"
      },
      "iof_hydro__19": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "water salinity [PSU] {salinity}  3D",
         "title": "Iof Hydro  19"
      },
      "iof_hydro__20": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "water density [kg/m^3] {waterDensity}  3D",
         "title": "Iof Hydro  20"
      },
      "iof_hydro__21": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "vertical eddy diffusivity [m^2/s] {diffusivity}  3D",
         "title": "Iof Hydro  21"
      },
      "iof_hydro__22": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "vertical eddy viscosity [m^2/s] {viscosity}  3D",
         "title": "Iof Hydro  22"
      },
      "iof_hydro__23": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "turbulent kinetic energy {turbulentKineticEner}   3D",
         "title": "Iof Hydro  23"
      },
      "iof_hydro__24": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "turbulent mixing length [m] {mixingLength}  3D",
         "title": "Iof Hydro  24"
      },
      "iof_hydro__26": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "horizontal vel vector [m/s] {horizontalVelX,Y} 3D vector",
         "title": "Iof Hydro  26"
      },
      "iof_hydro__27": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "horizontal vel vector defined @side [m/s] {horizontalSideVelX,Y} 3D vector",
         "title": "Iof Hydro  27"
      },
      "iof_hydro__28": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "vertical vel. @elem [m/s] {verticalVelAtElement} 3D",
         "title": "Iof Hydro  28"
      },
      "iof_hydro__29": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "T @prism centers [C] {temperatureAtElement} 3D",
         "title": "Iof Hydro  29"
      },
      "iof_hydro__30": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "S @prism centers [PSU] {salinityAtElement} 3D",
         "title": "Iof Hydro  30"
      },
      "iof_hydro__31": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Barotropic pressure gradient force vector (m.s-2) @side centers  {pressure_gradient} 2D vector",
         "title": "Iof Hydro  31"
      },
      "iof_wwm__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "sig. height (m) {sigWaveHeight}   2D",
         "title": "Iof Wwm  1"
      },
      "iof_wwm__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Mean average period (sec) - TM01 {meanWavePeriod}  2D",
         "title": "Iof Wwm  2"
      },
      "iof_wwm__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Zero down crossing period for comparison with buoy (s) - TM02 {zeroDowncrossPeriod}  2D",
         "title": "Iof Wwm  3"
      },
      "iof_wwm__4": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Average period of wave runup/overtopping - TM10 {TM10}  2D",
         "title": "Iof Wwm  4"
      },
      "iof_wwm__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Mean wave number (1/m) {meanWaveNumber}  2D",
         "title": "Iof Wwm  5"
      },
      "iof_wwm__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Mean wave length (m) {meanWaveLength}  2D",
         "title": "Iof Wwm  6"
      },
      "iof_wwm__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Mean average energy transport direction (degr) - MWD in NDBC? {meanWaveDirection}  2D",
         "title": "Iof Wwm  7"
      },
      "iof_wwm__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Mean directional spreading (degr) {meanDirSpreading}  2D",
         "title": "Iof Wwm  8"
      },
      "iof_wwm__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Discrete peak period (sec) - Tp {peakPeriod}  2D",
         "title": "Iof Wwm  9"
      },
      "iof_wwm__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Continuous peak period based on higher order moments (sec) {continuousPeakPeriod}  2D",
         "title": "Iof Wwm  10"
      },
      "iof_wwm__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak phase vel. (m/s) {peakPhaseVel}  2D",
         "title": "Iof Wwm  11"
      },
      "iof_wwm__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak n-factor {peakNFactor}   2D",
         "title": "Iof Wwm  12"
      },
      "iof_wwm__13": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak group vel. (m/s) {peakGroupVel}   2D",
         "title": "Iof Wwm  13"
      },
      "iof_wwm__14": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak wave number {peakWaveNumber}  2D",
         "title": "Iof Wwm  14"
      },
      "iof_wwm__15": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak wave length {peakWaveLength}  2D",
         "title": "Iof Wwm  15"
      },
      "iof_wwm__16": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak (dominant) direction (degr) {dominantDirection}  2D",
         "title": "Iof Wwm  16"
      },
      "iof_wwm__17": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Peak directional spreading {peakSpreading}  2D",
         "title": "Iof Wwm  17"
      },
      "iof_wwm__18": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Discrete peak direction (radian?) {discretePeakDirectio}  2D",
         "title": "Iof Wwm  18"
      },
      "iof_wwm__19": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Orbital vel. (m/s) {orbitalVelocity}  2D",
         "title": "Iof Wwm  19"
      },
      "iof_wwm__20": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "RMS Orbital vel. (m/s) {rmsOrbitalVelocity}  2D",
         "title": "Iof Wwm  20"
      },
      "iof_wwm__21": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Bottom excursion period (sec?) {bottomExcursionPerio}  2D",
         "title": "Iof Wwm  21"
      },
      "iof_wwm__22": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Bottom wave period (sec) {bottomWavePeriod}  2D",
         "title": "Iof Wwm  22"
      },
      "iof_wwm__23": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Uresell number based on peak period {UresellNumber}  2D",
         "title": "Iof Wwm  23"
      },
      "iof_wwm__24": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Friction velocity (m/s?) {frictionalVelocity}  2D",
         "title": "Iof Wwm  24"
      },
      "iof_wwm__25": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Charnock coefficient {CharnockCoeff}  2D",
         "title": "Iof Wwm  25"
      },
      "iof_wwm__26": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Rougness length {rougnessLength}  2D",
         "title": "Iof Wwm  26"
      },
      "iof_wwm__27": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Roller energy dissipation rate (W/m\u00b2) @nodes {Drol} 2D",
         "title": "Iof Wwm  27"
      },
      "iof_wwm__28": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Total wave energy dissipation rate by depth-induced breaking (W/m\u00b2) @nodes {wave_sbrtot}  2D",
         "title": "Iof Wwm  28"
      },
      "iof_wwm__29": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Total wave energy dissipation rate by bottom friction (W/m\u00b2) @nodes {wave_sbftot} 2D",
         "title": "Iof Wwm  29"
      },
      "iof_wwm__30": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Total wave energy dissipation rate by whitecapping (W/m\u00b2) @nodes {wave_sdstot} 2D",
         "title": "Iof Wwm  30"
      },
      "iof_wwm__31": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Total wave energy dissipation rate by vegetation (W/m\u00b2) @nodes {wave_svegtot} 2D",
         "title": "Iof Wwm  31"
      },
      "iof_wwm__32": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Total wave energy input rate from atmospheric forcing (W/m\u00b2) @nodes {wave_sintot} 2D",
         "title": "Iof Wwm  32"
      },
      "iof_wwm__33": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "WWM_energy vector {waveEnergyDirX,Y}  2D vector",
         "title": "Iof Wwm  33"
      },
      "iof_wwm__34": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel}  3D",
         "title": "Iof Wwm  34"
      },
      "iof_wwm__35": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y}   3D vector",
         "title": "Iof Wwm  35"
      },
      "iof_wwm__36": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector",
         "title": "Iof Wwm  36"
      },
      "iof_wwm__37": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector",
         "title": "Iof Wwm  37"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field iof_hydro__1: int | None = 1#

0: off; 1: on - elev. [m] {elevation} 2D

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

total flux=-flsu-fllu-(radu-radd) [W/m/m] {totalHeat} 2D

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

evaporation rate [kg/m/m/s] {evaporationRate} 2D

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

precipitation rate [kg/m/m/s] {precipitationRate} 2D

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

Bottom stress vector [kg/m/s^2(Pa)] {bottomStressX,Y} 2D vector

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

wind velocity vector [m/s] {windSpeedX,Y} 2D vector

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

wind stress vector [m^2/s/s] {windStressX,Y} 2D vector

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

depth-averaged vel vector [m/s] {depthAverageVelX,Y} 2D vector

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

vertical velocity [m/s] {verticalVelocity} 3D

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

water temperature [C] {temperature} 3D

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

water salinity [PSU] {salinity} 3D

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

air pressure [Pa] {airPressure} 2D

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

water density [kg/m^3] {waterDensity} 3D

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

vertical eddy diffusivity [m^2/s] {diffusivity} 3D

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

vertical eddy viscosity [m^2/s] {viscosity} 3D

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

turbulent kinetic energy {turbulentKineticEner} 3D

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

turbulent mixing length [m] {mixingLength} 3D

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

horizontal vel vector [m/s] {horizontalVelX,Y} 3D vector

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

horizontal vel vector defined @side [m/s] {horizontalSideVelX,Y} 3D vector

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

vertical vel. @elem [m/s] {verticalVelAtElement} 3D

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

T @prism centers [C] {temperatureAtElement} 3D

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

air temperature [C] {airTemperature} 2D

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

S @prism centers [PSU] {salinityAtElement} 3D

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

Barotropic pressure gradient force vector (m.s-2) @side centers {pressure_gradient} 2D vector

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

Specific humidity [-] {specificHumidity} 2D

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

Net downward solar (shortwave) radiation after albedo [W/m/m] {solarRadiation} 2D

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

sensible flux (positive upward) [W/m/m] {sensibleHeat} 2D

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

latent heat flux (positive upward) [W/m/m] {latentHeat} 2D

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

upward longwave radiation (positive upward) [W/m/m] {upwardLongwave} 2D

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

downward longwave radiation (positive downward) [W/m/m] {downwardLongwave} 2D

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

UGRID option for 3D outputs. If non-zero, 3D outputs will have UGRID metadata.

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

sig. height (m) {sigWaveHeight} 2D

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

Continuous peak period based on higher order moments (sec) {continuousPeakPeriod} 2D

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

Peak phase vel. (m/s) {peakPhaseVel} 2D

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

Peak n-factor {peakNFactor} 2D

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

Peak group vel. (m/s) {peakGroupVel} 2D

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

Peak wave number {peakWaveNumber} 2D

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

Peak wave length {peakWaveLength} 2D

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

Peak (dominant) direction (degr) {dominantDirection} 2D

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

Peak directional spreading {peakSpreading} 2D

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

Discrete peak direction (radian?) {discretePeakDirectio} 2D

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

Orbital vel. (m/s) {orbitalVelocity} 2D

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

Mean average period (sec) - TM01 {meanWavePeriod} 2D

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

RMS Orbital vel. (m/s) {rmsOrbitalVelocity} 2D

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

Bottom excursion period (sec?) {bottomExcursionPerio} 2D

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

Bottom wave period (sec) {bottomWavePeriod} 2D

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

Uresell number based on peak period {UresellNumber} 2D

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

Friction velocity (m/s?) {frictionalVelocity} 2D

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

Charnock coefficient {CharnockCoeff} 2D

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

Rougness length {rougnessLength} 2D

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

Roller energy dissipation rate (W/m²) @nodes {Drol} 2D

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

Total wave energy dissipation rate by depth-induced breaking (W/m²) @nodes {wave_sbrtot} 2D

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

Total wave energy dissipation rate by bottom friction (W/m²) @nodes {wave_sbftot} 2D

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

Zero down crossing period for comparison with buoy (s) - TM02 {zeroDowncrossPeriod} 2D

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

Total wave energy dissipation rate by whitecapping (W/m²) @nodes {wave_sdstot} 2D

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

Total wave energy dissipation rate by vegetation (W/m²) @nodes {wave_svegtot} 2D

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

Total wave energy input rate from atmospheric forcing (W/m²) @nodes {wave_sintot} 2D

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

WWM_energy vector {waveEnergyDirX,Y} 2D vector

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

Vertical Stokes velocity (m.s-1) @sides and whole levels {stokes_wvel} 3D

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

Wave force vector (m.s-2) computed by wwm @side centers and whole levels {waveForceX,Y} 3D vector

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

Horizontal Stokes velocity (m.s-1) @nodes and whole levels {stokes_hvel} 3D vector

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

Roller contribution to horizontal Stokes velocity (m.s-1) @nodes and whole levels {roller_stokes_hvel} 3D vector

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

Average period of wave runup/overtopping - TM10 {TM10} 2D

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

Mean wave number (1/m) {meanWaveNumber} 2D

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

Mean wave length (m) {meanWaveLength} 2D

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

Mean average energy transport direction (degr) - MWD in NDBC? {meanWaveDirection} 2D

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

Mean directional spreading (degr) {meanDirSpreading} 2D

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

Discrete peak period (sec) - Tp {peakPeriod} 2D

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

Station output option. If non-zero, requires output skip (nspool_sta) and a station.in file.

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

Main switch to control netcdf output. If 0, SCHISM won’t output nc files at all.

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

Option for hotstart outputs. If 1, outputs hotstart every ‘nhot_write’ steps.

Validated by:
field nhot_write: int | None = 8640#

Number of steps between hotstart outputs. Must be a multiple of ihfskip if nhot=1.

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

Number of steps between station outputs. Required if iout_sta is non-zero.

Validated by:
validator validate_iof_ugrid  »  iof_ugrid[source]#
validator validate_iout_sta  »  iout_sta[source]#
validator validate_nc_out  »  nc_out[source]#
validator validate_nhot  »  nhot[source]#
validator validate_nhot_write  »  nhot_write[source]#
validator validate_nhot_write_multiple  »  all fields[source]#
validator validate_nspool_sta  »  nspool_sta[source]#
validator validate_nspool_sta_requirement  »  all fields[source]#
On this page

This Page