rompy.schism.namelists.icm.Marco

pydantic model rompy.schism.namelists.icm.Marco

Show JSON schema

{
   "title": "Marco",
   "type": "object",
   "properties": {
      "nsub": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Number of subcycles in ICM kinetics",
         "title": "Nsub"
      },
      "ike": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option for computing light attenuation coefficients. 0: Ke=Ke0+KeC*Chl+KeS*(tss2c*POC), 1: Ke=Ke0+KeC*Chl+KeS*TSS, 2: Ke=Ke0+KeC*Chl+KeSalt*Salt",
         "title": "Ike"
      },
      "ke0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.26,
         "description": "Background light extinction coefficient (1/m)",
         "title": "Ke0"
      },
      "kec": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.017,
         "description": "Light attenuation due to chlorophyll",
         "title": "Kec"
      },
      "kes": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.07,
         "description": "Light attenuation due to TSS",
         "title": "Kes"
      },
      "kesalt": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": -0.02,
         "description": "Light attenuation due to CDOM (related to salinity)",
         "title": "Kesalt"
      },
      "tss2c": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 6.0,
         "description": "TSS to carbon ratio",
         "title": "Tss2C"
      },
      "ilight": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option for computing light limitation factor. 0: Carl Cerco method (unit: E/m^2)",
         "title": "Ilight"
      },
      "alpha": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            8.0,
            8.0,
            8.0
         ],
         "description": "Initial slope of P-I curve (g[C]*m2/g[Chl]/E) for each phytoplankton group",
         "title": "Alpha"
      },
      "ipr": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Option for phytoplankton predation term. 0: linear formulation, 1: quadratic",
         "title": "Ipr"
      },
      "prr": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.1,
            0.2,
            0.05
         ],
         "description": "Predation rate by higher trophic level (day-1 or day-1.g-1.m3) for each phytoplankton group",
         "title": "Prr"
      },
      "wqc0": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            1.0,
            0.5,
            0.05,
            1.0,
            0.5,
            0.5,
            0.15,
            0.15,
            0.05,
            0.01,
            0.05,
            0.005,
            0.005,
            0.01,
            0.05,
            0.0,
            12.0
         ],
         "description": "Initial values for ICM state variables",
         "title": "Wqc0"
      },
      "wsp": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.3,
            0.1,
            0.0,
            0.25,
            0.25,
            0.0,
            0.25,
            0.25,
            0.0,
            0.0,
            0.0,
            0.25,
            0.25,
            0.0,
            1.0,
            0.0,
            0.0
         ],
         "description": "Settling velocity for ICM state variables (m.day-1)",
         "title": "Wsp"
      },
      "wspn": {
         "anyOf": [
            {
               "items": {},
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": [
            0.3,
            0.1,
            0.0,
            0.25,
            0.25,
            0.0,
            0.25,
            0.25,
            0.0,
            0.0,
            0.0,
            0.25,
            0.25,
            0.0,
            1.0,
            0.0,
            0.0
         ],
         "description": "Net settling velocity for ICM state variables (m.day-1)",
         "title": "Wspn"
      },
      "isilica": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Silica model switch. 0: OFF, 1: ON",
         "title": "Isilica"
      },
      "izb": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Zooplankton dynamics switch. 0: don't use, 1: use zooplankton dynamics",
         "title": "Izb"
      },
      "iph": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "PH model switch. 0: OFF, 1: ON",
         "title": "Iph"
      },
      "icbp": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Chesapeake Bay Program Model switch. 0: OFF, 1: ON",
         "title": "Icbp"
      },
      "isav_icm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Submerged Aquatic Vegetation switch. 0: OFF, 1: ON",
         "title": "Isav Icm"
      },
      "iveg_icm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Intertidal vegetation switch. 0: OFF, 1: ON",
         "title": "Iveg Icm"
      },
      "ised": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Sediment module switch. 0: OFF, 1: Use sediment flux model",
         "title": "Ised"
      },
      "iba": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Benthic Algae switch. 0: OFF, 1: ON",
         "title": "Iba"
      },
      "irad": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Solar radiation option. 0: short wave from sflux, 1: short wave from ICM_rad.th.nc",
         "title": "Irad"
      },
      "isflux": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Atmospheric fluxes option. 0: OFF, 1: additional nutrient fluxes from ICM_sflux.th.nc",
         "title": "Isflux"
      },
      "ibflux": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Bottom fluxes option. 0: OFF, 1: additional nutrient fluxes from ICM_bflux.th.nc",
         "title": "Ibflux"
      },
      "iout_icm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "ICM station outputs switch. 0: OFF, 1: ON (requires istation.in with *.bp format)",
         "title": "Iout Icm"
      },
      "nspool_icm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 24,
         "description": "Output frequency for ICM station outputs",
         "title": "Nspool Icm"
      },
      "ilimit": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Option for nutrient limitation on phytoplankton growth. 0: f=min[f(N),f(P)]*f(I), 1: f=min[f(N),f(P),f(I)]",
         "title": "Ilimit"
      },
      "idry_icm": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Shallow kinetic biochemical process option. 0: jump dry elements, keep last wet value, 1: turn on shallow kinetic biochemical process",
         "title": "Idry Icm"
      }
   },
   "additionalProperties": false
}

Fields:

• alpha (list | None)

• iba (int | None)

• ibflux (int | None)

• icbp (int | None)

• idry_icm (int | None)

• ike (int | None)

• ilight (int | None)

• ilimit (int | None)

• iout_icm (int | None)

• iph (int | None)

• ipr (int | None)

• irad (int | None)

• isav_icm (int | None)

• ised (int | None)

• isflux (int | None)

• isilica (int | None)

• iveg_icm (int | None)

• izb (int | None)

• ke0 (float | None)

• kec (float | None)

• kes (float | None)

• kesalt (float | None)

• nspool_icm (int | None)

• nsub (int | None)

• prr (list | None)

• tss2c (float | None)

• wqc0 (list | None)

• wsp (list | None)

• wspn (list | None)

Validators:

• validate_alpha » alpha

• validate_iba » iba

• validate_ibflux » ibflux

• validate_icbp » icbp

• validate_idry_icm » idry_icm

• validate_ike » ike

• validate_ilight » ilight

• validate_ilimit » ilimit

• validate_iout_icm » iout_icm

• validate_iph » iph

• validate_ipr » ipr

• validate_irad » irad

• validate_isav_icm » isav_icm

• validate_ised » ised

• validate_isflux » isflux

• validate_isilica » isilica

• validate_iveg_icm » iveg_icm

• validate_izb » izb

• validate_ke0 » ke0

• validate_kec » kec

• validate_kes » kes

• validate_kesalt » kesalt

• validate_nspool_icm » nspool_icm

• validate_nsub » nsub

• validate_prr » prr

• validate_tss2c » tss2c

• validate_wqc0 » wqc0

• validate_wsp » wsp

• validate_wspn » wspn

field alpha: list | None = [8.0, 8.0, 8.0]

Initial slope of P-I curve (g[C]*m2/g[Chl]/E) for each phytoplankton group

Validated by:

• __lowercase_property_keys__

• validate_alpha

field iba: int | None = 0

Benthic Algae switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_iba

field ibflux: int | None = 0

Bottom fluxes option. 0: OFF, 1: additional nutrient fluxes from ICM_bflux.th.nc

Validated by:

• __lowercase_property_keys__

• validate_ibflux

field icbp: int | None = 0

Chesapeake Bay Program Model switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_icbp

field idry_icm: int | None = 0

Shallow kinetic biochemical process option. 0: jump dry elements, keep last wet value, 1: turn on shallow kinetic biochemical process

Validated by:

• __lowercase_property_keys__

• validate_idry_icm

field ike: int | None = 0

Option for computing light attenuation coefficients. 0: Ke=Ke0+KeC*Chl+KeS*(tss2c*POC), 1: Ke=Ke0+KeC*Chl+KeS*TSS, 2: Ke=Ke0+KeC*Chl+KeSalt*Salt

Validated by:

• __lowercase_property_keys__

• validate_ike

field ilight: int | None = 0

Option for computing light limitation factor. 0: Carl Cerco method (unit: E/m^2)

Validated by:

• __lowercase_property_keys__

• validate_ilight

field ilimit: int | None = 0

Option for nutrient limitation on phytoplankton growth. 0: f=min[f(N),f(P)]*f(I), 1: f=min[f(N),f(P),f(I)]

Validated by:

• __lowercase_property_keys__

• validate_ilimit

field iout_icm: int | None = 0

ICM station outputs switch. 0: OFF, 1: ON (requires istation.in with *.bp format)

Validated by:

• __lowercase_property_keys__

• validate_iout_icm

field iph: int | None = 0

PH model switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_iph

field ipr: int | None = 1

Option for phytoplankton predation term. 0: linear formulation, 1: quadratic

Validated by:

• __lowercase_property_keys__

• validate_ipr

field irad: int | None = 0

Solar radiation option. 0: short wave from sflux, 1: short wave from ICM_rad.th.nc

Validated by:

• __lowercase_property_keys__

• validate_irad

field isav_icm: int | None = 0

Submerged Aquatic Vegetation switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_isav_icm

field ised: int | None = 1

Sediment module switch. 0: OFF, 1: Use sediment flux model

Validated by:

• __lowercase_property_keys__

• validate_ised

field isflux: int | None = 0

Atmospheric fluxes option. 0: OFF, 1: additional nutrient fluxes from ICM_sflux.th.nc

Validated by:

• __lowercase_property_keys__

• validate_isflux

field isilica: int | None = 0

Silica model switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_isilica

field iveg_icm: int | None = 0

Intertidal vegetation switch. 0: OFF, 1: ON

Validated by:

• __lowercase_property_keys__

• validate_iveg_icm

field izb: int | None = 0

Zooplankton dynamics switch. 0: don’t use, 1: use zooplankton dynamics

Validated by:

• __lowercase_property_keys__

• validate_izb

field ke0: float | None = 0.26

Background light extinction coefficient (1/m)

Validated by:

• __lowercase_property_keys__

• validate_ke0

field kec: float | None = 0.017

Light attenuation due to chlorophyll

Validated by:

• __lowercase_property_keys__

• validate_kec

field kes: float | None = 0.07

Light attenuation due to TSS

Validated by:

• __lowercase_property_keys__

• validate_kes

field kesalt: float | None = -0.02

Light attenuation due to CDOM (related to salinity)

Validated by:

• __lowercase_property_keys__

• validate_kesalt

field nspool_icm: int | None = 24

Output frequency for ICM station outputs

Validated by:

• __lowercase_property_keys__

• validate_nspool_icm

field nsub: int | None = 1

Number of subcycles in ICM kinetics

Validated by:

• __lowercase_property_keys__

• validate_nsub

field prr: list | None = [0.1, 0.2, 0.05]

Predation rate by higher trophic level (day-1 or day-1.g-1.m3) for each phytoplankton group

Validated by:

• __lowercase_property_keys__

• validate_prr

field tss2c: float | None = 6.0

TSS to carbon ratio

Validated by:

• __lowercase_property_keys__

• validate_tss2c

field wqc0: list | None = [1.0, 0.5, 0.05, 1.0, 0.5, 0.5, 0.15, 0.15, 0.05, 0.01, 0.05, 0.005, 0.005, 0.01, 0.05, 0.0, 12.0]

Initial values for ICM state variables

Validated by:

• __lowercase_property_keys__

• validate_wqc0

field wsp: list | None = [0.3, 0.1, 0.0, 0.25, 0.25, 0.0, 0.25, 0.25, 0.0, 0.0, 0.0, 0.25, 0.25, 0.0, 1.0, 0.0, 0.0]

Settling velocity for ICM state variables (m.day-1)

Validated by:

• __lowercase_property_keys__

• validate_wsp

field wspn: list | None = [0.3, 0.1, 0.0, 0.25, 0.25, 0.0, 0.25, 0.25, 0.0, 0.0, 0.0, 0.25, 0.25, 0.0, 1.0, 0.0, 0.0]

Net settling velocity for ICM state variables (m.day-1)

Validated by:

• __lowercase_property_keys__

• validate_wspn

validator validate_alpha  »  alpha

validator validate_iba  »  iba

validator validate_ibflux  »  ibflux

validator validate_icbp  »  icbp

validator validate_idry_icm  »  idry_icm

validator validate_ike  »  ike

validator validate_ilight  »  ilight

validator validate_ilimit  »  ilimit

validator validate_iout_icm  »  iout_icm

validator validate_iph  »  iph

validator validate_ipr  »  ipr

validator validate_irad  »  irad

validator validate_isav_icm  »  isav_icm

validator validate_ised  »  ised

validator validate_isflux  »  isflux

validator validate_isilica  »  isilica

validator validate_iveg_icm  »  iveg_icm

validator validate_izb  »  izb

validator validate_ke0  »  ke0

validator validate_kec  »  kec

validator validate_kes  »  kes

validator validate_kesalt  »  kesalt

validator validate_nspool_icm  »  nspool_icm

validator validate_nsub  »  nsub

validator validate_prr  »  prr

validator validate_tss2c  »  tss2c

validator validate_wqc0  »  wqc0

validator validate_wsp  »  wsp

validator validate_wspn  »  wspn