rompy.swan.subcomponents.boundary.PAR#

pydantic model rompy.swan.subcomponents.boundary.PAR[source]#

Spectral parameters.

PAR [hs] [per] [dir] [dd]

Examples

In [256]: from rompy.swan.subcomponents.boundary import PAR

In [257]: par = PAR(hs=1.5, per=8.1, dir=225)

In [258]: print(par.render())
PAR hs=1.5 per=8.1 dir=225.0
Fields:
field dd: float | None = None#

Coefficient of directional spreading; a cos^m(θ) distribution is assumed. dd is interpreted as the directional standard deviation in degrees, if the option DEGREES is chosen in the command BOUND SHAPE (SWAN default: 30). dd is interpreted as the power m, if the option POWER is chosen in the command BOUND SHAPE (SWAN default: 2)

Constraints:

  • ge = 0.0

  • le = 360.0

field dir: float [Required]#

The peak wave direction thetapeak (degree), constant over frequencies

Constraints:

  • ge = -360.0

  • le = 360.0

field hs: float [Required]#

The significant wave height (m)

Constraints:

  • gt = 0.0

field model_type: Literal['par'] = 'par'#

Model type discriminator

field per: float [Required]#

The characteristic period (s) of the energy spectrum (relative frequency; which is equal to absolute frequency in the absence of currents); per is the value of the peak period if option PEAK is chosen in command BOUND SHAPE or per is the value of the mean period, if option MEAN was chosen in command BOUND SHAPE.

Constraints:

  • gt = 0.0

cmd() → str[source]#

Render subcomponent cmd.

On this page
Show Source