rompy.schism.namelists.mice.Mice_in

pydantic model rompy.schism.namelists.mice.Mice_in

Show JSON schema

{
   "title": "Mice_in",
   "type": "object",
   "properties": {
      "ice_tests": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 0,
         "description": "Flag for box test. 0 indicates no box test.",
         "title": "Ice Tests"
      },
      "ihot_mice": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Start mode for ice model. 0: cold start, 1: restart, 2: hotstart from HYCOM.",
         "title": "Ihot Mice"
      },
      "ice_advection": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 6,
         "description": "Ice advection scheme. 3: upwind, 4: center-difference, 5: tvd, 6: tvd-up, 7: TVD_Casulli.",
         "title": "Ice Advection"
      },
      "ice_therm_on": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 1,
         "description": "Flag for ice thermodynamics. 1: on, 0: off.",
         "title": "Ice Therm On"
      },
      "ievp": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 2,
         "description": "Elastic-Viscous-Plastic (EVP) model selection. 1: EVP, 2: modified EVP (mEVP).",
         "title": "Ievp"
      },
      "ice_cutoff": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.001,
         "description": "Cut-off thickness [m] or fraction for ice. No ice velocity if ice thickness <= ice_cutoff.",
         "title": "Ice Cutoff"
      },
      "evp_rheol_steps": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 500,
         "description": "Number of subcycling steps in EVP.",
         "title": "Evp Rheol Steps"
      },
      "mevp_rheol_steps": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 500,
         "description": "Number of iterations in modified EVP (mEVP).",
         "title": "Mevp Rheol Steps"
      },
      "delta_min": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 1e-11,
         "description": "Limit for minimum divergence (1/s). Used in both VP and EVP.",
         "title": "Delta Min"
      },
      "theta_io": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.0,
         "description": "Ice/ocean rotation angle in degrees.",
         "title": "Theta Io"
      },
      "mevp_alpha1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 200.0,
         "description": "Constant used in mEVP for constitutive equation.",
         "title": "Mevp Alpha1"
      },
      "mevp_alpha2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 200.0,
         "description": "Constant used in mEVP for momentum equation.",
         "title": "Mevp Alpha2"
      },
      "pstar": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 27500.0,
         "description": "Ice strength parameter [N/m^2].",
         "title": "Pstar"
      },
      "ellipse": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 2.0,
         "description": "Ellipticity parameter for ice rheology.",
         "title": "Ellipse"
      },
      "c_pressure": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 20.0,
         "description": "Ice pressure coefficient [-].",
         "title": "C Pressure"
      },
      "niter_fct": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": 3,
         "description": "Number of iterations in higher-order solve for FCT (Flux-Corrected Transport).",
         "title": "Niter Fct"
      },
      "ice_gamma_fct": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.25,
         "description": "Smoothing parameter for FCT.",
         "title": "Ice Gamma Fct"
      },
      "h_ml0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 0.1,
         "description": "Initial ocean mixed layer depth [m].",
         "title": "H Ml0"
      },
      "salt_ice": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 5.0,
         "description": "Salinity for ice [PSU].",
         "title": "Salt Ice"
      },
      "salt_water": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": 34.0,
         "description": "Salinity for water [PSU].",
         "title": "Salt Water"
      }
   },
   "additionalProperties": false
}

Fields:

• c_pressure (float | None)

• delta_min (float | None)

• ellipse (float | None)

• evp_rheol_steps (int | None)

• h_ml0 (float | None)

• ice_advection (int | None)

• ice_cutoff (float | None)

• ice_gamma_fct (float | None)

• ice_tests (int | None)

• ice_therm_on (int | None)

• ievp (int | None)

• ihot_mice (int | None)

• mevp_alpha1 (float | None)

• mevp_alpha2 (float | None)

• mevp_rheol_steps (int | None)

• niter_fct (int | None)

• pstar (float | None)

• salt_ice (float | None)

• salt_water (float | None)

• theta_io (float | None)

Validators:

• validate_c_pressure » c_pressure

• validate_delta_min » delta_min

• validate_ellipse » ellipse

• validate_evp_rheol_steps » evp_rheol_steps

• validate_h_ml0 » h_ml0

• validate_ice_advection » ice_advection

• validate_ice_cutoff » ice_cutoff

• validate_ice_gamma_fct » ice_gamma_fct

• validate_ice_tests » ice_tests

• validate_ice_therm_on » ice_therm_on

• validate_ievp » ievp

• validate_ihot_mice » ihot_mice

• validate_mevp_alpha1 » mevp_alpha1

• validate_mevp_alpha2 » mevp_alpha2

• validate_mevp_rheol_steps » mevp_rheol_steps

• validate_niter_fct » niter_fct

• validate_pstar » pstar

• validate_salt_ice » salt_ice

• validate_salt_water » salt_water

• validate_theta_io » theta_io

field c_pressure: float | None = 20.0

Ice pressure coefficient [-].

Validated by:

• __lowercase_property_keys__

• validate_c_pressure

field delta_min: float | None = 1e-11

Limit for minimum divergence (1/s). Used in both VP and EVP.

Validated by:

• __lowercase_property_keys__

• validate_delta_min

field ellipse: float | None = 2.0

Ellipticity parameter for ice rheology.

Validated by:

• __lowercase_property_keys__

• validate_ellipse

field evp_rheol_steps: int | None = 500

Number of subcycling steps in EVP.

Validated by:

• __lowercase_property_keys__

• validate_evp_rheol_steps

field h_ml0: float | None = 0.1

Initial ocean mixed layer depth [m].

Validated by:

• __lowercase_property_keys__

• validate_h_ml0

field ice_advection: int | None = 6

Ice advection scheme. 3: upwind, 4: center-difference, 5: tvd, 6: tvd-up, 7: TVD_Casulli.

Validated by:

• __lowercase_property_keys__

• validate_ice_advection

field ice_cutoff: float | None = 0.001

Cut-off thickness [m] or fraction for ice. No ice velocity if ice thickness <= ice_cutoff.

Validated by:

• __lowercase_property_keys__

• validate_ice_cutoff

field ice_gamma_fct: float | None = 0.25

Smoothing parameter for FCT.

Validated by:

• __lowercase_property_keys__

• validate_ice_gamma_fct

field ice_tests: int | None = 0

Flag for box test. 0 indicates no box test.

Validated by:

• __lowercase_property_keys__

• validate_ice_tests

field ice_therm_on: int | None = 1

Flag for ice thermodynamics. 1: on, 0: off.

Validated by:

• __lowercase_property_keys__

• validate_ice_therm_on

field ievp: int | None = 2

Elastic-Viscous-Plastic (EVP) model selection. 1: EVP, 2: modified EVP (mEVP).

Validated by:

• __lowercase_property_keys__

• validate_ievp

field ihot_mice: int | None = 1

Start mode for ice model. 0: cold start, 1: restart, 2: hotstart from HYCOM.

Validated by:

• __lowercase_property_keys__

• validate_ihot_mice

field mevp_alpha1: float | None = 200.0

Constant used in mEVP for constitutive equation.

Validated by:

• __lowercase_property_keys__

• validate_mevp_alpha1

field mevp_alpha2: float | None = 200.0

Constant used in mEVP for momentum equation.

Validated by:

• __lowercase_property_keys__

• validate_mevp_alpha2

field mevp_rheol_steps: int | None = 500

Number of iterations in modified EVP (mEVP).

Validated by:

• __lowercase_property_keys__

• validate_mevp_rheol_steps

field niter_fct: int | None = 3

Number of iterations in higher-order solve for FCT (Flux-Corrected Transport).

Validated by:

• __lowercase_property_keys__

• validate_niter_fct

field pstar: float | None = 27500.0

Ice strength parameter [N/m^2].

Validated by:

• __lowercase_property_keys__

• validate_pstar

field salt_ice: float | None = 5.0

Salinity for ice [PSU].

Validated by:

• __lowercase_property_keys__

• validate_salt_ice

field salt_water: float | None = 34.0

Salinity for water [PSU].

Validated by:

• __lowercase_property_keys__

• validate_salt_water

field theta_io: float | None = 0.0

Ice/ocean rotation angle in degrees.

Validated by:

• __lowercase_property_keys__

• validate_theta_io

validator validate_c_pressure  »  c_pressure

validator validate_delta_min  »  delta_min

validator validate_ellipse  »  ellipse

validator validate_evp_rheol_steps  »  evp_rheol_steps

validator validate_h_ml0  »  h_ml0

validator validate_ice_advection  »  ice_advection

validator validate_ice_cutoff  »  ice_cutoff

validator validate_ice_gamma_fct  »  ice_gamma_fct

validator validate_ice_tests  »  ice_tests

validator validate_ice_therm_on  »  ice_therm_on

validator validate_ievp  »  ievp

validator validate_ihot_mice  »  ihot_mice

validator validate_mevp_alpha1  »  mevp_alpha1

validator validate_mevp_alpha2  »  mevp_alpha2

validator validate_mevp_rheol_steps  »  mevp_rheol_steps

validator validate_niter_fct  »  niter_fct

validator validate_pstar  »  pstar

validator validate_salt_ice  »  salt_ice

validator validate_salt_water  »  salt_water

validator validate_theta_io  »  theta_io