Merge dev-cbind to dev (c-bindings updates) #2863

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

andrew-platt merged 86 commits into dev from dev-cbind

Jun 17, 2025

.github/workflows/automated-dev-tests.yml

-Original file line number
+Diff line change
@@ Expand Up / @@ -79,6 +79,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
           - name: Setup workspace
@@ Expand Down Expand Up / @@ -136,6 +137,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
           - name: Setup workspace
@@ Expand Down Expand Up / @@ -258,6 +260,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -316,6 +319,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -366,6 +370,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -415,6 +420,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -466,6 +472,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -513,6 +520,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -561,6 +569,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down Expand Up / @@ -608,6 +617,7 @@ jobs: @@
           - name: Install dependencies
             run: |
               pip install -r requirements.txt
+              pip install glue-codes/python/.   # Installs the interface library
               sudo apt-get update -y
               sudo apt-get install -y libopenblas-dev libopenblas-openmp-dev
               sudo apt-get install -y libhdf5-dev libnetcdf-dev libopenmpi-dev libyaml-cpp-dev
@@ Expand Down @@

.gitignore

-Original file line number
+Diff line change
@@ Expand Up / @@ -29,6 +29,7 @@ @@
     *.app
     __pycache__/*
     *.pyc
+    *.egg-info
     # Build specific files
     build*/
@@ Expand Down @@

glue-codes/CMakeLists.txt

-Original file line number
+Diff line change
@@ -1,5 +1,6 @@
     add_subdirectory(openfast)
+    add_subdirectory(labview)
     if(BUILD_OPENFAST_CPP_API)
        add_subdirectory(openfast-cpp)
@@ Expand Down @@

glue-codes/fast-farm/src/FAST_Farm_Subs.f90

-Original file line number
+Diff line change
@@ Expand Up / @@ -813,6 +813,9 @@ SUBROUTINE Farm_InitMD( farm, ErrStat, ErrMsg ) @@
        ALLOCATE( farm%MD%Input( 2 ), farm%MD%InputTimes( 2 ), STAT = ErrStat2 )
        if (Failed0("MD%Input and MD%InputTimes.")) return;
+       ! Assign the SS pointer of the first SS instance (turbine 1) to MD. Because MD in FF mode will only pull frequency info, instance of SS doesn't matter (error will be thrown by MD if user asks for SS grid).
+       MD_InitInp%WaveField => farm%FWrap(1)%m%Turbine%SeaSt%p%WaveField ! this is the same wave field as Init%OutData_SeaSt%WaveField in FAST_subs.f90 (as set by line 278 in SeaSt_Init). Cant use Init%OutData_SeaSt%WaveField because Init is a local variable to FAST_InitializeAll
        ! initialize MoorDyn
        CALL MD_Init( MD_InitInp, farm%MD%Input(1), farm%MD%p, farm%MD%x, farm%MD%xd, farm%MD%z, &
                      farm%MD%OtherSt, farm%MD%y, farm%MD%m, farm%p%DT_mooring, MD_InitOut, ErrStat2, ErrMsg2 )
@@ Expand Down @@

glue-codes/labview/CMakeLists.txt

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    #
+    # Copyright 2025 National Renewable Energy Laboratory
+    #
+    # Licensed under the Apache License, Version 2.0 (the "License");
+    # you may not use this file except in compliance with the License.
+    # You may obtain a copy of the License at
+    #
+    #     http://www.apache.org/licenses/LICENSE-2.0
+    #
+    # Unless required by applicable law or agreed to in writing, software
+    # distributed under the License is distributed on an "AS IS" BASIS,
+    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    # See the License for the specific language governing permissions and
+    # limitations under the License.
+    #
+    add_library(wavetanktestinglib SHARED
+        src/WaveTank.f90
+    )
+    target_link_libraries(wavetanktestinglib aerodyn_inflow_c_binding moordyn_c_binding seastate_c_binding nwtclibs versioninfolib)
+    if(APPLE OR UNIX)
+        target_compile_definitions(wavetanktestinglib PRIVATE IMPLICIT_DLLEXPORT)
+    endif()
+    install(TARGETS wavetanktestinglib
+    EXPORT "${CMAKE_PROJECT_NAME}Libraries"
+    RUNTIME DESTINATION bin
+    LIBRARY DESTINATION lib
+    ARCHIVE DESTINATION lib)

glue-codes/labview/src/WaveTank.f90

-Original file line number
+Diff line change
@@ -0,0 +1,228 @@
+    MODULE WaveTankTesting
+        USE ISO_C_BINDING
+        USE NWTC_Library
+        ! USE Precision
+        USE MoorDyn_C
+        USE SeaState_C_Binding
+        USE NWTC_C_Binding, ONLY: IntfStrLen, SetErr
+        IMPLICIT NONE
+        SAVE
+        PUBLIC :: WaveTank_Init
+        REAL(C_DOUBLE) :: dt_c = 0.01_C_DOUBLE  ! 100 hertz
+        REAL(C_FLOAT) :: g_c = 9.8065_C_FLOAT
+        REAL(C_FLOAT) :: rho_c = 1025.0_C_FLOAT
+        REAL(C_FLOAT) :: depth_c = 200.0_C_FLOAT
+        REAL(C_FLOAT), DIMENSION(6) :: ptfminit_c = 0.0_C_FLOAT
+        INTEGER(C_INT) :: interporder_c = 2     ! 1: linear (uses two time steps) or 2: quadratic (uses three time steps)
+        INTEGER(C_INT) :: N_CAMERA_POINTS
+        INTEGER(C_INT) :: load_period = 20 ! seconds
+    CONTAINS
+    SUBROUTINE SetErrStat_C(ErrStatLocal, ErrMessLocal, ErrStatGlobal, ErrMessGlobal, RoutineName)
+    INTEGER(C_INT), INTENT(IN   )               :: ErrStatLocal      ! Error status of the operation
+    CHARACTER(*, KIND=C_CHAR),   INTENT(IN   )  :: ErrMessLocal      ! Error message if ErrStat /= ErrID_None
+    INTEGER(C_INT), INTENT(INOUT)               :: ErrStatGlobal     ! Error status of the operation
+    CHARACTER(KIND=C_CHAR),   INTENT(INOUT)     :: ErrMessGlobal     ! Error message if ErrStat /= ErrID_None
+    CHARACTER(*),   INTENT(IN   )               :: RoutineName  ! Name of the routine error occurred in
+    IF ( ErrStatLocal == ErrID_None ) RETURN
+    IF (ErrStatGlobal /= ErrID_None) ErrMessGlobal = TRIM(ErrMessGlobal)//new_line('a')
+    ErrMessGlobal = TRIM(ErrMessGlobal)//TRIM(RoutineName)//':'//TRIM(ErrMessLocal)
+    ErrStatGlobal = MAX(ErrStatGlobal,ErrStatLocal)
+    END SUBROUTINE
+    SUBROUTINE WaveTank_Init(   &
+        MD_InputFile_c,         &
+        SS_InputFile_c,         &
+        AD_InputFile_c,         &
+        IfW_InputFile_c,        &
+        n_camera_points_c,      &
+        ErrStat_c,              &
+        ErrMsg_c                &
+    ) BIND (C, NAME='WaveTank_Init')
+    #ifndef IMPLICIT_DLLEXPORT
+    !DEC$ ATTRIBUTES DLLEXPORT :: WaveTank_Init
+    !GCC$ ATTRIBUTES DLLEXPORT :: WaveTank_Init
+    #endif
+    IMPLICIT NONE
+    CHARACTER(KIND=C_CHAR), INTENT(IN   ), TARGET :: MD_InputFile_c(IntfStrLen)
+    CHARACTER(KIND=C_CHAR), INTENT(IN   ), TARGET :: SS_InputFile_c(IntfStrLen)
+    CHARACTER(KIND=C_CHAR), INTENT(IN   ), TARGET :: AD_InputFile_c(IntfStrLen)
+    CHARACTER(KIND=C_CHAR), INTENT(IN   ), TARGET :: IfW_InputFile_c(IntfStrLen)
+    INTEGER(C_INT),         INTENT(IN   ) :: n_camera_points_c
+    INTEGER(C_INT),         INTENT(  OUT) :: ErrStat_C
+    CHARACTER(KIND=C_CHAR), INTENT(  OUT) :: ErrMsg_C(ErrMsgLen_C)
+    ! Local variables
+    integer(c_int) :: numchannels_c
+    character(kind=c_char) :: outputchannelnames_c(100000)
+    character(kind=c_char) :: outputchannelunits_c(100000)
+    integer(c_int) :: input_file_passed = 0                         ! We're passing paths to input files rather than input strings for all modules
+    ! character(kind=c_char), pointer :: filestring_c(IntfStrLen)     ! Point to input file path input argument
+    print *, MD_InputFile_c
+    print *, SS_InputFile_c
+    print *, AD_InputFile_c
+    print *, IfW_InputFile_c
+    N_CAMERA_POINTS = n_camera_points_c
+    ! filestring_c => MD_InputFile_c
+    ! call MD_C_Init(                 &
+    !     input_file_passed,          &
+    !     filestring_c,               &
+    !     IntfStrLen,                 &
+    !     dt_c,                       &
+    !     g_c,                        &
+    !     rho_c,                      &
+    !     depth_c,                    &
+    !     ptfminit_c,                 &
+    !     interporder_c,              &
+    !     numchannels_c,              &
+    !     outputchannelnames_c,       &
+    !     outputchannelunits_c,       &
+    !     ErrStat_C, ErrMsg_C         &
+    ! )
+    ! call ADI_C_Init(                &
+    !     ADinputFilePassed,          &  ! integer(c_int),            intent(in   )  :: ADinputFilePassed                      !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    !     ADinputFileString_C,        &  ! type(c_ptr),               intent(in   )  :: ADinputFileString_C                    !< Input file as a single string with lines deliniated by C_NULL_CHAR
+    !     ADinputFileStringLength_C,  &  ! integer(c_int),            intent(in   )  :: ADinputFileStringLength_C              !< lenght of the input file string
+    !     IfWinputFilePassed,         &  ! integer(c_int),            intent(in   )  :: IfWinputFilePassed                     !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    !     IfWinputFileString_C,       &  ! type(c_ptr),               intent(in   )  :: IfWinputFileString_C                   !< Input file as a single string with lines deliniated by C_NULL_CHAR
+    !     IfWinputFileStringLength_C, &  ! integer(c_int),            intent(in   )  :: IfWinputFileStringLength_C             !< lenght of the input file string
+    !     OutRootName_C,              &  ! character(kind=c_char),    intent(in   )  :: OutRootName_C(IntfStrLen)              !< Root name to use for echo files and other
+    !     OutVTKDir_C,                &  ! character(kind=c_char),    intent(in   )  :: OutVTKDir_C(IntfStrLen)                !< Directory to put all vtk output
+    !     gravity_C,                  &  ! real(c_float),             intent(in   )  :: gravity_C                              !< Gravitational acceleration (m/s^2)
+    !     defFldDens_C,               &  ! real(c_float),             intent(in   )  :: defFldDens_C                           !< Air density (kg/m^3)
+    !     defKinVisc_C,               &  ! real(c_float),             intent(in   )  :: defKinVisc_C                           !< Kinematic viscosity of working fluid (m^2/s)
+    !     defSpdSound_C,              &  ! real(c_float),             intent(in   )  :: defSpdSound_C                          !< Speed of sound in working fluid (m/s)
+    !     defPatm_C,                  &  ! real(c_float),             intent(in   )  :: defPatm_C                              !< Atmospheric pressure (Pa) [used only for an MHK turbine cavitation check]
+    !     defPvap_C,                  &  ! real(c_float),             intent(in   )  :: defPvap_C                              !< Vapour pressure of working fluid (Pa) [used only for an MHK turbine cavitation check]
+    !     WtrDpth_C,                  &  ! real(c_float),             intent(in   )  :: WtrDpth_C                              !< Water depth (m)
+    !     MSL2SWL_C,                  &  ! real(c_float),             intent(in   )  :: MSL2SWL_C                              !< Offset between still-water level and mean sea level (m) [positive upward]
+    !     InterpOrder_C,              &  ! integer(c_int),            intent(in   )  :: InterpOrder_C                          !< Interpolation order to use (must be 1 or 2)
+    !     DT_C,                       &  ! real(c_double),            intent(in   )  :: DT_C                                   !< Timestep used with AD for stepping forward from t to t+dt.  Must be constant.
+    !     TMax_C,                     &  ! real(c_double),            intent(in   )  :: TMax_C                                 !< Maximum time for simulation
+    !     storeHHVel,                 &  ! integer(c_int),            intent(in   )  :: storeHHVel                             !< Store hub height time series from IfW
+    !     WrVTK_in,                   &  ! integer(c_int), intent(in   ) :: WrVTK_in        !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    !     WrVTK_inType,               &  ! integer(c_int), intent(in   ) :: WrVTK_inType    !< Write VTK outputs as [1: surface, 2: lines, 3: both]
+    !     WrVTK_inDT,                 &  ! real(c_double), intent(in   ) :: WrVTK_inDT      !< Timestep between VTK writes
+    !     VTKNacDim_in,               &  ! real(c_float),  intent(in   ) :: VTKNacDim_in(6) !< Nacelle dimension passed in for VTK surface rendering [0,y0,z0,Lx,Ly,Lz] (m)
+    !     VTKHubRad_in,               &  ! real(c_float),  intent(in   ) :: VTKHubrad_in    !< Hub radius for VTK surface rendering
+    !     wrOuts_C,                   &
+    !     DT_Outs_C,                  &
+    !     NumChannels_C,              &
+    !     OutputChannelNames_C,       &
+    !     OutputChannelUnits_C,       &
+    !     ErrStat_C, ErrMsg_C         &
+    ! )
+    ! ! Input file info
+    ! integer(c_int),            intent(in   )  :: ADinputFilePassed                      !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    ! type(c_ptr),               intent(in   )  :: ADinputFileString_C                    !< Input file as a single string with lines deliniated by C_NULL_CHAR
+    ! integer(c_int),            intent(in   )  :: ADinputFileStringLength_C              !< lenght of the input file string
+    ! integer(c_int),            intent(in   )  :: IfWinputFilePassed                     !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    ! type(c_ptr),               intent(in   )  :: IfWinputFileString_C                   !< Input file as a single string with lines deliniated by C_NULL_CHAR
+    ! integer(c_int),            intent(in   )  :: IfWinputFileStringLength_C             !< lenght of the input file string
+    ! character(kind=c_char),    intent(in   )  :: OutRootName_C(IntfStrLen)              !< Root name to use for echo files and other
+    ! character(kind=c_char),    intent(in   )  :: OutVTKDir_C(IntfStrLen)                !< Directory to put all vtk output
+    ! ! Environmental
+    ! real(c_float),             intent(in   )  :: gravity_C                              !< Gravitational acceleration (m/s^2)
+    ! real(c_float),             intent(in   )  :: defFldDens_C                           !< Air density (kg/m^3)
+    ! real(c_float),             intent(in   )  :: defKinVisc_C                           !< Kinematic viscosity of working fluid (m^2/s)
+    ! real(c_float),             intent(in   )  :: defSpdSound_C                          !< Speed of sound in working fluid (m/s)
+    ! real(c_float),             intent(in   )  :: defPatm_C                              !< Atmospheric pressure (Pa) [used only for an MHK turbine cavitation check]
+    ! real(c_float),             intent(in   )  :: defPvap_C                              !< Vapour pressure of working fluid (Pa) [used only for an MHK turbine cavitation check]
+    ! real(c_float),             intent(in   )  :: WtrDpth_C                              !< Water depth (m)
+    ! real(c_float),             intent(in   )  :: MSL2SWL_C                              !< Offset between still-water level and mean sea level (m) [positive upward]
+    ! ! Interpolation
+    ! integer(c_int),            intent(in   )  :: InterpOrder_C                          !< Interpolation order to use (must be 1 or 2)
+    ! ! Time
+    ! real(c_double),            intent(in   )  :: DT_C                                   !< Timestep used with AD for stepping forward from t to t+dt.  Must be constant.
+    ! real(c_double),            intent(in   )  :: TMax_C                                 !< Maximum time for simulation
+    ! ! Flags
+    ! integer(c_int),            intent(in   )  :: storeHHVel                             !< Store hub height time series from IfW
+    ! ! VTK
+    ! integer(c_int),            intent(in   )  :: WrVTK_in                               !< Write VTK outputs [0: none, 1: init only, 2: animation]
+    ! integer(c_int),            intent(in   )  :: WrVTK_inType                           !< Write VTK outputs as [1: surface, 2: lines, 3: both]
+    ! real(c_double),            intent(in   )  :: WrVTK_inDT                             !< Timestep between VTK writes
+    ! real(c_float),             intent(in   )  :: VTKNacDim_in(6)                        !< Nacelle dimension passed in for VTK surface rendering [0,y0,z0,Lx,Ly,Lz] (m)
+    ! real(c_float),             intent(in   )  :: VTKHubrad_in                           !< Hub radius for VTK surface rendering
+    ! integer(c_int),            intent(in   )  :: wrOuts_C                               !< Write ADI output file
+    ! real(c_double),            intent(in   )  :: DT_Outs_C                              !< Timestep to write output file from ADI
+    ! ! Output
+    ! integer(c_int),            intent(  out)  :: NumChannels_C                          !< Number of output channels requested from the input file
+    ! character(kind=c_char),    intent(  out)  :: OutputChannelNames_C(ChanLen*MaxADIOutputs+1)    !< NOTE: if MaxADIOutputs is sufficiently large, we may overrun the buffer on the Python side.
+    ! character(kind=c_char),    intent(  out)  :: OutputChannelUnits_C(ChanLen*MaxADIOutputs+1)
+    ! integer(c_int),            intent(  out)  :: ErrStat_C                              !< Error status
+    ! character(kind=c_char),    intent(  out)  :: ErrMsg_C(ErrMsgLen_C)                  !< Error message (C_NULL_CHAR terminated)
+    ! Set compiler flag for Labview
+    ! Cmpl4LV   = .TRUE.
+    END SUBROUTINE WaveTank_Init
+    ! delta_time,                 &
+    SUBROUTINE WaveTank_CalcOutput( &
+        frame_number,               &
+        positions_x,                &
+        positions_y,                &
+        positions_z,                &
+        rotation_matrix,            &
+        loads,                      &
+        ErrStat_c,                  &
+        ErrMsg_c                    &
+    ) BIND (C, NAME='WaveTank_CalcOutput')
+    #ifndef IMPLICIT_DLLEXPORT
+    !DEC$ ATTRIBUTES DLLEXPORT :: WaveTank_CalcOutput
+    !GCC$ ATTRIBUTES DLLEXPORT :: WaveTank_CalcOutput
+    #endif
+    IMPLICIT NONE
+    ! INTEGER(C_INT)                        :: delta_time
+    INTEGER(C_INT)                        :: frame_number
+    REAL(C_FLOAT),          INTENT(IN   ) :: positions_x(N_CAMERA_POINTS)
+    REAL(C_FLOAT),          INTENT(IN   ) :: positions_y(N_CAMERA_POINTS)
+    REAL(C_FLOAT),          INTENT(IN   ) :: positions_z(N_CAMERA_POINTS)
+    REAL(C_FLOAT),          INTENT(IN   ) :: rotation_matrix(9)
+    REAL(C_FLOAT),          INTENT(  OUT) :: loads(N_CAMERA_POINTS)
+    INTEGER(C_INT),         INTENT(  OUT) :: ErrStat_C
+    CHARACTER(KIND=C_CHAR), INTENT(  OUT) :: ErrMsg_C(ErrMsgLen_C)
+    INTEGER :: i
+    IF ( MOD(frame_number / load_period, 2) == 0 ) THEN
+        loads = -1.0
+    ELSE
+        loads = 1.0
+    ENDIF
+    END SUBROUTINE
+    SUBROUTINE WaveTank_End() bind (C, NAME="WaveTank_End")
+    IMPLICIT NONE
+    END SUBROUTINE
+    end module WaveTankTesting

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge dev-cbind to dev (c-bindings updates) #2863

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!