rompy.swan.subcomponents.physics.DANGREMOND#

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

DAM transmission of d’Angremond et al. (1996).

DAM DANGREMOND [hgt] [slope] [Bk]

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

References

d’Angremond, K., Van Der Meer, J.W. and De Jong, R.J., 1996. Wave transmission at low-crested structures. In Coastal Engineering 1996 (pp. 2418-2427).

Examples

In [4]: from rompy.swan.subcomponents.physics import DANGREMOND

In [5]: transm = DANGREMOND(hgt=3.0, slope=60, Bk=10.0)

In [6]: print(transm.render())
DAM DANGREMOND hgt=3.0 slope=60.0 Bk=10.0

Show JSON schema
{
   "title": "DANGREMOND",
   "description": "DAM transmission of d'Angremond et al. (1996).\n\n.. code-block:: text\n\n    DAM DANGREMOND [hgt] [slope] [Bk]\n\nThis option specifies transmission coefficients dependent on the incident wave\nconditions at the obstacle and on the obstacle height (which may be submerged).\n\nReferences\n----------\nd'Angremond, K., Van Der Meer, J.W. and De Jong, R.J., 1996. Wave transmission at\nlow-crested structures. In Coastal Engineering 1996 (pp. 2418-2427).\n\nExamples\n--------\n\n.. ipython:: python\n    :okwarning:\n\n    from rompy.swan.subcomponents.physics import DANGREMOND\n    transm = DANGREMOND(hgt=3.0, slope=60, Bk=10.0)\n    print(transm.render())",
   "type": "object",
   "properties": {
      "model_type": {
         "default": "dangremond",
         "description": "Model type discriminator",
         "enum": [
            "dangremond",
            "DANGREMOND"
         ],
         "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"
      },
      "slope": {
         "description": "The slope of the obstacle (in degrees)",
         "maximum": 90.0,
         "minimum": 0.0,
         "title": "Slope",
         "type": "number"
      },
      "Bk": {
         "description": "The crest width of the obstacle",
         "title": "Bk",
         "type": "number"
      }
   },
   "additionalProperties": false,
   "required": [
      "hgt",
      "slope",
      "Bk"
   ]
}

Fields:
field Bk: float [Required]#

The crest width of the obstacle

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['dangremond', 'DANGREMOND'] = 'dangremond'#

Model type discriminator

field slope: float [Required]#

The slope of the obstacle (in degrees)

Constraints:

  • ge = 0.0

  • le = 90.0

cmd() → str[source]#

Command file string for this subcomponent.