rompy.schism.namelists.ice.Ice#

pydantic model rompy.schism.namelists.ice.Ice[source]#

Show JSON schema
{
   "title": "Ice",
   "type": "object",
   "properties": {
      "ice_in": {
         "anyOf": [
            {
               "$ref": "#/$defs/Ice_in"
            },
            {
               "type": "null"
            }
         ]
      }
   },
   "$defs": {
      "Ice_in": {
         "additionalProperties": false,
         "properties": {
            "ice_tests": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0,
               "description": "Flag for box test. 0 disables, 1 enables.",
               "title": "Ice Tests"
            },
            "ice_advection": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "description": "Flag to enable/disable ice advection. 1 enables, 0 disables.",
               "title": "Ice Advection"
            },
            "ice_therm_on": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "description": "Flag to enable/disable ice thermodynamics. 1 enables, 0 disables.",
               "title": "Ice Therm On"
            },
            "ievp": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 2,
               "description": "Selects the rheology model. 1 for EVP (Elastic-Viscous-Plastic), 2 for mEVP (modified EVP).",
               "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 is less than or equal to ice_cutoff.",
               "title": "Ice Cutoff"
            },
            "evp_rheol_steps": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 200,
               "description": "Number of subcycling steps in EVP rheology model.",
               "title": "Evp Rheol Steps"
            },
            "mevp_rheol_steps": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 200,
               "description": "Number of iterations in mEVP rheology model.",
               "title": "Mevp Rheol Steps"
            },
            "ice_atmos_stress_form": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "description": "Form of atmospheric stress calculation. 0 for constant Cd, 1 for FESOM formulation.",
               "title": "Ice Atmos Stress Form"
            },
            "cdwin0": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.002,
               "description": "Constant drag coefficient for wind stress, used if ice_atmos_stress_form=0.",
               "title": "Cdwin0"
            },
            "delta_min": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 2e-09,
               "description": "Limit for minimum divergence (1/s). Used in both VP and EVP rheology models.",
               "title": "Delta Min"
            },
            "theta_io": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.0,
               "description": "Ice/ocean rotation angle in degrees. Usually 0 unless vertical grid is too coarse.",
               "title": "Theta Io"
            },
            "mevp_coef": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0,
               "description": "Options for specifying 2 relax coefficients in mEVP. 0 for constant, 1 for variable coefficients.",
               "title": "Mevp Coef"
            },
            "mevp_alpha1": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 200.0,
               "description": "Constant used in mEVP for constitutive equation if mevp_coef=0.",
               "title": "Mevp Alpha1"
            },
            "mevp_alpha2": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 200.0,
               "description": "Constant used in mEVP for momentum equation if mevp_coef=0.",
               "title": "Mevp Alpha2"
            },
            "mevp_alpha3": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 200.0,
               "description": "Minimum value for variable coefficients if mevp_coef=1.",
               "title": "Mevp Alpha3"
            },
            "mevp_alpha4": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.02,
               "description": "Coefficient used in variable coefficient calculation if mevp_coef=1.",
               "title": "Mevp Alpha4"
            },
            "pstar": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 15000.0,
               "description": "Ice strength parameter [N/m^2].",
               "title": "Pstar"
            },
            "ellipse": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 2.0,
               "description": "Ellipticity of the yield curve.",
               "title": "Ellipse"
            },
            "c_pressure": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 20.0,
               "description": "Ice concentration parameter C [-].",
               "title": "C Pressure"
            },
            "ncyc_fct": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 1,
               "description": "Number of subcycling steps in transport for FCT scheme.",
               "title": "Ncyc Fct"
            },
            "niter_fct": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 3,
               "description": "Number of iterations in higher-order solve for FCT scheme.",
               "title": "Niter Fct"
            },
            "ice_gamma_fct": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.25,
               "description": "Smoothing parameter for FCT scheme. 1 for maximum positivity preserving.",
               "title": "Ice Gamma Fct"
            },
            "depth_ice_fct": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 5.0,
               "description": "Cut-off depth (m) for non-FCT zone in ice_fct.gr3.",
               "title": "Depth Ice Fct"
            },
            "h_ml0": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.1,
               "description": "Ocean mixed layer depth [m] for thermodynamics calculations.",
               "title": "H Ml0"
            },
            "salt_ice": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 5.0,
               "description": "Salinity for ice [PSU] (must be non-negative).",
               "title": "Salt Ice"
            },
            "salt_water": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 34.0,
               "description": "Salinity for water [PSU] (must be non-negative).",
               "title": "Salt Water"
            },
            "lead_closing": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.5,
               "description": "Lead closing parameter [m]. Larger values slow down freezing-up but increase sea ice thickness.",
               "title": "Lead Closing"
            },
            "saterm": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.5,
               "description": "Semter constant. Smaller values could slow down melting.",
               "title": "Saterm"
            },
            "albsn": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.85,
               "description": "Albedo for frozen snow.",
               "title": "Albsn"
            },
            "albsnm": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.75,
               "description": "Albedo for melting snow (must be less than or equal to albsn).",
               "title": "Albsnm"
            },
            "albi": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.75,
               "description": "Albedo for frozen ice (must be less than or equal to albsn).",
               "title": "Albi"
            },
            "albm": {
               "anyOf": [
                  {
                     "type": "number"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": 0.66,
               "description": "Albedo for melting ice (must be less than or equal to albi).",
               "title": "Albm"
            }
         },
         "title": "Ice_in",
         "type": "object"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:

field ice_in: Ice_in | None [Optional]#
Validated by:
  • __lowercase_property_keys__