rompy.swan.components.physics.GEN1#

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

First generation source terms GEN1.

GEN1 [cf10] [cf20] [cf30] [cf40] [edmlpm] [cdrag] [umin] [cfpm]

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

Examples

In [58]: from rompy.swan.components.physics import GEN1

In [59]: gen = GEN1()

In [60]: print(gen.render())
GEN1

In [61]: kwargs = dict(
   ....:     cf10=188.0,
   ....:     cf20=0.59,
   ....:     cf30=0.12,
   ....:     cf40=250.0,
   ....:     edmlpm=0.0036,
   ....:     cdrag=0.0012,
   ....:     umin=1.0,
   ....:     cfpm=0.13
   ....: )
   ....: 

In [62]: gen = GEN1(**kwargs)

In [63]: print(gen.render())
GEN1 cf10=188.0 cf20=0.59 cf30=0.12 cf40=250.0 edmlpm=0.0036 cdrag=0.0012 umin=1.0 cfpm=0.13

Show JSON schema

{
   "title": "GEN1",
   "description": "First generation source terms GEN1.\n\n.. code-block:: text\n\n    GEN1 [cf10] [cf20] [cf30] [cf40] [edmlpm] [cdrag] [umin] [cfpm]\n\nWith this command the user indicates that SWAN should run in first-generation mode\n(see Scientific/Technical documentation).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.components.physics import GEN1\n    gen = GEN1()\n    print(gen.render())\n    kwargs = dict(\n        cf10=188.0,\n        cf20=0.59,\n        cf30=0.12,\n        cf40=250.0,\n        edmlpm=0.0036,\n        cdrag=0.0012,\n        umin=1.0,\n        cfpm=0.13\n    )\n    gen = GEN1(**kwargs)\n    print(gen.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "gen1",
         "description": "Model type discriminator",
         "enum": [
            "gen1",
            "GEN1"
         ],
         "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"
      }
   },
   "additionalProperties": false
}

Fields:

cdrag (float | None)
cf10 (float | None)
cf20 (float | None)
cf30 (float | None)
cf40 (float | None)
cfpm (float | None)
edmlpm (float | None)
model_type (Literal['gen1', 'GEN1'])
umin (float | None)

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 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['gen1', 'GEN1'] = 'gen1'#: 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.GEN1#

This Page