wawi 0.0.17__py3-none-any.whl → 0.0.18__py3-none-any.whl

wawi/__init__.py

@@ -3,7 +3,7 @@
 '''
 __pdoc__ = {'wawi.ext.abq': False}
 
-__version__ = "0.0.17"
+__version__ = "0.0.18"
 
 # Other packages
 import numpy as np

wawi/plot.py

@@ -134,9 +134,8 @@ def save_plot(pl, path, w=None, h=None):
 
     pl.screenshot(path, window_size=[w,h], return_img=False)
 
-def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]), 
-                        ax=None, n_repeats=2, crest_length=1000,
-                        alpha_crests=0.2, arrow_options={}):
+def plot_dir_and_crests(theta0, Tp, U=0.0, thetaU=0.0, arrow_length=100, origin=np.array([0,0]), add_text=True, 
+                        ax=None, n_repeats=2, crest_length=1000, arrow_options={}, crest_options={}):
     
     """
     Plot wave direction arrow and wave crests on a matplotlib axis.
@@ -147,6 +146,10 @@ def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]),
         Wave direction in degrees (0 degrees is along the x-axis).
     Tp : float
         Peak wave period in seconds.
+    U : float, optional
+        Uniform current velocity [m/s]. Default is 0.0.
+    thetaU : float, optional
+        Angle of current in degrees. Default is 0.0.
     arrow_length : float, optional
         Length of the direction arrow (default is 100).
     origin : np.ndarray, optional
@@ -157,10 +160,13 @@ def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]),
         Number of wave crests to plot (default is 2).
     crest_length : float, optional
         Length of each wave crest line (default is 1000).
-    alpha_crests : float, optional
-        Transparency (alpha) for the crest lines (default is 0.2).
     arrow_options : dict, optional
         Additional keyword arguments for the arrow (default is {}).
+    crest_options : dict, optional
+        Additional keyword arguments for the crest lines (default is {})
+    add_text : bool, optional
+        Whether or not to add text annotation, default is True.
+    
 
     Returns
     -------
@@ -174,8 +180,8 @@ def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]),
 
     Docstring generated by GitHub Copilot.
     """
-    arr_opts = {'head_width': 4, 'width':2, 'edgecolor':'none'}
-    arr_opts.update(**arrow_options)
+    arrow_options = {'head_width': 4, 'width':2, 'edgecolor':'none'} | arrow_options
+    crest_options = {'alpha': 0.2, 'color': 'black'} | crest_options
 
     if ax is None:
         ax = plt.gca()
@@ -183,10 +189,19 @@ def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]),
     # Plot wave angle and crests
     v = np.array([np.cos(theta0*np.pi/180), np.sin(theta0*np.pi/180)])
     v_norm = np.array([-np.sin(theta0*np.pi/180), np.cos(theta0*np.pi/180)])
-    wave_length = 2*np.pi/get_kappa(2*np.pi/Tp, U=0.0)
 
-    plt.arrow(origin[0],origin[1], arrow_length*v[0], arrow_length*v[1], **arr_opts)
-    plt.text(origin[0], origin[1], f'$\\theta_0$ = {theta0}$^o$\n $T_p$={Tp} s\n $\\lambda=${wave_length:.0f} m')
+    theta_rel_U = (thetaU - theta0)*180/np.pi
+    wave_length = 2*np.pi/get_kappa(2*np.pi/Tp, U=U, theta_rel_U=theta_rel_U)
+    
+    plt.arrow(origin[0],origin[1], arrow_length*v[0], arrow_length*v[1], **arrow_options)
+
+    if add_text:
+        plot_string = f'$\\theta_0$ = {theta0}$^o$\n $T_p$={Tp} s\n $\\lambda=${wave_length:.0f} m'
+
+        if U != 0.0:
+            plot_string = plot_string + f'\nU = {U:.1f}m/s @ {thetaU:.1f} deg'
+    
+        plt.text(origin[0], origin[1], plot_string)
 
     dv = v*wave_length
     for n in range(n_repeats):
@@ -194,9 +209,10 @@ def plot_dir_and_crests(theta0, Tp, arrow_length=100, origin=np.array([0,0]),
         p2 = origin+v_norm*crest_length/2
         pts = np.vstack([p1,p2])
         
-        ax.plot(pts[:,0], pts[:,1], alpha=alpha_crests, color='black', zorder=0)
+        ax.plot(pts[:,0], pts[:,1], zorder=0, **crest_options)
         origin = origin + dv
 
+    ax.axis('equal')
     return ax
 
 def rotate_image_about_pivot(Z, x, y, angle, x0=0, y0=0):

wawi/wave.py

@@ -878,7 +878,7 @@ def dirdist_robust(s, theta0=0, dtheta=1e-4, theta=None):
     return D
 
     
-def dispersion_relation_scalar(w, h=np.inf, g=9.81, U=0.0):
+def dispersion_relation_scalar(w, h=np.inf, g=9.81, U=0.0, theta_rel_U=0.0):
     """
     Compute the wave number `k` from the dispersion relation for surface gravity waves.
 
@@ -892,6 +892,8 @@ def dispersion_relation_scalar(w, h=np.inf, g=9.81, U=0.0):
         Gravitational acceleration [m/s^2]. Default is 9.81.
     U : float, optional
         Uniform current velocity [m/s]. Default is 0.0.
+    theta_rel_U : float, optional
+        Relative angle between current and wave direction, i.e., theta_current - theta_wave in rad.
 
     Returns
     -------
@@ -912,10 +914,12 @@ def dispersion_relation_scalar(w, h=np.inf, g=9.81, U=0.0):
 
     """
 
+    Uproj = U * np.cos(theta_rel_U)
+
     if h==np.inf:
-        f = lambda k: g*k - (w-k*U)**2
+        f = lambda k: g*k - (w-k*Uproj)**2
     else:
-        f = lambda k: g*k*np.tanh(k*h) - (w-k*U)**2
+        f = lambda k: g*k*np.tanh(k*h) - (w-k*Uproj)**2
         
     k0 = w**2/g     # deep-water, zero-current wave number
     

wawi/wind.py

@@ -808,19 +808,18 @@ def element_aero_mats(B, omega, ad_dict, L, T=None, phi=None, rho=1.225):
 # Spectra
 def kaimal_auto(omega, Lx, A, sigma, V):
     """
-    Kaimal auto-spectral density function.
+    Kaimal auto-spectral density function (either single-component or three components).
 
     Parameters
     ----------
     omega : float
-
         Angular frequency.
-    Lx : float
-        Length scale.
-    A : float
-        Amplitude.
-    sigma : float
-        Standard deviation of the turbulence.
+    Lx : float or np.ndarray
+        Integral length scale(s).
+    A : float or np.ndarray
+        Spectral shape parameter(s).
+    sigma : float or np.ndarray
+        Standard deviation(s) of the turbulence.
     V : float   
         Mean wind speed.
 
@@ -838,16 +837,16 @@ def kaimal_auto(omega, Lx, A, sigma, V):
 
 def von_karman_auto(omega, Lx, sigma, V):
     """
-    Von Karman auto-spectral density function.
+    Von Karman auto-spectral density function (either single-component or three components).
     
     Parameters
     ----------
     omega : float
         Angular frequency.
-    Lx : float
-        Length scale.
-    sigma : float
-        Standard deviation of the turbulence.
+    Lx : float or np.ndarray
+        Integral length scale(s).
+    sigma : float or np.ndarray
+        Standard deviation(s) of the turbulence.
     V : float
         Mean wind speed.
     Returns

{wawi-0.0.17.dist-info → wawi-0.0.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wawi
-Version: 0.0.17
+Version: 0.0.18
 Summary: WAve and WInd response prediction
 Author-email: "Knut A. Kvåle" <knut.a.kvale@ntnu.no>, Ole Øiseth <ole.oiseth@ntnu.no>, Aksel Fenerci <aksel.fenerci@ntnu.no>, Øivind Wiig Petersen <oyvind.w.petersen@ntnu.no>
 License: MIT License
@@ -92,17 +92,51 @@ pip install git+https://www.github.com/knutankv/wawi.git@main
 How does WAWI work?
 ======================
 By representing both aerodynamic and hydrodynamic motion-induced forces and excitation using a coordinate basis defined by the dry in-vacuum mode shapes of the structure, WAWI is able to versatily predict response based on input from any commercial FE software. The main structure used for response prediction is given in this figure:
+
 ![Model](https://raw.githubusercontent.com/knutankv/wawi/main/docs/flowchart.svg)
 
 The object structure of a WAWI model is given here:
-![Modelattributes](https://raw.githubusercontent.com/knutankv/wawi/main/docs/structure.svg)
+
+![Model attributes](https://raw.githubusercontent.com/knutankv/wawi/main/docs/structure.svg)
 
 Further details regarding hydrodynamic definitions initiated by the `Hydro` class is given below:
+
 ![Hydro](https://raw.githubusercontent.com/knutankv/wawi/main/docs/hydro_part.svg)
 
 Further details regarding aerodynamic definitions initiated by the `Aero` class is given below:
+
 ![Aero](https://raw.githubusercontent.com/knutankv/wawi/main/docs/aero_part.svg)
 
+Wave conditions
+----------------------
+The wave field definition is based on the assumption that the two-dimensional wave spectral density can be decomposed into a directional distribution and a one-dimensional wave spectral density, i.e.,  $S_\eta(\omega,\theta) = D(\theta) S(\omega)$. The two factors are defined using these well-known formulations:
+
+* $S(\omega)$: JONSWAP spectrum  (see [Hasselmann et al., 1973](https://pure.mpg.de/pubman/faces/ViewItemOverviewPage.jsp?itemId=item_3262854))
+* $D(\theta)$: cos-2s directional distribution (see Longuet-Higgins et al., 1963)
+
+Currents are defined by a homogeneous current speed `U` and corresponding direction `thetaU`.
+
+An example of a two-dimensional wave spectral density based on (arbitrarily chosen) parameters $H_s = 2.1$ m, $T_p = 2.1$ s, $\gamma = 4.0$, $s = 10$ and $\theta_0 = 75^\circ$ is shown in this plot:
+
+![2D wave PSD](https://raw.githubusercontent.com/knutankv/wawi/main/docs/wave_S2d.png)
+
+It is noted that you can easily assign custom functions of the `S` and `D` of the seastate (or customly on all pontoons for full control) instead of relying on the built in JONSWAP and cos-2s definitions.
+
+Wind conditions
+----------------------
+The wind field is defined by single-point turbulence wind spectra (for all turbulence components $u$, $v$ and $w$) and coherence definitions.
+
+By default, wind spectra can be defined using these two definitions:
+
+* Kaimal spectrum defined by length scale parameters ($L^x_u$, $L^x_v$, $L^x_w$), spectral shape parameters ($A_u$, $A_v$ and $A_w$) and turbulence intensities ($I_u$, $I_v$ and $I_w$); see [Kaimal et al., 1972](https://www.climatexchange.nl/projects/alteddy/papers/Kaimal-1972.pdf)
+* von Karmán spectrum defined by only length scale parameters ($L^x_u$, $L^x_v$, $L^x_w$) and turbulence intensities ($I_u=\sigma_u/U$, $I_v=\sigma_v/U$ and $I_w=\sigma_w/U$); see [von Kármán, 1948](http://dx.doi.org/10.1073/pnas.34.11.530)
+
+Furthermore, the coherence of the wind field is defined by the nine decay parameters $C_{ux}$, $C_{vx}$, $C_{wx}$, $C_{uy}$, $C_{vy}$, $C_{wy}$, $C_{uz}$ $C_{vz}$, $C_{wz}$; see e.g. [Simiu and Scanlan, 1996](https://library.wur.nl/WebQuery/titel/1606468) for details.
+
+An example of turbulence spectral densities based on (arbitrarily chosen) parameters $I_u=0.136$, $I_v=0.0$, $I_w=0.072$, $L^x_u=115$, $L^x_w=9.58$, $A_u=6.8$ (only relevant for Kaimal-type) and $A_w=9.4$ (only relevant for Kaimal-type) is given below:
+
+![1D turbulence PSD](https://raw.githubusercontent.com/knutankv/wawi/main/docs/wind_psd.png)
+
 
 Quick start
 =======================
@@ -181,16 +215,20 @@ References
 =======================
 The following papers provide background for the implementation:
 
-* Beam (FE) description of aerodynamic forces: [Øiseth et al. (2012)](https://www.sciencedirect.com/science/article/abs/pii/S0168874X11001880)
 * Wave modelling and response prediction: [Kvåle et al. (2016)](https://www.sciencedirect.com/science/article/abs/pii/S004579491500334X)
 * Inhomogeneous wave modelling: [Kvåle et al. (2024)](https://www.sciencedirect.com/science/article/pii/S0141118723003437)
 * Hydrodynamic interaction effects: [Fenerci et al. (2022)](https://www.sciencedirect.com/science/article/pii/S095183392200017X)
+* Beam (FE) description of aerodynamic forces: [Øiseth et al. (2012)](https://www.sciencedirect.com/science/article/abs/pii/S0168874X11001880)
 * Wave-current interaction: [Fredriksen et al. (2024)](https://www.researchgate.net/profile/Arnt-Fredriksen/publication/386453916_On_the_wave-current_interaction_effect_on_linear_motion_for_floating_bridges/links/6751a40fabddbb448c65cbef/On-the-wave-current-interaction-effect-on-linear-motion-for-floating-bridges.pdf)
 
 
 Citation
 =======================
-Zenodo research entry: [![DOI](https://zenodo.org/badge/921621297.svg)](https://doi.org/10.5281/zenodo.14895014)
+Please cite the use of this software as follows:
+
+Kvåle, K. A., Fenerci, A., Petersen, Ø. W., & Øiseth, O. A. (2025). WAWI. Zenodo. https://doi.org/10.5281/zenodo.15482552
+[![DOI](https://zenodo.org/badge/921621297.svg)](https://doi.org/10.5281/zenodo.14895014)
+
 
 Support
 =======================

{wawi-0.0.17.dist-info → wawi-0.0.18.dist-info}/RECORD

@@ -4,21 +4,21 @@ tests/test_IABSE_step11a.py,sha256=zTWOxR78F0PNhNqiqodEcL65vdJXyMP78nkJumhy-RA,7
 tests/test_IABSE_step11c.py,sha256=TfxPlP70dhujKlSYbA-Gj4U-EJmYZ3jt6yjvX9wSXcA,10337
 tests/test_IABSE_step2a.py,sha256=9pAd1em2IEY4k5N-jAigV3VGup0QsbUxnwSiziuMbUg,10134
 tests/test_wind.py,sha256=r4rx6f8Tn-u4fn4gGPBMrL_JJQ2SVHGQiQ9sQuMQCPo,1707
-wawi/__init__.py,sha256=brqzCB0aImDc_fgazfOzS96O5S215IrmbT_1V_YMcIk,183
+wawi/__init__.py,sha256=9LICE2nsa6XkgFeTM-0jQ7ztS3HrW15QrTAKq_1UIg8,183
 wawi/fe.py,sha256=wohMq-VGZnxZzfFGucWJXVrVLsD4MAS3jQs_P-HtyKI,12769
 wawi/general.py,sha256=Yt5DjDhzqNoYkQwu5nDZun-Kp_KqhV4DRLnMhUAYcQ0,23455
 wawi/identification.py,sha256=QDaz-ptH4_hXLTwLIEb28gr_KNiIiz3EQAgbNKXKZRI,2318
 wawi/io.py,sha256=DP0e7B8KBWLN8mMhWEeZIV17d_lObi_jCySX40ZdljQ,36475
 wawi/modal.py,sha256=NAqPQFqJVoPi26u32Pr8ekhL5dg_HAWfCMMmBmN1-3c,36504
-wawi/plot.py,sha256=uHMDElGO3Td3JwwETLVPImJ-L6QxJO3RzHmgQVBbcj4,30304
+wawi/plot.py,sha256=gVoGjJoiKqGr0-6BBFFNPuZcUdiQwGzEFmdHswGeKzc,30878
 wawi/prob.py,sha256=JBDU9OB-ksBD9zDG0FZ05dTh47aO3mRhS_l1zpcCx8c,954
 wawi/random.py,sha256=3M7w07QzMmgRLsVs1V-DbNJnn1r8a7yY8vFpsiq0hug,5596
 wawi/signal.py,sha256=NTKgd7nHLy5onub1dfwe4AvvrNB6FtKGXEnL9LvE0Ao,3715
 wawi/structural.py,sha256=tptswGb5rZUXzqZkOI0odfSXpgtDALTYMAmJJ_LZORk,14344
 wawi/time_domain.py,sha256=8sSmp61E6HnopuQxP-lTR3fQHXkyPeVFNF6PZqcxVWQ,10048
 wawi/tools.py,sha256=Jgfk2wzKwKUv5OsQh1oGQI2bcK8Xa3togwntFEScK2Q,1004
-wawi/wave.py,sha256=AjPtsXvq2sPt5gMG9848BjAMjmLin2NhOlSsm2d6OUA,33598
-wawi/wind.py,sha256=tUEKKTW1evB6YXErvEWZzM_T8nF6jcbKpnhEv0ipjbo,62104
+wawi/wave.py,sha256=75mQCgFtwrokCAF9y6RqwkLRcyOYjnu2MQkoLBXUFPc,33794
+wawi/wind.py,sha256=uFybNXckq4u1S9uaWT9rW6JN8GbCZ_vHgsz-dLjAPt0,62313
 wawi/wind_code.py,sha256=r39K7-jvjat7gWlaNpv-JlPjDOZo8gwqgDNZ8TYFvZg,1202
 wawi/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wawi/ext/abq.py,sha256=Wo-Zzb6b3lr_z7cNKTW-NdYJuVeAwZgwzlGhF_5Jym0,8905
@@ -31,8 +31,8 @@ wawi/model/_dry.py,sha256=KpmFlSinoY6DrSyc3Y0M8w1-cCC7VCFep-uzcqZsHz4,3940
 wawi/model/_hydro.py,sha256=7kzOqKou9RV1KoYXC-6oVw8gtnqfC-NfeohLFDiL-uI,27107
 wawi/model/_model.py,sha256=0Z5wBUFRzO_yKTF_HogUhE2-5oBkGLfVQU1qclNioVo,53306
 wawi/model/_screening.py,sha256=NRYkKq928z2lqMSUTpbQLls04td_9R_4dhkjU3Gv1oQ,3716
-wawi-0.0.17.dist-info/licenses/LICENSE,sha256=bH1aWhrNbbPLrYnVFRaoYYzcUr-figHjry-kGB7Tc54,1076
-wawi-0.0.17.dist-info/METADATA,sha256=PQt0sdJDdzzZqmcWIkFXhgyc9Zdcl8yMsipkd2WGY8s,9502
-wawi-0.0.17.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
-wawi-0.0.17.dist-info/top_level.txt,sha256=Nk5G_ZwgZRCb9ZMWZdr1M3QIskX6kCnlqeMl67N3zg8,20
-wawi-0.0.17.dist-info/RECORD,,
+wawi-0.0.18.dist-info/licenses/LICENSE,sha256=bH1aWhrNbbPLrYnVFRaoYYzcUr-figHjry-kGB7Tc54,1076
+wawi-0.0.18.dist-info/METADATA,sha256=g17rbdBIRVuADZp6n21xYLd5swNGm4gCbxGucWwqM8U,12228
+wawi-0.0.18.dist-info/WHEEL,sha256=zaaOINJESkSfm_4HQVc5ssNzHCPXhJm0kEUakpsEHaU,91
+wawi-0.0.18.dist-info/top_level.txt,sha256=Nk5G_ZwgZRCb9ZMWZdr1M3QIskX6kCnlqeMl67N3zg8,20
+wawi-0.0.18.dist-info/RECORD,,