rompy.swan.components.physics.SICE_M18#

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

Sea ice dissipation based on the method of Meylan et al. (2018).

SICE [aice] M18 [chf]

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.

Examples

In [139]: from rompy.swan.components.physics import SICE_M18

In [140]: sice = SICE_M18()

In [141]: print(sice.render())
SICE M18

In [142]: sice = SICE_M18(aice=0.8, chf=0.059)

In [143]: print(sice.render())
SICE aice=0.8 M18 chf=0.059

Show JSON schema
{
   "title": "SICE_M18",
   "description": "Sea ice dissipation based on the method of Meylan et al. (2018).\n\n.. code-block:: text\n\n    SICE [aice] M18 [chf]\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\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import SICE_M18\n    sice = SICE_M18()\n    print(sice.render())\n    sice = SICE_M18(aice=0.8, chf=0.059)\n    print(sice.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "m18",
         "description": "Model type discriminator",
         "enum": [
            "m18",
            "M18"
         ],
         "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"
      },
      "chf": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "A simple coefficient of proportionality (SWAN default: 0.059)",
         "title": "Chf"
      }
   },
   "additionalProperties": false
}

Fields:
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 chf: float | None = None#

A simple coefficient of proportionality (SWAN default: 0.059)

field model_type: Literal['m18', 'M18'] = 'm18'#

Model type discriminator

cmd() → str[source]#

Command file string for this component.