h2lib 13.1.901__py3-none-win_amd64.whl → 13.1.1701__py3-none-win_amd64.whl

h2lib/_h2lib.py

@@ -21,6 +21,7 @@ _ERROR_CODES = {
     300: ValueError("TOO_FEW_SECTIONS_IN_C2DEF"),
     301: ValueError("BEAM_TOO_SHORT"),
     302: ValueError("DIFFERENT_NSEC"),
+    500: ValueError("RELATIVE_ROTATION_NOT_FOUND"),
     700: RuntimeError("SYSTEM_NOT_LINEARIZED"),
     701: RuntimeError("SYSTEM_EIGENANALYSIS_NOT_DONE"),
     702: ValueError("TOO_MANY_MODES_REQUESTED"),
@@ -47,11 +48,9 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         # doubles the speed of single instances and 2N of N instances on linux
         os.environ['MKL_THREADING_LAYER'] = 'sequential'
         filename = os.path.abspath(filename)
-        p = Path(np.__file__).parents
-        for i in range(2, 4):
-            if (p[i] / 'Library/bin').exists():
-                os.add_dll_directory(p[i] / 'Library/bin')
-                break
+        for f in [sys.base_prefix, sys.prefix]:
+            if os.path.isdir(os.path.join(f, 'Library/bin')):
+                os.add_dll_directory(os.path.join(f, 'Library/bin'))
         DLLWrapper.__init__(self, filename, cwd=cwd, cdecl=True)
         self.suppress_output = suppress_output
         self._initialized = False
@@ -89,6 +88,23 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         s = " " * 255
         return H2LibSignatures.get_version(self, s)[0][0].strip()
 
+    def stop_on_error(self, flag):
+        """
+        Control if HAWC2 will terminate the execution upon encountering an error. The default HAWC2 behavior is to stop.
+
+        Parameters
+        ----------
+        flag : bool
+            If set to `True` an error will cause HAWC2 to terminate the execution with status code 1.
+            If set to `False` HAWC2 will still print a log message but not stop.
+
+        Returns
+        -------
+        None.
+
+        """
+        H2LibSignatures.stop_on_error(self, bool(flag))
+
     def get_wind_speed(self, pos_g):
         return self.get_lib_function('get_wind_speed')(np.asarray(pos_g, dtype=np.float64),
                                                        np.asarray([0, 0, 0], dtype=np.float64))[0][1]
@@ -378,23 +394,23 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
 
     def set_orientation_base(
         self,
-        main_body_name,
+        main_body,
         mbdy_eulerang_table=None,
         angles_in_deg=True,
         reset_orientation=False,
         mbdy_ini_rotvec_d1=None,
     ):
         """
-        Set an orientation / base command.
+        Set an `orientation` / `base` command.
 
-        Function equivalent to the HAWC2 command orientation / base.
+        Function equivalent to the HAWC2 command `orientation` / `base`.
         For further details see the HAWC2 documentation.
-        We assume that this base is already present in the htc file,
+        We assume that this base orientation is already present in the htc file,
         and therefore modify it here instead of creating a new one.
 
         Parameters
         ----------
-        main_body_name : str
+        main_body : str
             Main body name. Same as HAWC2 `mbdy` parameter.
         mbdy_eulerang_table : (:, 3) ndarray, optional
             A sequence of Euler angles, one per row.
@@ -402,7 +418,7 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
             A 1D array with 3 elements will be interpreted as 1 row.
             This table is additive with respect to the orientation / base command in the htc file,
             unless the flag `reset_orientation` is used.
-            The default is `[0, 0, 0]`, which means that the base is coincident with the global frame.
+            The default is `[0, 0, 0]`, which means that no rotation is applied.
         angles_in_deg : bool, optional
             `True` if the angles in `mbdy_eulerang_table` are provided in degrees.
             `False` if they are in radians.
@@ -418,7 +434,7 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         Raises
         ------
         ValueError
-            If the orientation / base command cannot be found.
+            If the `orientation` / `base` command cannot be found.
 
         Returns
         -------
@@ -434,9 +450,9 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         error_code = -1
         error_code = H2LibSignatures.set_orientation_base(
             self,
-            main_body_name,
-            np.asfortranarray(mbdy_eulerang_table.astype(np.float64)),
+            main_body,
             mbdy_eulerang_table.shape[0],
+            np.asfortranarray(mbdy_eulerang_table.astype(np.float64)),
             angles_in_deg,
             reset_orientation,
             np.asfortranarray(mbdy_ini_rotvec_d1.astype(np.float64)),
@@ -446,6 +462,97 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         if error_code > 0:
             raise _ERROR_CODES[error_code]
 
+    def set_orientation_relative(
+        self,
+        main_body_1,
+        node_1,
+        main_body_2,
+        node_2,
+        mbdy2_eulerang_table=None,
+        angles_in_deg=True,
+        reset_orientation=False,
+        mbdy2_ini_rotvec_d1=None,
+    ):
+        """
+        Set an `orientation` / `relative` command.
+
+        Function equivalent to the HAWC2 command `orientation` / `relative`.
+        For further details see the HAWC2 documentation.
+        We assume that this relative orientation is already present in the htc file,
+        and therefore modify it here instead of creating a new one.
+
+        Parameters
+        ----------
+        main_body_1 : str
+            Main body name to which the next main body is attached.
+        node_1 : int, str
+            Node number of `main_body_1` that is used for connection, starting from 0.
+            `"last"` can be specified which ensures that the last node on the main_body
+            is used, and `-1` refers to the origin of the main body coordinate system.
+        main_body_2 : str
+            Main_body name of the `main_body` that is positioned
+            in space by the relative command.
+        node_2 : int, str
+            Node number of `main_body_2` that is used for connection, starting from 0.
+            `"last"` can be specified which ensures that the last node on the main_body
+            is used, and `-1` refers to the origin of the main body coordinate system.
+        mbdy2_eulerang_table : : (:, 3) ndarray, optional
+            A sequence of Euler angles, one per row.
+            Equivalent to HAWC2 command `mbdy2_eulerang`.
+            A 1D array with 3 elements will be interpreted as 1 row.
+            This table is additive with respect to the orientation / relative command in the htc file,
+            unless the flag `reset_orientation` is used.
+            The default is `[0, 0, 0]`, which means that no rotation is applied.
+        angles_in_deg : bool, optional
+            `True` if the angles in `mbdy2_eulerang_table` are provided in degrees.
+            `False` if they are in radians.
+            The default is `True`.
+        reset_orientation : bool, optional,
+            If `True` this function will reset the orientation to no rotation
+            before applying `mbdy2_eulerang_table`. The default is `False`.
+        mbdy2_ini_rotvec_d1 : (4) ndarray, optional
+            Angular velocity. First 3 elements for the direction and last for the magnitude.
+            Equivalent to HAWC2 command `mbdy2_ini_rotvec_d1`.
+            The default is 0 speed.
+
+        Raises
+        ------
+        ValueError
+            If the `orientation` / `relative` command cannot be found,
+            or if the main bodies do not exist.
+
+        Returns
+        -------
+        None.
+
+        """
+        if mbdy2_eulerang_table is None:
+            mbdy2_eulerang_table = np.zeros((1, 3), dtype=np.float64, order="F")
+        if mbdy2_ini_rotvec_d1 is None:
+            mbdy2_ini_rotvec_d1 = np.zeros((4,), dtype=np.float64, order="F")
+        # 1D arrays are converted to 2D with 1 row.
+        mbdy2_eulerang_table = np.atleast_2d(mbdy2_eulerang_table)
+        # Convert node_1 and 2 to int.
+        if node_1 == "last":
+            node_1 = -2
+        if node_2 == "last":
+            node_2 = -2
+        error_code = -1
+        error_code = H2LibSignatures.set_orientation_relative(
+            self,
+            main_body_1,
+            node_1 + 1,
+            main_body_2,
+            node_2 + 1,
+            mbdy2_eulerang_table.shape[0],
+            np.asfortranarray(mbdy2_eulerang_table.astype(np.float64)),
+            bool(angles_in_deg),
+            reset_orientation,
+            np.asfortranarray(mbdy2_ini_rotvec_d1.astype(np.float64)),
+            error_code)[0][-1]
+        if error_code > 0:
+            raise _ERROR_CODES[error_code]
+
     def init_windfield(self, Nxyz, dxyz, box_offset_yz, transport_speed):
         """Initialize wind field which afterwards can be set using set_windfield
 
@@ -540,10 +647,12 @@ class H2LibThread(H2LibSignatures, DLLWrapper):
         return self._aero_sections_data_shape[rotor]
 
     def get_aerosections_position(self, rotor=0):
+        """Global xyz position of aero sections. Shape=(#blades, #sections, 3)"""
         position = np.zeros(self.aero_sections_data_shape(rotor), dtype=np.float64, order='F')
         return H2LibSignatures.get_aerosections_position(self, rotor + 1, position)[0][1]
 
     def set_aerosections_windspeed(self, uvw, rotor=0):
+        """Update wind speed at aero sections. uvw shape=(#blades, #sections, 3)"""
         return H2LibSignatures.set_aerosections_windspeed(self, rotor + 1, np.asarray(uvw, np.float64))
 
     def get_aerosections_forces(self, rotor=0):

h2lib/_version.py

@@ -1,4 +1,4 @@
 # This file is autogenerated and should not be modified manually
-__version__ = '13.1.901'
-h2lib_version = '13.1.901'
-hawc2_version = '13.1.9+5-g2026dd7'
+__version__ = '13.1.1701'
+h2lib_version = '13.1.1701'
+hawc2_version = '13.1.17'

h2lib/h2lib_signatures.py

@@ -356,19 +356,44 @@ end subroutine'''
         return self.get_lib_function('set_aerosections_windspeed')(rotor, uvw)
 
     def set_orientation_base(self, main_body_name,
-                             mbdy_eulerang_table, n_rows, angles_in_deg, reset_orientation, mbdy_ini_rotvec_d1,
+                             n_rows, mbdy_eulerang_table, angles_in_deg, reset_orientation, mbdy_ini_rotvec_d1,
                              error_code):
-        '''subroutine set_orientation_base(main_body_name,&
+        '''subroutine set_orientation_base(main_body_name,  &
 character(kind=c_char, len=1), dimension(256), intent(in) :: main_body_name
-integer(kind=4), intent(in) :: n_rows
+real(kind=c_double), dimension(n_rows, 3),   intent(in) :: mbdy_eulerang_table
 logical, intent(in) :: angles_in_deg
 logical, intent(in) :: reset_orientation
 real(kind=c_double), dimension(4),   intent(in) :: mbdy_ini_rotvec_d1
 end subroutine'''
         return self.get_lib_function('set_orientation_base')(main_body_name,
-                                                             mbdy_eulerang_table, n_rows, angles_in_deg, reset_orientation, mbdy_ini_rotvec_d1,
+                                                             n_rows, mbdy_eulerang_table, angles_in_deg, reset_orientation, mbdy_ini_rotvec_d1,
                                                              error_code)
 
+    def set_orientation_relative(self, main_body_1_name, node_1, main_body_2_name, node_2,
+                                 n_rows, mbdy2_eulerang_table, angles_in_deg,
+                                 reset_orientation,
+                                 mbdy2_ini_rotvec_d1,
+                                 error_code):
+        '''subroutine set_orientation_relative(main_body_1_name, node_1, main_body_2_name, node_2,  &
+character(kind=c_char, len=1),   dimension(256),       intent(in   ) :: main_body_1_name  ! Defined as an array of length 1 characters because of bind.
+character(kind=c_char, len=1),   dimension(256),       intent(in   ) :: main_body_2_name  ! Defined as an array of length 1 characters because of bind.
+integer(kind=8),                                       intent(in   ) :: node_1
+integer(kind=8),                                       intent(in   ) :: node_2
+real(kind=c_double),             dimension(n_rows, 3), intent(in   ) :: mbdy2_eulerang_table
+logical,                                               intent(in   ) :: angles_in_deg
+character(kind=c_char, len=256) :: mbdy_1_name  ! Same as main_body_1_name, but as string instead of an array of characters.
+character(kind=c_char, len=256) :: mbdy_2_name  ! Same as main_body_2_name, but as string instead of an array of characters.
+type(Tmain_body_input), pointer :: main_body_1  ! The main body pointer associated to main_body_1_name.
+type(Tmain_body_input), pointer :: main_body_2  ! The main body pointer associated to main_body_1_name.
+integer(kind=4) :: node_1_local, node_2_local     ! Internal copy of node_1 and node_2.
+real*8, dimension(3) :: eulerang                ! Euler angles associated to 1 row of mbdy2_eulerang_table.
+end subroutine'''
+        return self.get_lib_function('set_orientation_relative')(main_body_1_name, node_1, main_body_2_name, node_2,
+                                                                 n_rows, mbdy2_eulerang_table, angles_in_deg,
+                                                                 reset_orientation,
+                                                                 mbdy2_ini_rotvec_d1,
+                                                                 error_code)
+
     def set_variable_sensor_value(self, id, value):
         '''subroutine set_variable_sensor_value(id, value) bind(C, name="set_variable_sensor_value")
       integer*8, intent(in) :: id
@@ -426,6 +451,12 @@ end subroutine'''
     end function'''
         return self.get_lib_function('step')(restype=restype)
 
+    def stop_on_error(self, flag):
+        '''subroutine stop_on_error(flag) bind(C, name="stop_on_error")
+      logical, intent(in) :: flag
+    end subroutine'''
+        return self.get_lib_function('stop_on_error')(flag)
+
     def test_hdf5(self, ):
         '''subroutine test_hdf5() BIND(C, NAME='test_hdf5')
   !DEC$ ATTRIBUTES DLLEXPORT :: test_hdf5

{h2lib-13.1.901.dist-info → h2lib-13.1.1701.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: h2lib
-Version: 13.1.901
-Summary: Python interface to HAWC2 (13.1.9+5-g2026dd7)
+Version: 13.1.1701
+Summary: Python interface to HAWC2 (13.1.17)
 Download-URL: 
 Author: Mads M. Pedersen, S.G.Horcas and N.G.Ramos
 Author-email: mmpe@dtu.dk
@@ -11,11 +11,10 @@ Project-URL: Documentation, https://hawc2.pages.windenergy.dtu.dk/HAWC2Lib/
 Project-URL: Source, https://gitlab.windenergy.dtu.dk/HAWC2/HAWC2Lib
 Project-URL: Tracker, https://gitlab.windenergy.dtu.dk/HAWC2/HAWC2Lib/-/issues
 Requires-Dist: numpy
-Requires-Dist: intel-fortran-rt ==2021.3.0
-Requires-Dist: mkl ==2021.3.0
-Requires-Dist: multiclass-interface >=1.5
-Provides-Extra: mpi
-Requires-Dist: mpi4py ; extra == 'mpi'
+Requires-Dist: intel-fortran-rt==2021.3.0
+Requires-Dist: mkl==2021.3.0
+Requires-Dist: multiclass_interface>=1.5
 Provides-Extra: test
-Requires-Dist: h2lib-tests ; extra == 'test'
-
+Requires-Dist: h2lib_tests; extra == "test"
+Provides-Extra: mpi
+Requires-Dist: mpi4py; extra == "mpi"

h2lib-13.1.1701.dist-info/RECORD

@@ -0,0 +1,10 @@
+h2lib/HAWC2Lib.dll,sha256=2f3ye1UAvxStkuQdfZ45KsPuWatlk6OKQIRGFRM-qD4,30801920
+h2lib/__init__.py,sha256=f3fO4I6IEFRM9LaV2O3w9Pioj3GPI8qRl7P5Tg5ONtE,528
+h2lib/_h2lib.py,sha256=oCWMTpkui3KIxuZrQcyecBAv-KBKx0exTf3UC1WTJzc,35053
+h2lib/_version.py,sha256=aoq7oNXs_pDNUhj3g7OPtlrQRPyElXusqp2iqfeyvps,149
+h2lib/dll_wrapper.py,sha256=CfuRfDPEmmfYlEGKUmiXiuMhNiMcf24ripPHgqd8CiE,12761
+h2lib/h2lib_signatures.py,sha256=1CuaSNfaTgnbhqcSaehQGNVHhKpvLFwgs2UucKWVQJE,24289
+h2lib-13.1.1701.dist-info/METADATA,sha256=LiH31EtB7-lMnREX8IcRQ3Sj1V7F5HhJJ8W_yEjiF7s,722
+h2lib-13.1.1701.dist-info/WHEEL,sha256=pWXrJbnZSH-J-PhYmKs2XNn4DHCPNBYq965vsBJBFvA,101
+h2lib-13.1.1701.dist-info/top_level.txt,sha256=y_a-tUqphEZQ_0nsWSMaSb21P8Lsd8hUxUdE9g2Dcbk,6
+h2lib-13.1.1701.dist-info/RECORD,,

{h2lib-13.1.901.dist-info → h2lib-13.1.1701.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.2.0)
+Generator: setuptools (75.6.0)
 Root-Is-Purelib: false
 Tag: cp312-cp312-win_amd64
 

h2lib-13.1.901.dist-info/RECORD

@@ -1,10 +0,0 @@
-h2lib/HAWC2Lib.dll,sha256=sIZhsbsubvdSV1FYMFwm3o182LX443SmME3ak8QwLWM,30803968
-h2lib/__init__.py,sha256=f3fO4I6IEFRM9LaV2O3w9Pioj3GPI8qRl7P5Tg5ONtE,528
-h2lib/_h2lib.py,sha256=povKoDnyzYF2xET29CxkBYKSYJc5yRjn7J4Xdw8qTow,30363
-h2lib/_version.py,sha256=36To1Vn7m9W0-ewELpaoXNd4wDAXEYhnaDUyBw5QI-k,157
-h2lib/dll_wrapper.py,sha256=CfuRfDPEmmfYlEGKUmiXiuMhNiMcf24ripPHgqd8CiE,12761
-h2lib/h2lib_signatures.py,sha256=BknUitXekKaOH9reEHDnBPN-ThAHFeHnfdD41UlJ8Y8,21780
-h2lib-13.1.901.dist-info/METADATA,sha256=IEbAB9rC-p8IT1nmtagD7xSRUhaY0l7vAZNYqeZg5_U,738
-h2lib-13.1.901.dist-info/WHEEL,sha256=62QJgqtUFevqILau0n0UncooEMoOyVCKVQitJpcuCig,101
-h2lib-13.1.901.dist-info/top_level.txt,sha256=y_a-tUqphEZQ_0nsWSMaSb21P8Lsd8hUxUdE9g2Dcbk,6
-h2lib-13.1.901.dist-info/RECORD,,