Skip to content

Types

types

SWAN Types

This module contains type definitions and enumerations used throughout the SWAN model implementation, including grid types, boundary conditions, and physics options.

Attributes

logger module-attribute 

logger = get_logger(__name__)

Classes

IDLA

Bases: IntEnum

Order of values in the input files.

Attributes

ONE: 1 SWAN reads the map from left to right starting in the upper-left-hand corner of the map. A new line in the map should start on a new line in the file. TWO: 2 As 1 but a new line in the map need not start on a new line in the file. THREE: 3 SWAN reads the map from left to right starting in the lower-left-hand corner of the map. A new line in the map should start on a new line in the file. FOUR: 4 As 3 but a new line in the map need not start on a new line in the file. FIVE: 5 SWAN reads the map from top to bottom starting in the lower-left-hand corner of the map. A new column in the map should start on a new line in the file. SIX: 6 As 5 but a new column in the map need not start on a new line in the file.

Notes

It is assumed that the x-axis of the grid is pointing to the right and the y-axis upwards.

Source code in rompy_swan/types.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class IDLA(IntEnum):
    """Order of values in the input files.

    Attributes
    ----------
    ONE: 1
        SWAN reads the map from left to right starting in the upper-left-hand corner of
        the map. A new line in the map should start on a new line in the file.
    TWO: 2
        As `1` but a new line in the map need not start on a new line in the file.
    THREE: 3
        SWAN reads the map from left to right starting in the lower-left-hand corner of
        the map. A new line in the map should start on a new line in the file.
    FOUR: 4
        As `3` but a new line in the map need not start on a new line in the file.
    FIVE: 5
        SWAN reads the map from top to bottom starting in the lower-left-hand corner of
        the map. A new column in the map should start on a new line in the file.
    SIX: 6
        As `5` but a new column in the map need not start on a new line in the file.

    Notes
    -----
    It is assumed that the x-axis of the grid is pointing to the right and the y-axis
    upwards.

    """

    ONE = 1
    TWO = 2
    THREE = 3
    FOUR = 4
    FIVE = 5
    SIX = 6
Attributes
ONE class-attribute instance-attribute 
ONE = 1
TWO class-attribute instance-attribute 
TWO = 2
THREE class-attribute instance-attribute 
THREE = 3
FOUR class-attribute instance-attribute 
FOUR = 4
FIVE class-attribute instance-attribute 
FIVE = 5
SIX class-attribute instance-attribute 
SIX = 6

GridOptions

Bases: str, Enum

Valid options for the input grid type.

Attributes

BOTTOM: "bottom" Bottom level grid. WLEVEL: "wlevel" Water level grid. CURRENT: "current" Current field grid. VX: "vx" Current field x-component grid. VY: "vy" Current field y-component grid. WIND: "wind" Wind velocity grid. WX: "wx" Wind velocity x-component grid. WY: "wy" Wind velocity y-component grid. FRICTION: "friction" Bottom friction grid. NPLANTS: "nplants" Horizontally varying vegetation density grid. TURBVISC: "turbvisc" Horizontally varying turbulent viscosity grid. MUDLAYER: "mudlayer" Horizontally varying mud layer thickness grid. AICE: "aice" Areal ice fraction grid, a number between 0 and 1. HICE: "hice" Ice thickness grid. HSS: "hss" Sea-swell significant wave height grid. TSS: "tss" Sea-swell mean wave period.

Source code in rompy_swan/types.py 
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
class GridOptions(str, Enum):
    """Valid options for the input grid type.

    Attributes
    ----------
    BOTTOM: "bottom"
        Bottom level grid.
    WLEVEL: "wlevel"
        Water level grid.
    CURRENT: "current"
        Current field grid.
    VX: "vx"
        Current field x-component grid.
    VY: "vy"
        Current field y-component grid.
    WIND: "wind"
        Wind velocity grid.
    WX: "wx"
        Wind velocity x-component grid.
    WY: "wy"
        Wind velocity y-component grid.
    FRICTION: "friction"
        Bottom friction grid.
    NPLANTS: "nplants"
        Horizontally varying vegetation density grid.
    TURBVISC: "turbvisc"
        Horizontally varying turbulent viscosity grid.
    MUDLAYER: "mudlayer"
        Horizontally varying mud layer thickness grid.
    AICE: "aice"
        Areal ice fraction grid, a number between 0 and 1.
    HICE: "hice"
        Ice thickness grid.
    HSS: "hss"
        Sea-swell significant wave height grid.
    TSS: "tss"
        Sea-swell mean wave period.

    """

    BOTTOM = "bottom"
    WLEVEL = "wlevel"
    CURRENT = "current"
    VX = "vx"
    VY = "vy"
    WIND = "wind"
    WX = "wx"
    WY = "wy"
    FRICTION = "friction"
    NPLANTS = "nplants"
    TURBVISC = "turbvisc"
    MUDLAYER = "mudlayer"
    AICE = "aice"
    HICE = "hice"
    HSS = "hss"
    TSS = "tss"
Attributes
BOTTOM class-attribute instance-attribute 
BOTTOM = 'bottom'
WLEVEL class-attribute instance-attribute 
WLEVEL = 'wlevel'
CURRENT class-attribute instance-attribute 
CURRENT = 'current'
VX class-attribute instance-attribute 
VX = 'vx'
VY class-attribute instance-attribute 
VY = 'vy'
WIND class-attribute instance-attribute 
WIND = 'wind'
WX class-attribute instance-attribute 
WX = 'wx'
WY class-attribute instance-attribute 
WY = 'wy'
FRICTION class-attribute instance-attribute 
FRICTION = 'friction'
NPLANTS class-attribute instance-attribute 
NPLANTS = 'nplants'
TURBVISC class-attribute instance-attribute 
TURBVISC = 'turbvisc'
MUDLAYER class-attribute instance-attribute 
MUDLAYER = 'mudlayer'
AICE class-attribute instance-attribute 
AICE = 'aice'
HICE class-attribute instance-attribute 
HICE = 'hice'
HSS class-attribute instance-attribute 
HSS = 'hss'
TSS class-attribute instance-attribute 
TSS = 'tss'

BoundShapeOptions

Bases: str, Enum

Valid options for the boundary shape type.

Attributes

JONSWAP: "jonswap" JONSWAP spectrum. PM: "pm" Pierson-Moskowitz spectrum. GAUSS: "gauss" Gaussian spectrum. BIN: "bin" Energy at a single bin spectrum. TMA: "tma" TMA spectrum.

Source code in rompy_swan/types.py 
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
class BoundShapeOptions(str, Enum):
    """Valid options for the boundary shape type.

    Attributes
    ----------
    JONSWAP: "jonswap"
        JONSWAP spectrum.
    PM: "pm"
        Pierson-Moskowitz spectrum.
    GAUSS: "gauss"
        Gaussian spectrum.
    BIN: "bin"
        Energy at a single bin spectrum.
    TMA: "tma"
        TMA spectrum.

    """

    JONSWAP = "jonswap"
    PM = "pm"
    GAUSS = "gauss"
    BIN = "bin"
    TMA = "tma"
Attributes
JONSWAP class-attribute instance-attribute 
JONSWAP = 'jonswap'
PM class-attribute instance-attribute 
PM = 'pm'
GAUSS class-attribute instance-attribute 
GAUSS = 'gauss'
BIN class-attribute instance-attribute 
BIN = 'bin'
TMA class-attribute instance-attribute 
TMA = 'tma'

SideOptions

Bases: str, Enum

Valid options for the boundary shape type.

Attributes

NORTH: "north" North side. NW: "nw" North-west side. WEST: "west" West side. SW: "sw" South-west side. SOUTH: "south" South side. SE: "se" South-east side. EAST: "east" East side. NE: "ne" North-east side.

Source code in rompy_swan/types.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
class SideOptions(str, Enum):
    """Valid options for the boundary shape type.

    Attributes
    ----------
    NORTH: "north"
        North side.
    NW: "nw"
        North-west side.
    WEST: "west"
        West side.
    SW: "sw"
        South-west side.
    SOUTH: "south"
        South side.
    SE: "se"
        South-east side.
    EAST: "east"
        East side.
    NE: "ne"
        North-east side.

    """

    NORTH = "north"
    NW = "nw"
    WEST = "west"
    SW = "sw"
    SOUTH = "south"
    SE = "se"
    EAST = "east"
    NE = "ne"
Attributes
NORTH class-attribute instance-attribute 
NORTH = 'north'
NW class-attribute instance-attribute 
NW = 'nw'
WEST class-attribute instance-attribute 
WEST = 'west'
SW class-attribute instance-attribute 
SW = 'sw'
SOUTH class-attribute instance-attribute 
SOUTH = 'south'
SE class-attribute instance-attribute 
SE = 'se'
EAST class-attribute instance-attribute 
EAST = 'east'
NE class-attribute instance-attribute 
NE = 'ne'

PhysicsOff

Bases: str, Enum

Physics commands to be switched off.

Attributes

WINDGROWTH : str = "windgrowth" Switches off wind growth (in commands GEN1, GEN2, GEN3). QUADRUPL : str = "quadrupl" Switches off quadruplet wave interactions (in command GEN3). WCAPPING : str = "wcapping" Switches off whitecapping (in command GEN3). BREAKING : str = "breaking" Switches off wave breaking dissipation. REFRAC : str = "refrac" Switches off wave refraction (action transport in theta space). FSHIFT : str = "fshift" Switches off frequency shifting (action transport in sigma space). BNDCHK : str = "bndchk" Switches off the checking of the delta imposed and computed Hs at the boundary.

Source code in rompy_swan/types.py 
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
class PhysicsOff(str, Enum):
    """Physics commands to be switched off.

    Attributes
    ----------
    WINDGROWTH : str = "windgrowth"
        Switches off wind growth (in commands GEN1, GEN2, GEN3).
    QUADRUPL : str = "quadrupl"
        Switches off quadruplet wave interactions (in command GEN3).
    WCAPPING : str = "wcapping"
        Switches off whitecapping (in command GEN3).
    BREAKING : str = "breaking"
        Switches off wave breaking dissipation.
    REFRAC : str = "refrac"
        Switches off wave refraction (action transport in theta space).
    FSHIFT : str = "fshift"
        Switches off frequency shifting (action transport in sigma space).
    BNDCHK : str = "bndchk"
        Switches off the checking of the delta imposed and computed Hs at the boundary.

    """

    WINDGROWTH = "windgrowth"
    QUADRUPL = "quadrupl"
    WCAPPING = "wcapping"
    BREAKING = "breaking"
    REFRAC = "refrac"
    FSHIFT = "fshift"
    BNDCHK = "bndchk"
Attributes
WINDGROWTH class-attribute instance-attribute 
WINDGROWTH = 'windgrowth'
QUADRUPL class-attribute instance-attribute 
QUADRUPL = 'quadrupl'
WCAPPING class-attribute instance-attribute 
WCAPPING = 'wcapping'
BREAKING class-attribute instance-attribute 
BREAKING = 'breaking'
REFRAC class-attribute instance-attribute 
REFRAC = 'refrac'
FSHIFT class-attribute instance-attribute 
FSHIFT = 'fshift'
BNDCHK class-attribute instance-attribute 
BNDCHK = 'bndchk'

BlockOptions

Bases: str, Enum

Valid options for block output parameters.

Attributes

HSIGN: "hsign" Significant wave height (in m). HSWELL: "hswell" Swell wave height (in m). DIR: "dir" Mean wave direction (in degrees). DPM: "dpm" Mean wave direction at the peak frequency (in degrees). PDIR: "pdir" Peak wave direction (in degrees). TDIR: "tdir" Direction of energy transport (in degrees). TM01: "tm01" Mean absolute wave period (in s). RTM01: "rtm01" Mean relative wave period (in s). RTP: "rtp" Peak period of the (relative frequency) variance density spectrum (in s). TPS: "tps" Smoothed peak period (in s). PER: "per" Mean absolute wave period (in s). RPER: "rper" Mean relative wave period (in s). TMM10: "tmm10" Mean absolute wave period (in s). RTMM10: "rtmm10" Mean relative wave period (in s). TM02: "tm02" Mean absolute zero-crossing period (in s). FSPR: "fspr" The normalised width of the frequency spectrum. DSPR: "dspr" Directional spreading of the waves (in degrees). QP: "qp" Peakedness of the wave spectrum (dimensionless). DEPTH: "depth" Water depth (in m). WATLEV: "watlev" Water level (in m). BOTLEV: "botlev" Bottom level (in m). VEL: "vel" Current velocity (vector; in m/s). FRCOEF: "frcoef" Friction coefficient (equal to cfw or kn in command FRICTION). WIND: "wind" Wind velocity (vector; in m/s). AICE: "aice" Ice concentration (as a fraction from 0 to 1). PROPAGAT: "propagat" Sum of PROPXY, PROPTHETA and PROPSIGMA (in W/m2 or m2/s). PROPXY: "propxy" Energy propagation in geographic space; sum of x- and y-direction (in W/m2 or m2/s). PROPTHETA: "proptheta" Energy propagation in theta space (in W/m2 or m2/s). PROPSIGMA: "propsigma" Energy propagation in sigma space (in W/m2 or m2/s). GENERAT: "generat" Total energy generation (in W/m2 or m2/s). GENWIND: "genwind" Energy generation due to wind (in W/m2 or m2/s). REDIST: "redist" Total energy redistribution (in W/m2 or m2/s). REDQUAD: "redquad" Energy redistribution due to quadruplets (in W/m2 or m2/s). REDTRIAD: "redtriad" Energy redistribution due to triads (in W/m2 or m2/s). DISSIP: "dissip" Total energy dissipation (in W/m2 or m2/s). DISBOT: "disbot" Energy dissipation due to bottom friction (in W/m2 or m2/s). DISSURF: "dissurf" Energy dissipation due to surf breaking (in W/m2 or m2/s). DISWCAP: "diswcap" Energy dissipation due to whitecapping (in W/m2 or m2/s). DISSWELL: "disswell" Energy dissipation due to swell dissipation (in W/m2 or m2/s). DISVEG: "disveg" Energy dissipation due to vegetation (in W/m2 or m2/s). DISMUD: "dismud" Energy dissipation due to mud (in W/m2 or m2/s). DISICE: "disice" Energy dissipation due to sea ice (in W/m2 or m2/s). RADSTR: "radstr" Energy transfer between waves and currents due to radiation stress (in W/m2 or m2/s). QB: "qb" Fraction of breaking waves due to depth-induced breaking. TRANSP: "transp" Transport of energy (vector; in W/m2 or m2/s). FORCE: "force" Wave-induced force per unit surface area (vector; in N/m2). UBOT: "ubot" The rms-value of the maxima of the orbital velocity near the bottom (in m/s). URMS: "urms" The rms-value of the orbital velocity near the bottom (in m/s). TMBOT: "tmbot" The bottom wave period (in s). WLENGTH: "wlength" Average wave length (in m). LWAVP: "lwavp" Peak wave length (in m). STEEPNESS: "steepness" Average wave steepness (dimensionless). BFI: "bfi" Benjamin-Feir index (dimensionless). NPLANTS: "nplants" Number of plants per square meter. DHSIGN: "dhsign" Difference in significant wave height from the last two iterations (in m). DRTM01: "drtm01" Difference in average wave period (RTM01) from the last two iterations (in s). LEAK: "leak" Numerical loss of energy equal to cthetaE(omega,theta) across boundaries. TIME: "time" Full date-time string as part of line used in TABLE only. TSEC: "tsec" Time in seconds with respect to a reference time (see command QUANTITY). XP: "xp" The x-coordinate in the problem coordinate system of the output location. YP: "yp" The y-coordinate in the problem coordinate system of the output location. DIST: "dist" If output has been requested along a curve then the distance along the curve can be obtained with the command TABLE. DIST is the distance along the curve measured from teh first point on the curve to the output location on the curve in meters (also in the case of spherical coordinates). SETUP: "setup" Set-up due to waves (in m). PTHSIGN: "pthsign" Watershed partitions of the significant wave height (in m). PTRTP: "ptrtp" Watershed partitions of the relative peak period (in s). PTWLEN: "ptwlen" Watershed partitions of the average wave length (in m). PTDIR: "ptdir" Watershed partitions of the peak wave direction (in degrees). PTDSPR: "ptdspr" Watershed partitions of the directional spreading (in degrees). PTWFRAC: "ptwfrac" Watershed partitions of the wind fraction (dimensionless). PTSTEEPNE: "ptsteepne" Watershed partition of the wave steepness (dimensionless). PARTITION: "partition" The raw spectral partition for wave system tracking post-processing.

Note

Energy given in W/m2 or m2/s depending on command SET.

Note

UBOT and URMS required command FRICTION to be used. If friction is ignored in the computation, then one should use the command FRICTION with the value of the friction set to zero (e.g., FRICTION COLLINS 0).

Source code in rompy_swan/types.py 
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
class BlockOptions(str, Enum):
    """Valid options for block output parameters.

    Attributes
    ----------
    HSIGN: "hsign"
        Significant wave height (in m).
    HSWELL: "hswell"
        Swell wave height (in m).
    DIR: "dir"
        Mean wave direction (in degrees).
    DPM: "dpm"
        Mean wave direction at the peak frequency (in degrees).
    PDIR: "pdir"
        Peak wave direction (in degrees).
    TDIR: "tdir"
        Direction of energy transport (in degrees).
    TM01: "tm01"
        Mean absolute wave period (in s).
    RTM01: "rtm01"
        Mean relative wave period (in s).
    RTP: "rtp"
        Peak period of the (relative frequency) variance density spectrum (in s).
    TPS: "tps"
        Smoothed peak period (in s).
    PER: "per"
        Mean absolute wave period (in s).
    RPER: "rper"
        Mean relative wave period (in s).
    TMM10: "tmm10"
        Mean absolute wave period (in s).
    RTMM10: "rtmm10"
        Mean relative wave period (in s).
    TM02: "tm02"
        Mean absolute zero-crossing period (in s).
    FSPR: "fspr"
        The normalised width of the frequency spectrum.
    DSPR: "dspr"
        Directional spreading of the waves (in degrees).
    QP: "qp"
        Peakedness of the wave spectrum (dimensionless).
    DEPTH: "depth"
        Water depth (in m).
    WATLEV: "watlev"
        Water level (in m).
    BOTLEV: "botlev"
        Bottom level (in m).
    VEL: "vel"
        Current velocity (vector; in m/s).
    FRCOEF: "frcoef"
        Friction coefficient (equal to `cfw` or `kn` in command `FRICTION`).
    WIND: "wind"
        Wind velocity (vector; in m/s).
    AICE: "aice"
        Ice concentration (as a fraction from 0 to 1).
    PROPAGAT: "propagat"
        Sum of PROPXY, PROPTHETA and PROPSIGMA (in W/m2 or m2/s).
    PROPXY: "propxy"
        Energy propagation in geographic space; sum of x- and y-direction
        (in W/m2 or m2/s).
    PROPTHETA: "proptheta"
        Energy propagation in theta space (in W/m2 or m2/s).
    PROPSIGMA: "propsigma"
        Energy propagation in sigma space (in W/m2 or m2/s).
    GENERAT: "generat"
        Total energy generation (in W/m2 or m2/s).
    GENWIND: "genwind"
        Energy generation due to wind (in W/m2 or m2/s).
    REDIST: "redist"
        Total energy redistribution (in W/m2 or m2/s).
    REDQUAD: "redquad"
        Energy redistribution due to quadruplets (in W/m2 or m2/s).
    REDTRIAD: "redtriad"
        Energy redistribution due to triads (in W/m2 or m2/s).
    DISSIP: "dissip"
        Total energy dissipation (in W/m2 or m2/s).
    DISBOT: "disbot"
        Energy dissipation due to bottom friction (in W/m2 or m2/s).
    DISSURF: "dissurf"
        Energy dissipation due to surf breaking (in W/m2 or m2/s).
    DISWCAP: "diswcap"
        Energy dissipation due to whitecapping (in W/m2 or m2/s).
    DISSWELL: "disswell"
        Energy dissipation due to swell dissipation (in W/m2 or m2/s).
    DISVEG: "disveg"
        Energy dissipation due to vegetation (in W/m2 or m2/s).
    DISMUD: "dismud"
        Energy dissipation due to mud (in W/m2 or m2/s).
    DISICE: "disice"
        Energy dissipation due to sea ice (in W/m2 or m2/s).
    RADSTR: "radstr"
        Energy transfer between waves and currents due to radiation stress
        (in W/m2 or m2/s).
    QB: "qb"
        Fraction of breaking waves due to depth-induced breaking.
    TRANSP: "transp"
        Transport of energy (vector; in W/m2 or m2/s).
    FORCE: "force"
        Wave-induced force per unit surface area (vector; in N/m2).
    UBOT: "ubot"
        The rms-value of the maxima of the orbital velocity near the bottom (in m/s).
    URMS: "urms"
        The rms-value of the orbital velocity near the bottom (in m/s).
    TMBOT: "tmbot"
        The bottom wave period (in s).
    WLENGTH: "wlength"
        Average wave length (in m).
    LWAVP: "lwavp"
        Peak wave length (in m).
    STEEPNESS: "steepness"
        Average wave steepness (dimensionless).
    BFI: "bfi"
        Benjamin-Feir index (dimensionless).
    NPLANTS: "nplants"
        Number of plants per square meter.
    DHSIGN: "dhsign"
        Difference in significant wave height from the last two iterations (in m).
    DRTM01: "drtm01"
        Difference in average wave period (RTM01) from the last two iterations (in s).
    LEAK: "leak"
        Numerical loss of energy equal to `cthetaE(omega,theta)` across boundaries.
    TIME: "time"
        Full date-time string as part of line used in TABLE only.
    TSEC: "tsec"
        Time in seconds with respect to a reference time (see command QUANTITY).
    XP: "xp"
        The x-coordinate in the problem coordinate system of the output location.
    YP: "yp"
        The y-coordinate in the problem coordinate system of the output location.
    DIST: "dist"
        If output has been requested along a curve then the distance along the curve
        can be obtained with the command TABLE. DIST is the distance along the curve
        measured from teh first point on the curve to the output location on the curve
        in meters (also in the case of spherical coordinates).
    SETUP: "setup"
        Set-up due to waves (in m).
    PTHSIGN: "pthsign"
        Watershed partitions of the significant wave height (in m).
    PTRTP: "ptrtp"
        Watershed partitions of the relative peak period (in s).
    PTWLEN: "ptwlen"
        Watershed partitions of the average wave length (in m).
    PTDIR: "ptdir"
        Watershed partitions of the peak wave direction (in degrees).
    PTDSPR: "ptdspr"
        Watershed partitions of the directional spreading (in degrees).
    PTWFRAC: "ptwfrac"
        Watershed partitions of the wind fraction (dimensionless).
    PTSTEEPNE: "ptsteepne"
        Watershed partition of the wave steepness (dimensionless).
    PARTITION: "partition"
        The raw spectral partition for wave system tracking post-processing.

    Note
    ----
    Energy given in W/m2 or m2/s depending on command SET.

    Note
    ----
    UBOT and URMS required command `FRICTION` to be used. If friction is ignored in the
    computation, then one should use the command `FRICTION` with the value of the
    friction set to zero (e.g., `FRICTION COLLINS 0`).

    """

    HSIGN = "hsign"
    HSWELL = "hswell"
    DIR = "dir"
    DPM = "dpm"
    PDIR = "pdir"
    TDIR = "tdir"
    TM01 = "tm01"
    RTM01 = "rtm01"
    RTP = "rtp"
    TPS = "tps"
    PER = "per"
    RPER = "rper"
    TMM10 = "tmm10"
    RTMM10 = "rtmm10"
    TM02 = "tm02"
    FSPR = "fspr"
    DSPR = "dspr"
    QP = "qp"
    DEPTH = "depth"
    WATLEV = "watlev"
    BOTLEV = "botlev"
    VEL = "vel"
    FRCOEF = "frcoef"
    WIND = "wind"
    AICE = "aice"
    PROPAGAT = "propagat"
    PROPXY = "propxy"
    PROPTHETA = "proptheta"
    PROPSIGMA = "propsigma"
    GENERAT = "generat"
    GENWIND = "genwind"
    REDIST = "redist"
    REDQUAD = "redquad"
    REDTRIAD = "redtriad"
    DISSIP = "dissip"
    DISBOT = "disbot"
    DISSURF = "dissurf"
    DISWCAP = "diswcap"
    DISSWELL = "disswell"
    DISVEG = "disveg"
    DISMUD = "dismud"
    DISICE = "disice"
    RADSTR = "radstr"
    QB = "qb"
    TRANSP = "transp"
    FORCE = "force"
    UBOT = "ubot"
    URMS = "urms"
    TMBOT = "tmbot"
    WLENGTH = "wlength"
    LWAVP = "lwavp"
    STEEPNESS = "steepness"
    BFI = "bfi"
    NPLANTS = "nplants"
    DHSIGN = "dhsign"
    DRTM01 = "drtm01"
    LEAK = "leak"
    TIME = "time"
    TSEC = "tsec"
    XP = "xp"
    YP = "yp"
    DIST = "dist"
    SETUP = "setup"
    PTHSIGN = "pthsign"
    PTRTP = "ptrtp"
    PTWLEN = "ptwlen"
    PTDIR = "ptdir"
    PTDSPR = "ptdspr"
    PTWFRAC = "ptwfrac"
    PTSTEEPNE = "ptsteepne"
    PARTITION = "partition"
Attributes
HSIGN class-attribute instance-attribute 
HSIGN = 'hsign'
HSWELL class-attribute instance-attribute 
HSWELL = 'hswell'
DIR class-attribute instance-attribute 
DIR = 'dir'
DPM class-attribute instance-attribute 
DPM = 'dpm'
PDIR class-attribute instance-attribute 
PDIR = 'pdir'
TDIR class-attribute instance-attribute 
TDIR = 'tdir'
TM01 class-attribute instance-attribute 
TM01 = 'tm01'
RTM01 class-attribute instance-attribute 
RTM01 = 'rtm01'
RTP class-attribute instance-attribute 
RTP = 'rtp'
TPS class-attribute instance-attribute 
TPS = 'tps'
PER class-attribute instance-attribute 
PER = 'per'
RPER class-attribute instance-attribute 
RPER = 'rper'
TMM10 class-attribute instance-attribute 
TMM10 = 'tmm10'
RTMM10 class-attribute instance-attribute 
RTMM10 = 'rtmm10'
TM02 class-attribute instance-attribute 
TM02 = 'tm02'
FSPR class-attribute instance-attribute 
FSPR = 'fspr'
DSPR class-attribute instance-attribute 
DSPR = 'dspr'
QP class-attribute instance-attribute 
QP = 'qp'
DEPTH class-attribute instance-attribute 
DEPTH = 'depth'
WATLEV class-attribute instance-attribute 
WATLEV = 'watlev'
BOTLEV class-attribute instance-attribute 
BOTLEV = 'botlev'
VEL class-attribute instance-attribute 
VEL = 'vel'
FRCOEF class-attribute instance-attribute 
FRCOEF = 'frcoef'
WIND class-attribute instance-attribute 
WIND = 'wind'
AICE class-attribute instance-attribute 
AICE = 'aice'
PROPAGAT class-attribute instance-attribute 
PROPAGAT = 'propagat'
PROPXY class-attribute instance-attribute 
PROPXY = 'propxy'
PROPTHETA class-attribute instance-attribute 
PROPTHETA = 'proptheta'
PROPSIGMA class-attribute instance-attribute 
PROPSIGMA = 'propsigma'
GENERAT class-attribute instance-attribute 
GENERAT = 'generat'
GENWIND class-attribute instance-attribute 
GENWIND = 'genwind'
REDIST class-attribute instance-attribute 
REDIST = 'redist'
REDQUAD class-attribute instance-attribute 
REDQUAD = 'redquad'
REDTRIAD class-attribute instance-attribute 
REDTRIAD = 'redtriad'
DISSIP class-attribute instance-attribute 
DISSIP = 'dissip'
DISBOT class-attribute instance-attribute 
DISBOT = 'disbot'
DISSURF class-attribute instance-attribute 
DISSURF = 'dissurf'
DISWCAP class-attribute instance-attribute 
DISWCAP = 'diswcap'
DISSWELL class-attribute instance-attribute 
DISSWELL = 'disswell'
DISVEG class-attribute instance-attribute 
DISVEG = 'disveg'
DISMUD class-attribute instance-attribute 
DISMUD = 'dismud'
DISICE class-attribute instance-attribute 
DISICE = 'disice'
RADSTR class-attribute instance-attribute 
RADSTR = 'radstr'
QB class-attribute instance-attribute 
QB = 'qb'
TRANSP class-attribute instance-attribute 
TRANSP = 'transp'
FORCE class-attribute instance-attribute 
FORCE = 'force'
UBOT class-attribute instance-attribute 
UBOT = 'ubot'
URMS class-attribute instance-attribute 
URMS = 'urms'
TMBOT class-attribute instance-attribute 
TMBOT = 'tmbot'
WLENGTH class-attribute instance-attribute 
WLENGTH = 'wlength'
LWAVP class-attribute instance-attribute 
LWAVP = 'lwavp'
STEEPNESS class-attribute instance-attribute 
STEEPNESS = 'steepness'
BFI class-attribute instance-attribute 
BFI = 'bfi'
NPLANTS class-attribute instance-attribute 
NPLANTS = 'nplants'
DHSIGN class-attribute instance-attribute 
DHSIGN = 'dhsign'
DRTM01 class-attribute instance-attribute 
DRTM01 = 'drtm01'
LEAK class-attribute instance-attribute 
LEAK = 'leak'
TIME class-attribute instance-attribute 
TIME = 'time'
TSEC class-attribute instance-attribute 
TSEC = 'tsec'
XP class-attribute instance-attribute 
XP = 'xp'
YP class-attribute instance-attribute 
YP = 'yp'
DIST class-attribute instance-attribute 
DIST = 'dist'
SETUP class-attribute instance-attribute 
SETUP = 'setup'
PTHSIGN class-attribute instance-attribute 
PTHSIGN = 'pthsign'
PTRTP class-attribute instance-attribute 
PTRTP = 'ptrtp'
PTWLEN class-attribute instance-attribute 
PTWLEN = 'ptwlen'
PTDIR class-attribute instance-attribute 
PTDIR = 'ptdir'
PTDSPR class-attribute instance-attribute 
PTDSPR = 'ptdspr'
PTWFRAC class-attribute instance-attribute 
PTWFRAC = 'ptwfrac'
PTSTEEPNE class-attribute instance-attribute 
PTSTEEPNE = 'ptsteepne'
PARTITION class-attribute instance-attribute 
PARTITION = 'partition'