rompy.schism.namelists.ice.Ice_in#

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

Show JSON schema
{
   "title": "Ice_in",
   "type": "object",
   "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"
      }
   },
   "additionalProperties": false
}

Fields:
Validators:
field albi: float | None = 0.75#

Albedo for frozen ice (must be less than or equal to albsn).

Validated by:
field albm: float | None = 0.66#

Albedo for melting ice (must be less than or equal to albi).

Validated by:
field albsn: float | None = 0.85#

Albedo for frozen snow.

Validated by:
field albsnm: float | None = 0.75#

Albedo for melting snow (must be less than or equal to albsn).

Validated by:
field c_pressure: float | None = 20.0#

Ice concentration parameter C [-].

Validated by:
field cdwin0: float | None = 0.002#

Constant drag coefficient for wind stress, used if ice_atmos_stress_form=0.

Validated by:
field delta_min: float | None = 2e-09#

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

Validated by:
field depth_ice_fct: float | None = 5.0#

Cut-off depth (m) for non-FCT zone in ice_fct.gr3.

Validated by:
field ellipse: float | None = 2.0#

Ellipticity of the yield curve.

Validated by:
field evp_rheol_steps: int | None = 200#

Number of subcycling steps in EVP rheology model.

Validated by:
field h_ml0: float | None = 0.1#

Ocean mixed layer depth [m] for thermodynamics calculations.

Validated by:
field ice_advection: int | None = 1#

Flag to enable/disable ice advection. 1 enables, 0 disables.

Validated by:
field ice_atmos_stress_form: int | None = 1#

Form of atmospheric stress calculation. 0 for constant Cd, 1 for FESOM formulation.

Validated by:
field ice_cutoff: float | None = 0.001#

Cut-off thickness [m] or fraction for ice. No ice velocity if ice thickness is less than or equal to ice_cutoff.

Validated by:
field ice_gamma_fct: float | None = 0.25#

Smoothing parameter for FCT scheme. 1 for maximum positivity preserving.

Validated by:
field ice_tests: int | None = 0#

Flag for box test. 0 disables, 1 enables.

Validated by:
field ice_therm_on: int | None = 1#

Flag to enable/disable ice thermodynamics. 1 enables, 0 disables.

Validated by:
field ievp: int | None = 2#

Selects the rheology model. 1 for EVP (Elastic-Viscous-Plastic), 2 for mEVP (modified EVP).

Validated by:
field lead_closing: float | None = 0.5#

Lead closing parameter [m]. Larger values slow down freezing-up but increase sea ice thickness.

Validated by:
field mevp_alpha1: float | None = 200.0#

Constant used in mEVP for constitutive equation if mevp_coef=0.

Validated by:
field mevp_alpha2: float | None = 200.0#

Constant used in mEVP for momentum equation if mevp_coef=0.

Validated by:
field mevp_alpha3: float | None = 200.0#

Minimum value for variable coefficients if mevp_coef=1.

Validated by:
field mevp_alpha4: float | None = 0.02#

Coefficient used in variable coefficient calculation if mevp_coef=1.

Validated by:
field mevp_coef: int | None = 0#

Options for specifying 2 relax coefficients in mEVP. 0 for constant, 1 for variable coefficients.

Validated by:
field mevp_rheol_steps: int | None = 200#

Number of iterations in mEVP rheology model.

Validated by:
field ncyc_fct: int | None = 1#

Number of subcycling steps in transport for FCT scheme.

Validated by:
field niter_fct: int | None = 3#

Number of iterations in higher-order solve for FCT scheme.

Validated by:
field pstar: float | None = 15000.0#

Ice strength parameter [N/m^2].

Validated by:
field salt_ice: float | None = 5.0#

Salinity for ice [PSU] (must be non-negative).

Validated by:
field salt_water: float | None = 34.0#

Salinity for water [PSU] (must be non-negative).

Validated by:
field saterm: float | None = 0.5#

Semter constant. Smaller values could slow down melting.

Validated by:
field theta_io: float | None = 0.0#

Ice/ocean rotation angle in degrees. Usually 0 unless vertical grid is too coarse.

Validated by:
validator validate_albi  »  albi[source]#
validator validate_albi_relation  »  all fields[source]#
validator validate_albm  »  albm[source]#
validator validate_albm_relation  »  all fields[source]#
validator validate_albsn  »  albsn[source]#
validator validate_albsnm  »  albsnm[source]#
validator validate_albsnm_relation  »  all fields[source]#
validator validate_c_pressure  »  c_pressure[source]#
validator validate_cdwin0  »  cdwin0[source]#
validator validate_cdwin0_usage  »  all fields[source]#
validator validate_delta_min  »  delta_min[source]#
validator validate_depth_ice_fct  »  depth_ice_fct[source]#
validator validate_ellipse  »  ellipse[source]#
validator validate_evp_rheol_steps  »  evp_rheol_steps[source]#
validator validate_h_ml0  »  h_ml0[source]#
validator validate_ice_advection  »  ice_advection[source]#
validator validate_ice_atmos_stress_form  »  ice_atmos_stress_form[source]#
validator validate_ice_cutoff  »  ice_cutoff[source]#
validator validate_ice_gamma_fct  »  ice_gamma_fct[source]#
validator validate_ice_tests  »  ice_tests[source]#
validator validate_ice_therm_on  »  ice_therm_on[source]#
validator validate_ievp  »  ievp[source]#
validator validate_lead_closing  »  lead_closing[source]#
validator validate_mevp_alpha1  »  mevp_alpha1[source]#
validator validate_mevp_alpha1_usage  »  all fields[source]#
validator validate_mevp_alpha2  »  mevp_alpha2[source]#
validator validate_mevp_alpha2_usage  »  all fields[source]#
validator validate_mevp_alpha3  »  mevp_alpha3[source]#
validator validate_mevp_alpha3_usage  »  all fields[source]#
validator validate_mevp_alpha4  »  mevp_alpha4[source]#
validator validate_mevp_alpha4_usage  »  all fields[source]#
validator validate_mevp_coef  »  mevp_coef[source]#
validator validate_mevp_rheol_steps  »  mevp_rheol_steps[source]#
validator validate_ncyc_fct  »  ncyc_fct[source]#
validator validate_niter_fct  »  niter_fct[source]#
validator validate_pstar  »  pstar[source]#
validator validate_rheol_steps  »  all fields[source]#
validator validate_salt_ice  »  salt_ice[source]#
validator validate_salt_water  »  salt_water[source]#
validator validate_saterm  »  saterm[source]#
validator validate_theta_io  »  theta_io[source]#
On this page

This Page