rompy.swan.components.physics.GEN2#

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

Second generation source terms GEN2.

GEN2 [cf10] [cf20] [cf30] [cf40] [cf50] [cf60] [edmlpm] [cdrag] [umin] [cfpm]

With this command the user indicates that SWAN should run in second-generation mode (see Scientific/Technical documentation).

Examples

In [64]: from rompy.swan.components.physics import GEN2

In [65]: gen = GEN2()

In [66]: print(gen.render())
GEN2

In [67]: kwargs = dict(
   ....:     cf10=188.0,
   ....:     cf20=0.59,
   ....:     cf30=0.12,
   ....:     cf40=250.0,
   ....:     cf50=0.0023,
   ....:     cf60=-0.223,
   ....:     edmlpm=0.0036,
   ....:     cdrag=0.0012,
   ....:     umin=1.0,
   ....:     cfpm=0.13
   ....: )
   ....: 

In [68]: gen = GEN2(**kwargs)

In [69]: print(gen.render())
GEN2 cf10=188.0 cf20=0.59 cf30=0.12 cf40=250.0 cf50=0.0023 cf60=-0.223 edmlpm=0.0036 cdrag=0.0012 umin=1.0 cfpm=0.13

Show JSON schema

{
   "title": "GEN2",
   "description": "Second generation source terms GEN2.\n\n.. code-block:: text\n\n    GEN2 [cf10] [cf20] [cf30] [cf40] [cf50] [cf60] [edmlpm] [cdrag] [umin] [cfpm]\n\nWith this command the user indicates that SWAN should run in second-generation mode\n(see Scientific/Technical documentation).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import GEN2\n    gen = GEN2()\n    print(gen.render())\n    kwargs = dict(\n        cf10=188.0,\n        cf20=0.59,\n        cf30=0.12,\n        cf40=250.0,\n        cf50=0.0023,\n        cf60=-0.223,\n        edmlpm=0.0036,\n        cdrag=0.0012,\n        umin=1.0,\n        cfpm=0.13\n    )\n    gen = GEN2(**kwargs)\n    print(gen.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "gen2",
         "description": "Model type discriminator",
         "enum": [
            "gen2",
            "GEN2"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "cf10": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Controls the linear wave growth (SWAN default: 188.0)",
         "title": "Cf10"
      },
      "cf20": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Controls the exponential wave growth (SWAN default: 0.59)",
         "title": "Cf20"
      },
      "cf30": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Controls the exponential wave growth (SWAN default: 0.12)",
         "title": "Cf30"
      },
      "cf40": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Controls the dissipation rate, i.e., the time decay scale (SWAN default: 250.0)",
         "title": "Cf40"
      },
      "edmlpm": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Maximum non-dimensionless energy density of the wind sea part of the spectrum according to Pierson Moskowitz (SWAN default: 0.0036)",
         "title": "Edmlpm"
      },
      "cdrag": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Drag coefficient (SWAN default: 0.0012)",
         "title": "Cdrag"
      },
      "umin": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Minimum wind velocity (relative to current; all wind speeds are taken at 10 m above sea level) (SWAN default: 1)",
         "title": "Umin"
      },
      "cfpm": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Coefficient which determines the Pierson Moskowitz frequency: `delta_PM = 2pi g / U_10` (SWAN default: 0.13)",
         "title": "Cfpm"
      },
      "cf50": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Controls the spectral energy scale of the limit spectrum (SWAN default: 0.0023)",
         "title": "Cf50"
      },
      "cf60": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Ccontrols the spectral energy scale of the limit spectrum (SWAN default: -0.223",
         "title": "Cf60"
      }
   },
   "additionalProperties": false
}

Fields:

cdrag (Optional[float])
cf10 (Optional[float])
cf20 (Optional[float])
cf30 (Optional[float])
cf40 (Optional[float])
cf50 (float | None)
cf60 (float | None)
cfpm (Optional[float])
edmlpm (Optional[float])
model_type (Literal['gen2', 'GEN2'])
umin (Optional[float])

field cdrag: float | None = None#: Drag coefficient (SWAN default: 0.0012)

field cf10: float | None = None#: Controls the linear wave growth (SWAN default: 188.0)

field cf20: float | None = None#: Controls the exponential wave growth (SWAN default: 0.59)

field cf30: float | None = None#: Controls the exponential wave growth (SWAN default: 0.12)

field cf40: float | None = None#: Controls the dissipation rate, i.e., the time decay scale (SWAN default: 250.0)

field cf50: float | None = None#: Controls the spectral energy scale of the limit spectrum (SWAN default: 0.0023)

field cf60: float | None = None#: Ccontrols the spectral energy scale of the limit spectrum (SWAN default: -0.223

field cfpm: float | None = None#: Coefficient which determines the Pierson Moskowitz frequency: delta_PM = 2pi g / U_10 (SWAN default: 0.13)

field edmlpm: float | None = None#: Maximum non-dimensionless energy density of the wind sea part of the spectrum according to Pierson Moskowitz (SWAN default: 0.0036)

field model_type: Literal['gen2', 'GEN2'] = 'gen2'#: Model type discriminator

field umin: float | None = None#: Minimum wind velocity (relative to current; all wind speeds are taken at 10 m above sea level) (SWAN default: 1)

cmd()[source]#: Command line string for this component.

Table of Contents

rompy.swan.components.physics.GEN2#

This Page