rompy.swan.components.physics.SICE_R19#

pydantic model rompy.swan.components.physics.SICE_R19[source]#

Sea ice dissipation based on the method of Rogers et al (2019).

SICE [aice] R19 [c0] [c1] [c2] [c3] [c4] [c5] [c6]

The default options recover the polynomial of Meylan et al. (2014), calibrated for a case of ice floes, mostly 10 to 25 m in diameter, in the marginal ice zone near Antarctica. Examples for other calibrations can be found in the Scientific/Technical documentation.

References

Meylan, M.H., Bennetts, L.G. and Kohout, A.L., 2014. In situ measurements and analysis of ocean waves in the Antarctic marginal ice zone. Geophysical Research Letters, 41(14), pp.5046-5051.

Rogers, W.E., Meylan, M.H. and Kohout, A.L., 2018. Frequency distribution of dissipation of energy of ocean waves by sea ice using data from Wave Array 3 of the ONR “Sea State” field experiment. Nav. Res. Lab. Memo. Rep, pp.18-9801.

Examples

In [144]: from rompy.swan.components.physics import SICE_R19

In [145]: sice = SICE_R19()

In [146]: print(sice.render())
SICE R19

In [147]: kwargs = dict(
   .....:     aice=0.5,
   .....:     c0=0.0,
   .....:     c1=0.0,
   .....:     c2=1.06e-3,
   .....:     c3=0.0,
   .....:     c4=0.0,
   .....:     c5=0.0,
   .....:     c6=0.0,
   .....: )
   .....: 

In [148]: sice = SICE_R19(**kwargs)

In [149]: print(sice.render())
SICE aice=0.5 R19 c0=0.0 c1=0.0 c2=0.00106 c3=0.0 c4=0.0 c5=0.0 c6=0.0

Show JSON schema

{
   "title": "SICE_R19",
   "description": "Sea ice dissipation based on the method of Rogers et al (2019).\n\n.. code-block:: text\n\n    SICE [aice] R19 [c0] [c1] [c2] [c3] [c4] [c5] [c6]\n\nThe default options recover the polynomial of Meylan et al. (2014), calibrated for\na case of ice floes, mostly 10 to 25 m in diameter, in the marginal ice zone near\nAntarctica. Examples for other calibrations can be found in the\nScientific/Technical documentation.\n\nReferences\n----------\nMeylan, M.H., Bennetts, L.G. and Kohout, A.L., 2014. In situ measurements and\nanalysis of ocean waves in the Antarctic marginal ice zone. Geophysical Research\nLetters, 41(14), pp.5046-5051.\n\nRogers, W.E., Meylan, M.H. and Kohout, A.L., 2018. Frequency distribution of\ndissipation of energy of ocean waves by sea ice using data from Wave Array 3 of\nthe ONR \u201cSea State\u201d field experiment. Nav. Res. Lab. Memo. Rep, pp.18-9801.\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import SICE_R19\n    sice = SICE_R19()\n    print(sice.render())\n    kwargs = dict(\n        aice=0.5,\n        c0=0.0,\n        c1=0.0,\n        c2=1.06e-3,\n        c3=0.0,\n        c4=0.0,\n        c5=0.0,\n        c6=0.0,\n    )\n    sice = SICE_R19(**kwargs)\n    print(sice.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "r19",
         "description": "Model type discriminator",
         "enum": [
            "r19",
            "R19"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "aice": {
         "anyOf": [
            {
               "maximum": 1.0,
               "minimum": 0.0,
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Ice concentration as a fraction from 0 to 1. Note that `aice` is allowed to vary over the computational region to account for the zonation of ice concentration. In that case use the commands `INPGRID AICE` and `READINP AICE` to define and read the sea concentration. The value of `aice` in this command is then not required (it will be ignored)",
         "title": "Aice"
      },
      "c0": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in 1/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)",
         "title": "C0"
      },
      "c1": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)",
         "title": "C1"
      },
      "c2": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s2/m) for determining the rate of sea ice dissipation (SWAN default: 1.06E-3)",
         "title": "C2"
      },
      "c3": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s3/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)",
         "title": "C3"
      },
      "c4": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s4/m) for determining the rate of sea ice dissipation (SWAN default: 2.3E-2)",
         "title": "C4"
      },
      "c5": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s5/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)",
         "title": "C5"
      },
      "c6": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Polynomial coefficient (in s6/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)",
         "title": "C6"
      }
   },
   "additionalProperties": false
}

Fields:

aice (Optional[float])
c0 (float | None)
c1 (float | None)
c2 (float | None)
c3 (float | None)
c4 (float | None)
c5 (float | None)
c6 (float | None)
model_type (Literal['r19', 'R19'])

field aice: float | None = None#

Ice concentration as a fraction from 0 to 1. Note that aice is allowed to vary over the computational region to account for the zonation of ice concentration. In that case use the commands INPGRID AICE and READINP AICE to define and read the sea concentration. The value of aice in this command is then not required (it will be ignored)

Constraints:

ge = 0.0
le = 1.0

field c0: float | None = None#: Polynomial coefficient (in 1/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)

field c1: float | None = None#: Polynomial coefficient (in s/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)

field c2: float | None = None#: Polynomial coefficient (in s2/m) for determining the rate of sea ice dissipation (SWAN default: 1.06E-3)

field c3: float | None = None#: Polynomial coefficient (in s3/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)

field c4: float | None = None#: Polynomial coefficient (in s4/m) for determining the rate of sea ice dissipation (SWAN default: 2.3E-2)

field c5: float | None = None#: Polynomial coefficient (in s5/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)

field c6: float | None = None#: Polynomial coefficient (in s6/m) for determining the rate of sea ice dissipation (SWAN default: 0.0)

field model_type: Literal['r19', 'R19'] = 'r19'#: Model type discriminator

cmd() → str[source]#: Command file string for this component.

Table of Contents

rompy.swan.components.physics.SICE_R19#

This Page