rompy.swan.subcomponents.physics.FREEBOARD#
- pydantic model rompy.swan.subcomponents.physics.FREEBOARD[source]#
Freeboard dependent transmission and reflection.
FREEBOARD [hgt] [gammat] [gammar] [QUAY]
With this option the user indicates that the fixed transmission trcoef and reflection reflc coefficients are freeboard dependent. The freeboard dependency has no effect on the transmission coefficient as computed using the DAM option.
Notes
See the Scientific/Technical documentation for background information on the gammat and gammar shape parameters.
Examples
In [17]: from rompy.swan.subcomponents.physics import FREEBOARD In [18]: freeboard = FREEBOARD(hgt=2.0) In [19]: print(freeboard.render()) FREEBOARD hgt=2.0 In [20]: freeboard = FREEBOARD(hgt=2.0, gammat=1.0, gammar=1.0, quay=True) In [21]: print(freeboard.render()) FREEBOARD hgt=2.0 gammat=1.0 gammar=1.0 QUAY
- Fields:
- field gammar: float | None = None#
Shape parameter of relative freeboard dependency of reflection coefficient. This parameter should be higher than zero (SWAN default 1.0)
- Constraints:
gt = 0.0
- field gammat: float | None = None#
Shape parameter of relative freeboard dependency of transmission coefficient. This parameter should be higher than zero (SWAN default 1.0)
- Constraints:
gt = 0.0
- field hgt: float [Required]#
The elevation of the top of the obstacle or height of the quay above the reference level (same reference level as for the bottom). Use a negative value if the top is below that reference level. In case hgt is also specified in the DAM option, both values of hgt should be equal for consistency
- field model_type: Literal['freeboard', 'FREEBOARD'] = 'freeboard'#
Model type discriminator
- field quay: bool = False#
With this option the user indicates that the freeboard dependency of the transmission and reflection coefficients also depends on the relative position of an obstacle-linked grid point with respect to the position of the obstacle line representing the edge of a quay. In case the active grid point is on the deeper side of the obstacle, then the correction factors are applied using the parameters hgt, gammat and gammar.In case the active grid point is on the shallower side of the obstacle, the reflection coefficient is set to 0 and the transmission coefficient to 1.