rompy.schism.namelists.param.Vertical

pydantic model rompy.schism.namelists.param.Vertical

Show JSON schema

{
   "title": "Vertical",
   "type": "object",
   "properties": {
      "vnh1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 400,
         "description": "Vertical nudging depth 1 in meters. Used in vertical relaxation scheme.",
         "title": "Vnh1"
      },
      "vnf1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Vertical relaxation factor for depth 1. Must be between 0 and 1.",
         "title": "Vnf1"
      },
      "vnh2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 500,
         "description": "Vertical nudging depth 2 in meters. Must be greater than vnh1.",
         "title": "Vnh2"
      },
      "vnf2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Vertical relaxation factor for depth 2. Must be between 0 and 1.",
         "title": "Vnf2"
      },
      "step_nu_tr": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 86400.0,
         "description": "Time step in seconds for all *_nu.nc files when inu_[MOD]=2.",
         "title": "Step Nu Tr"
      },
      "h_bcc1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 100.0,
         "description": "Cut-off depth for cubic spline interpolation near bottom when computing horizontal gradients.",
         "title": "H Bcc1"
      },
      "s1_mxnbt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.5,
         "description": "Dimensioning parameter for inter-subdomain backtracking.",
         "title": "S1 Mxnbt"
      },
      "s2_mxnbt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 3.5,
         "description": "Another dimensioning parameter for inter-subdomain backtracking.",
         "title": "S2 Mxnbt"
      },
      "iharind": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for harmonic analysis of elevation. 0 for off, non-zero for on.",
         "title": "Iharind"
      },
      "iflux": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Conservation check option. 0: off, 1: basic output, 2: more elaborate outputs.",
         "title": "Iflux"
      },
      "izonal5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for Williamson test #5 (zonal flow over an isolated mount). 0 for off, non-zero for on.",
         "title": "Izonal5"
      },
      "ibtrack_test": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for rotating Gausshill test with stratified T,S. 0: off, 1: on.",
         "title": "Ibtrack Test"
      },
      "irouse_test": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for Rouse profile test. 0: off, 1: on. Requires USE_TIMOR to be on if enabled.",
         "title": "Irouse Test"
      },
      "flag_fib": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Flag to choose FIB model for bacteria decay. 1: Constant decay rate, 2: Canteras et al., 1995, 3: Servais et al., 2007.",
         "title": "Flag Fib"
      },
      "slr_rate": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 120.0,
         "description": "Sea-level rise rate in mm/year for marsh model. Only used if USE_MARSH is on.",
         "title": "Slr Rate"
      },
      "isav": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for vegetation model. 0: off, 1: on. Requires additional input files if enabled.",
         "title": "Isav"
      },
      "nstep_ice": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Number of SCHISM steps between calls to the ICE module.",
         "title": "Nstep Ice"
      },
      "rearth_pole": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 6378206.4,
         "description": "Earth's radius at the pole in meters.",
         "title": "Rearth Pole"
      },
      "rearth_eq": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 6378206.4,
         "description": "Earth's radius at the equator in meters.",
         "title": "Rearth Eq"
      },
      "shw": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "4184.d0",
         "description": "Specific heat of water (C_p) in J/kg/K.",
         "title": "Shw"
      },
      "rho0": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": "1000.d0",
         "description": "Reference water density for Boussinesq approximation in kg/m^3.",
         "title": "Rho0"
      },
      "vclose_surf_frac": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1.0,
         "description": "Fraction of vertical flux closure adjustment applied at surface for T,S.",
         "title": "Vclose Surf Frac"
      },
      "iadjust_mass_consv0__1": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "T",
         "title": "Iadjust Mass Consv0  1"
      },
      "iadjust_mass_consv0__2": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "S",
         "title": "Iadjust Mass Consv0  2"
      },
      "iadjust_mass_consv0__3": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "GEN",
         "title": "Iadjust Mass Consv0  3"
      },
      "iadjust_mass_consv0__4": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "AGE",
         "title": "Iadjust Mass Consv0  4"
      },
      "iadjust_mass_consv0__5": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "SED3D (code won't allow non-0 for this module)",
         "title": "Iadjust Mass Consv0  5"
      },
      "iadjust_mass_consv0__6": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "EcoSim",
         "title": "Iadjust Mass Consv0  6"
      },
      "iadjust_mass_consv0__7": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "ICM",
         "title": "Iadjust Mass Consv0  7"
      },
      "iadjust_mass_consv0__8": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "CoSiNE",
         "title": "Iadjust Mass Consv0  8"
      },
      "iadjust_mass_consv0__9": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Feco",
         "title": "Iadjust Mass Consv0  9"
      },
      "iadjust_mass_consv0__10": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "TIMOR",
         "title": "Iadjust Mass Consv0  10"
      },
      "iadjust_mass_consv0__11": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "FABM",
         "title": "Iadjust Mass Consv0  11"
      },
      "iadjust_mass_consv0__12": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "DVD (must=0)",
         "title": "Iadjust Mass Consv0  12"
      },
      "h_massconsv": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 2.0,
         "description": "Threshold depth for ICM mass conservation in meters.",
         "title": "H Massconsv"
      },
      "rinflation_icm": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.001,
         "description": "Maximum ratio between H^{n+1} and H^n allowed for ICM mass conservation.",
         "title": "Rinflation Icm"
      }
   },
   "additionalProperties": false
}

Fields:

• flag_fib (int | None)

• h_bcc1 (float | None)

• h_massconsv (float | None)

• iadjust_mass_consv0__1 (int | None)

• iadjust_mass_consv0__10 (int | None)

• iadjust_mass_consv0__11 (int | None)

• iadjust_mass_consv0__12 (int | None)

• iadjust_mass_consv0__2 (int | None)

• iadjust_mass_consv0__3 (int | None)

• iadjust_mass_consv0__4 (int | None)

• iadjust_mass_consv0__5 (int | None)

• iadjust_mass_consv0__6 (int | None)

• iadjust_mass_consv0__7 (int | None)

• iadjust_mass_consv0__8 (int | None)

• iadjust_mass_consv0__9 (int | None)

• ibtrack_test (int | None)

• iflux (int | None)

• iharind (int | None)

• irouse_test (int | None)

• isav (int | None)

• izonal5 (int | None)

• nstep_ice (int | None)

• rearth_eq (float | None)

• rearth_pole (float | None)

• rho0 (str | None)

• rinflation_icm (float | None)

• s1_mxnbt (float | None)

• s2_mxnbt (float | None)

• shw (str | None)

• slr_rate (float | None)

• step_nu_tr (float | None)

• vclose_surf_frac (float | None)

• vnf1 (float | None)

• vnf2 (float | None)

• vnh1 (int | None)

• vnh2 (int | None)

Validators:

• check_flag_fib » flag_fib

• check_h_bcc1 » h_bcc1

• check_h_massconsv » h_massconsv

• check_ibtrack_test » ibtrack_test

• check_iflux » iflux

• check_iharind » iharind

• check_irouse_test » irouse_test

• check_isav » isav

• check_izonal5 » izonal5

• check_nstep_ice » nstep_ice

• check_rearth_eq » rearth_eq

• check_rearth_pole » rearth_pole

• check_rho0 » rho0

• check_rinflation_icm » rinflation_icm

• check_s1_mxnbt » s1_mxnbt

• check_s2_mxnbt » s2_mxnbt

• check_shw » shw

• check_slr_rate » slr_rate

• check_step_nu_tr » step_nu_tr

• check_vclose_surf_frac » vclose_surf_frac

• check_vnf1 » vnf1

• check_vnf2 » vnf2

• check_vnh1 » vnh1

• check_vnh2 » vnh2

• check_vnh2_greater_than_vnh1 » all fields

field flag_fib: int | None = 1

Flag to choose FIB model for bacteria decay. 1: Constant decay rate, 2: Canteras et al., 1995, 3: Servais et al., 2007.

Validated by:

• __lowercase_property_keys__

• check_flag_fib

• check_vnh2_greater_than_vnh1

field h_bcc1: float | None = 100.0

Cut-off depth for cubic spline interpolation near bottom when computing horizontal gradients.

Validated by:

• __lowercase_property_keys__

• check_h_bcc1

• check_vnh2_greater_than_vnh1

field h_massconsv: float | None = 2.0

Threshold depth for ICM mass conservation in meters.

Validated by:

• __lowercase_property_keys__

• check_h_massconsv

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__1: int | None = 0

T

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__10: int | None = 0

TIMOR

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__11: int | None = 0

FABM

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__12: int | None = 0

DVD (must=0)

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__2: int | None = 0

S

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__3: int | None = 0

GEN

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__4: int | None = 0

AGE

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__5: int | None = 0

SED3D (code won’t allow non-0 for this module)

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__6: int | None = 0

EcoSim

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__7: int | None = 0

ICM

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__8: int | None = 0

CoSiNE

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field iadjust_mass_consv0__9: int | None = 0

Feco

Validated by:

• __lowercase_property_keys__

• check_vnh2_greater_than_vnh1

field ibtrack_test: int | None = 0

Flag for rotating Gausshill test with stratified T,S. 0: off, 1: on.

Validated by:

• __lowercase_property_keys__

• check_ibtrack_test

• check_vnh2_greater_than_vnh1

field iflux: int | None = 0

Conservation check option. 0: off, 1: basic output, 2: more elaborate outputs.

Validated by:

• __lowercase_property_keys__

• check_iflux

• check_vnh2_greater_than_vnh1

field iharind: int | None = 0

Flag for harmonic analysis of elevation. 0 for off, non-zero for on.

Validated by:

• __lowercase_property_keys__

• check_iharind

• check_vnh2_greater_than_vnh1

field irouse_test: int | None = 0

Flag for Rouse profile test. 0: off, 1: on. Requires USE_TIMOR to be on if enabled.

Validated by:

• __lowercase_property_keys__

• check_irouse_test

• check_vnh2_greater_than_vnh1

field isav: int | None = 0

Flag for vegetation model. 0: off, 1: on. Requires additional input files if enabled.

Validated by:

• __lowercase_property_keys__

• check_isav

• check_vnh2_greater_than_vnh1

field izonal5: int | None = 0

Flag for Williamson test #5 (zonal flow over an isolated mount). 0 for off, non-zero for on.

Validated by:

• __lowercase_property_keys__

• check_izonal5

• check_vnh2_greater_than_vnh1

field nstep_ice: int | None = 1

Number of SCHISM steps between calls to the ICE module.

Validated by:

• __lowercase_property_keys__

• check_nstep_ice

• check_vnh2_greater_than_vnh1

field rearth_eq: float | None = 6378206.4

Earth’s radius at the equator in meters.

Validated by:

• __lowercase_property_keys__

• check_rearth_eq

• check_vnh2_greater_than_vnh1

field rearth_pole: float | None = 6378206.4

Earth’s radius at the pole in meters.

Validated by:

• __lowercase_property_keys__

• check_rearth_pole

• check_vnh2_greater_than_vnh1

field rho0: str | None = '1000.d0'

Reference water density for Boussinesq approximation in kg/m^3.

Validated by:

• __lowercase_property_keys__

• check_rho0

• check_vnh2_greater_than_vnh1

field rinflation_icm: float | None = 0.001

Maximum ratio between H^{n+1} and H^n allowed for ICM mass conservation.

Validated by:

• __lowercase_property_keys__

• check_rinflation_icm

• check_vnh2_greater_than_vnh1

field s1_mxnbt: float | None = 0.5

Dimensioning parameter for inter-subdomain backtracking.

Validated by:

• __lowercase_property_keys__

• check_s1_mxnbt

• check_vnh2_greater_than_vnh1

field s2_mxnbt: float | None = 3.5

Another dimensioning parameter for inter-subdomain backtracking.

Validated by:

• __lowercase_property_keys__

• check_s2_mxnbt

• check_vnh2_greater_than_vnh1

field shw: str | None = '4184.d0'

Specific heat of water (C_p) in J/kg/K.

Validated by:

• __lowercase_property_keys__

• check_shw

• check_vnh2_greater_than_vnh1

field slr_rate: float | None = 120.0

Sea-level rise rate in mm/year for marsh model. Only used if USE_MARSH is on.

Validated by:

• __lowercase_property_keys__

• check_slr_rate

• check_vnh2_greater_than_vnh1

field step_nu_tr: float | None = 86400.0

Time step in seconds for all *_nu.nc files when inu_[MOD]=2.

Validated by:

• __lowercase_property_keys__

• check_step_nu_tr

• check_vnh2_greater_than_vnh1

field vclose_surf_frac: float | None = 1.0

Fraction of vertical flux closure adjustment applied at surface for T,S.

Validated by:

• __lowercase_property_keys__

• check_vclose_surf_frac

• check_vnh2_greater_than_vnh1

field vnf1: float | None = 0.0

Vertical relaxation factor for depth 1. Must be between 0 and 1.

Validated by:

• __lowercase_property_keys__

• check_vnf1

• check_vnh2_greater_than_vnh1

field vnf2: float | None = 0.0

Vertical relaxation factor for depth 2. Must be between 0 and 1.

Validated by:

• __lowercase_property_keys__

• check_vnf2

• check_vnh2_greater_than_vnh1

field vnh1: int | None = 400

Vertical nudging depth 1 in meters. Used in vertical relaxation scheme.

Validated by:

• __lowercase_property_keys__

• check_vnh1

• check_vnh2_greater_than_vnh1

field vnh2: int | None = 500

Vertical nudging depth 2 in meters. Must be greater than vnh1.

Validated by:

• __lowercase_property_keys__

• check_vnh2

• check_vnh2_greater_than_vnh1

validator check_flag_fib  »  flag_fib

validator check_h_bcc1  »  h_bcc1

validator check_h_massconsv  »  h_massconsv

validator check_ibtrack_test  »  ibtrack_test

validator check_iflux  »  iflux

validator check_iharind  »  iharind

validator check_irouse_test  »  irouse_test

validator check_isav  »  isav

validator check_izonal5  »  izonal5

validator check_nstep_ice  »  nstep_ice

validator check_rearth_eq  »  rearth_eq

validator check_rearth_pole  »  rearth_pole

validator check_rho0  »  rho0

validator check_rinflation_icm  »  rinflation_icm

validator check_s1_mxnbt  »  s1_mxnbt

validator check_s2_mxnbt  »  s2_mxnbt

validator check_shw  »  shw

validator check_slr_rate  »  slr_rate

validator check_step_nu_tr  »  step_nu_tr

validator check_vclose_surf_frac  »  vclose_surf_frac

validator check_vnf1  »  vnf1

validator check_vnf2  »  vnf2

validator check_vnh1  »  vnh1

validator check_vnh2  »  vnh2

validator check_vnh2_greater_than_vnh1  »  all fields