rompy.swan.types.BlockOptions#
- class rompy.swan.types.BlockOptions(value)[source]#
Valid options for block output parameters.
- HSIGN#
Significant wave height (in m).
- Type:
“hsign”
- HSWELL#
Swell wave height (in m).
- Type:
“hswell”
- DIR#
Mean wave direction (in degrees).
- Type:
“dir”
- PDIR#
Peak wave direction (in degrees).
- Type:
“pdir”
- TDIR#
Direction of energy transport (in degrees).
- Type:
“tdir”
- TM01#
Mean absolute wave period (in s).
- Type:
“tm01”
- RTM01#
Mean relative wave period (in s).
- Type:
“rtm01”
- RTP#
Peak period of the (relative frequency) variance density spectrum (in s).
- Type:
“rtp”
- TPS#
Smoothed peak period (in s).
- Type:
“tps”
- PER#
Mean absolute wave period (in s).
- Type:
“per”
- RPER#
Mean relative wave period (in s).
- Type:
“rper”
- TMM10#
Mean absolute wave period (in s).
- Type:
“tmm10”
- RTMM10#
Mean relative wave period (in s).
- Type:
“rtmm10”
- TM02#
Mean absolute zero-crossing period (in s).
- Type:
“tm02”
- FSPR#
The normalised width of the frequency spectrum.
- Type:
“fspr”
- DSPR#
Directional spreading of the waves (in degrees).
- Type:
“dspr”
- QP#
Peakedness of the wave spectrum (dimensionless).
- Type:
“qp”
- DEPTH#
Water depth (in m).
- Type:
“depth”
- WATLEV#
Water level (in m).
- Type:
“watlev”
- BOTLEV#
Bottom level (in m).
- Type:
“botlev”
- VEL#
Current velocity (vector; in m/s).
- Type:
“vel”
- FRCOEF#
Friction coefficient (equal to cfw or kn in command FRICTION).
- Type:
“frcoef”
- WIND#
Wind velocity (vector; in m/s).
- Type:
“wind”
- AICE#
Ice concentration (as a fraction from 0 to 1).
- Type:
“aice”
- PROPAGAT#
Sum of PROPXY, PROPTHETA and PROPSIGMA (in W/m2 or m2/s).
- Type:
“propagat”
- PROPXY#
Energy propagation in geographic space; sum of x- and y-direction (in W/m2 or m2/s).
- Type:
“propxy”
- PROPTHETA#
Energy propagation in theta space (in W/m2 or m2/s).
- Type:
“proptheta”
- PROPSIGMA#
Energy propagation in sigma space (in W/m2 or m2/s).
- Type:
“propsigma”
- GENERAT#
Total energy generation (in W/m2 or m2/s).
- Type:
“generat”
- GENWIND#
Energy generation due to wind (in W/m2 or m2/s).
- Type:
“genwind”
- REDIST#
Total energy redistribution (in W/m2 or m2/s).
- Type:
“redist”
- REDQUAD#
Energy redistribution due to quadruplets (in W/m2 or m2/s).
- Type:
“redquad”
- REDTRIAD#
Energy redistribution due to triads (in W/m2 or m2/s).
- Type:
“redtriad”
- DISSIP#
Total energy dissipation (in W/m2 or m2/s).
- Type:
“dissip”
- DISBOT#
Energy dissipation due to bottom friction (in W/m2 or m2/s).
- Type:
“disbot”
- DISSURF#
Energy dissipation due to surf breaking (in W/m2 or m2/s).
- Type:
“dissurf”
- DISWCAP#
Energy dissipation due to whitecapping (in W/m2 or m2/s).
- Type:
“diswcap”
- DISSWELL#
Energy dissipation due to swell dissipation (in W/m2 or m2/s).
- Type:
“disswell”
- DISVEG#
Energy dissipation due to vegetation (in W/m2 or m2/s).
- Type:
“disveg”
- DISMUD#
Energy dissipation due to mud (in W/m2 or m2/s).
- Type:
“dismud”
- DISICE#
Energy dissipation due to sea ice (in W/m2 or m2/s).
- Type:
“disice”
- RADSTR#
Energy transfer between waves and currents due to radiation stress (in W/m2 or m2/s).
- Type:
“radstr”
- QB#
Fraction of breaking waves due to depth-induced breaking.
- Type:
“qb”
- TRANSP#
Transport of energy (vector; in W/m2 or m2/s).
- Type:
“transp”
- FORCE#
Wave-induced force per unit surface area (vector; in N/m2).
- Type:
“force”
- UBOT#
The rms-value of the maxima of the orbital velocity near the bottom (in m/s).
- Type:
“ubot”
- URMS#
The rms-value of the orbital velocity near the bottom (in m/s).
- Type:
“urms”
- TMBOT#
The bottom wave period (in s).
- Type:
“tmbot”
- WLENGTH#
Average wave length (in m).
- Type:
“wlength”
- LWAVP#
Peak wave length (in m).
- Type:
“lwavp”
- STEEPNESS#
Average wave steepness (dimensionless).
- Type:
“steepness”
- BFI#
Benjamin-Feir index (dimensionless).
- Type:
“bfi”
- NPLANTS#
Number of plants per square meter.
- Type:
“nplants”
- DHSIGN#
Difference in significant wave height from the last two iterations (in m).
- Type:
“dhsign”
- DRTM01#
Difference in average wave period (RTM01) from the last two iterations (in s).
- Type:
“drtm01”
- LEAK#
Numerical loss of energy equal to cthetaE(omega,theta) across boundaries.
- Type:
“leak”
- TIME#
Full date-time string as part of line used in TABLE only.
- Type:
“time”
- TSEC#
Time in seconds with respect to a reference time (see command QUANTITY).
- Type:
“tsec”
- XP#
The x-coordinate in the problem coordinate system of the output location.
- Type:
“xp”
- YP#
The y-coordinate in the problem coordinate system of the output location.
- Type:
“yp”
- 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).
- Type:
“dist”
- SETUP#
Set-up due to waves (in m).
- Type:
“setup”
- PTHSIGN#
Watershed partitions of the significant wave height (in m).
- Type:
“pthsign”
- PTRTP#
Watershed partitions of the relative peak period (in s).
- Type:
“ptrtp”
- PTWLEN#
Watershed partitions of the average wave length (in m).
- Type:
“ptwlen”
- PTDIR#
Watershed partitions of the peak wave direction (in degrees).
- Type:
“ptdir”
- PTDSPR#
Watershed partitions of the directional spreading (in degrees).
- Type:
“ptdspr”
- PTWFRAC#
Watershed partitions of the wind fraction (dimensionless).
- Type:
“ptwfrac”
- PTSTEEPNE#
Watershed partition of the wave steepness (dimensionless).
- Type:
“ptsteepne”
- PARTITION#
The raw spectral partition for wave system tracking post-processing.
- Type:
“partition”
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).
- __init__()#
Methods
encode([encoding, errors])Encode the string using the codec registered for encoding.
replace(old, new[, count])Return a copy with all occurrences of substring old replaced by new.
split([sep, maxsplit])Return a list of the substrings in the string, using sep as the separator string.
rsplit([sep, maxsplit])Return a list of the substrings in the string, using sep as the separator string.
join(iterable, /)Concatenate any number of strings.
capitalize()Return a capitalized version of the string.
casefold()Return a version of the string suitable for caseless comparisons.
title()Return a version of the string where each word is titlecased.
center(width[, fillchar])Return a centered string of length width.
count(sub[, start[, end]])Return the number of non-overlapping occurrences of substring sub in string S[start:end].
expandtabs([tabsize])Return a copy where all tab characters are expanded using spaces.
find(sub[, start[, end]])Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].
partition(sep, /)Partition the string into three parts using the given separator.
index(sub[, start[, end]])Return the lowest index in S where substring sub is found, such that sub is contained within S[start:end].
ljust(width[, fillchar])Return a left-justified string of length width.
lower()Return a copy of the string converted to lowercase.
lstrip([chars])Return a copy of the string with leading whitespace removed.
rfind(sub[, start[, end]])Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].
rindex(sub[, start[, end]])Return the highest index in S where substring sub is found, such that sub is contained within S[start:end].
rjust(width[, fillchar])Return a right-justified string of length width.
rstrip([chars])Return a copy of the string with trailing whitespace removed.
rpartition(sep, /)Partition the string into three parts using the given separator.
splitlines([keepends])Return a list of the lines in the string, breaking at line boundaries.
strip([chars])Return a copy of the string with leading and trailing whitespace removed.
swapcase()Convert uppercase characters to lowercase and lowercase characters to uppercase.
translate(table, /)Replace each character in the string using the given translation table.
upper()Return a copy of the string converted to uppercase.
startswith(prefix[, start[, end]])Return True if S starts with the specified prefix, False otherwise.
endswith(suffix[, start[, end]])Return True if S ends with the specified suffix, False otherwise.
removeprefix(prefix, /)Return a str with the given prefix string removed if present.
removesuffix(suffix, /)Return a str with the given suffix string removed if present.
isascii()Return True if all characters in the string are ASCII, False otherwise.
islower()Return True if the string is a lowercase string, False otherwise.
isupper()Return True if the string is an uppercase string, False otherwise.
istitle()Return True if the string is a title-cased string, False otherwise.
isspace()Return True if the string is a whitespace string, False otherwise.
isdecimal()Return True if the string is a decimal string, False otherwise.
isdigit()Return True if the string is a digit string, False otherwise.
isnumeric()Return True if the string is a numeric string, False otherwise.
isalpha()Return True if the string is an alphabetic string, False otherwise.
isalnum()Return True if the string is an alpha-numeric string, False otherwise.
isidentifier()Return True if the string is a valid Python identifier, False otherwise.
isprintable()Return True if the string is printable, False otherwise.
zfill(width, /)Pad a numeric string with zeros on the left, to fill a field of the given width.
format(*args, **kwargs)Return a formatted version of S, using substitutions from args and kwargs.
format_map(mapping)Return a formatted version of S, using substitutions from mapping.
maketransReturn a translation table usable for str.translate().
Attributes