rompy.swan.subcomponents.physics.GODA#

pydantic model rompy.swan.subcomponents.physics.GODA[source]#

DAM transmission of Goda/Seelig (1979).

DAM GODA [hgt] [alpha] [beta]

This option specified transmission coefficients dependent on the incident wave conditions at the obstacle and on the obstacle height (which may be submerged).

References

Goda, Y. and Suzuki, Y., 1976. Estimation of incident and reflected waves in random wave experiments. In Coastal Engineering 1976 (pp. 828-845).

Seelig, W.N., 1979. Effects of breakwaters on waves: Laboratory test of wave transmission by overtopping. In Proc. Conf. Coastal Structures, 1979 (Vol. 79, No. 2, pp. 941-961).

Examples

In [22]: from rompy.swan.subcomponents.physics import GODA

In [23]: transm = GODA(hgt=3.0)

In [24]: print(transm.render())
DAM GODA hgt=3.0

In [25]: transm = GODA(hgt=3.0, alpha=2.6, beta=0.15)

In [26]: print(transm.render())
DAM GODA hgt=3.0 alpha=2.6 beta=0.15

Show JSON schema
{
   "title": "GODA",
   "description": "DAM transmission of Goda/Seelig (1979).\n\n.. code-block:: text\n\n    DAM GODA [hgt] [alpha] [beta]\n\nThis option specified transmission coefficients dependent on the incident wave\nconditions at the obstacle and on the obstacle height (which may be submerged).\n\nReferences\n----------\nGoda, Y. and Suzuki, Y., 1976. Estimation of incident and reflected waves in random\nwave experiments. In Coastal Engineering 1976 (pp. 828-845).\n\nSeelig, W.N., 1979. Effects of breakwaters on waves: Laboratory test of wave\ntransmission by overtopping. In Proc. Conf. Coastal Structures, 1979\n(Vol. 79, No. 2, pp. 941-961).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import GODA\n    transm = GODA(hgt=3.0)\n    print(transm.render())\n    transm = GODA(hgt=3.0, alpha=2.6, beta=0.15)\n    print(transm.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "goda",
         "description": "Model type discriminator",
         "enum": [
            "goda",
            "GODA"
         ],
         "title": "Model Type",
         "type": "string"
      },
      "hgt": {
         "description": "The elevation of the top of the obstacle above reference level (same reference level as for bottom etc.); use a negative value if the top is below that reference level",
         "title": "Hgt",
         "type": "number"
      },
      "alpha": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "coefficient determining the transmission coefficient for Goda's transmission formula (SWAN default: 2.6)",
         "title": "Alpha"
      },
      "beta": {
         "anyOf": [
            {
               "type": "number"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Another coefficient determining the transmission coefficient for Goda's transmission formula (SWAN default: 0.15)",
         "title": "Beta"
      }
   },
   "additionalProperties": false,
   "required": [
      "hgt"
   ]
}

Fields:
field alpha: float | None = None#

coefficient determining the transmission coefficient for Goda’s transmission formula (SWAN default: 2.6)

field beta: float | None = None#

Another coefficient determining the transmission coefficient for Goda’s transmission formula (SWAN default: 0.15)

field hgt: float [Required]#

The elevation of the top of the obstacle above reference level (same reference level as for bottom etc.); use a negative value if the top is below that reference level

field model_type: Literal['goda', 'GODA'] = 'goda'#

Model type discriminator

cmd() → str[source]#

Command file string for this subcomponent.