rompy.swan.types.BoundShapeOptions

class rompy.swan.types.BoundShapeOptions(value)

Valid options for the boundary shape type.

JONSWAP

JONSWAP spectrum.

Type:

“jonswap”

PM

Pierson-Moskowitz spectrum.

Type:

“pm”

GAUSS

Gaussian spectrum.

Type:

“gauss”

BIN

Energy at a single bin spectrum.

Type:

“bin”

TMA

TMA spectrum.

Type:

“tma”

__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.
maketrans	Return a translation table usable for str.translate().

Attributes

JONSWAP
PM
GAUSS
BIN
TMA