rompy.schism.namelists.mice.Mice#

pydantic model rompy.schism.namelists.mice.Mice[source]#

Show JSON schema
{
   "title": "Mice",
   "type": "object",
   "properties": {
      "mice_in": {
         "anyOf": [
            {
               "$ref": "#/$defs/Mice_in"
            },
            {
               "type": "null"
            }
         ]
      }
   },
   "$defs": {
      "Mice_in": {
         "additionalProperties": false,
         "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"
            }
         },
         "title": "Mice_in",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:

field mice_in: Mice_in | None [Optional]#
Validated by:
  • __lowercase_property_keys__