refactor bmi adapters into their own library

NOAA-OWP · Nov 7, 2023 · c0fb8c0 · c0fb8c0
1 parent 1af2edf
commit c0fb8c0
Show file tree

Hide file tree

Showing 26 changed files with 55 additions and 15 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -193,6 +193,7 @@ target_include_directories(ngen PUBLIC "${NGEN_INC_DIR}")
 
 add_subdirectory("src/core")
 add_subdirectory("src/geojson")
+add_subdirectory("src/bmi")
 add_subdirectory("src/realizations/catchment")
 add_subdirectory("src/forcing")
 add_subdirectory("src/utilities/mdarray")

diff --git a/...ions/catchment/AbstractCLibBmiAdapter.hpp → include/bmi/AbstractCLibBmiAdapter.hpp b/...ions/catchment/AbstractCLibBmiAdapter.hpp → include/bmi/AbstractCLibBmiAdapter.hpp
diff --git a/...de/realizations/catchment/Bmi_Adapter.hpp → include/bmi/Bmi_Adapter.hpp b/...de/realizations/catchment/Bmi_Adapter.hpp → include/bmi/Bmi_Adapter.hpp
diff --git a/.../realizations/catchment/Bmi_C_Adapter.hpp → include/bmi/Bmi_C_Adapter.hpp b/.../realizations/catchment/Bmi_C_Adapter.hpp → include/bmi/Bmi_C_Adapter.hpp
diff --git a/...ealizations/catchment/Bmi_Cpp_Adapter.hpp → include/bmi/Bmi_Cpp_Adapter.hpp b/...ealizations/catchment/Bmi_Cpp_Adapter.hpp → include/bmi/Bmi_Cpp_Adapter.hpp
diff --git a/...zations/catchment/Bmi_Fortran_Adapter.hpp → include/bmi/Bmi_Fortran_Adapter.hpp b/...zations/catchment/Bmi_Fortran_Adapter.hpp → include/bmi/Bmi_Fortran_Adapter.hpp
diff --git a/...alizations/catchment/Bmi_Fortran_Common.h → include/bmi/Bmi_Fortran_Common.h b/...alizations/catchment/Bmi_Fortran_Common.h → include/bmi/Bmi_Fortran_Common.h
diff --git a/...realizations/catchment/Bmi_Py_Adapter.hpp → include/bmi/Bmi_Py_Adapter.hpp b/...realizations/catchment/Bmi_Py_Adapter.hpp → include/bmi/Bmi_Py_Adapter.hpp
diff --git a/...ealizations/catchment/State_Exception.hpp → include/bmi/State_Exception.hpp b/...ealizations/catchment/State_Exception.hpp → include/bmi/State_Exception.hpp
diff --git a/src/realizations/catchment/Bmi_C_Adapter.cpp → src/bmi/Bmi_C_Adapter.cpp b/src/realizations/catchment/Bmi_C_Adapter.cpp → src/bmi/Bmi_C_Adapter.cpp
diff --git a/...ealizations/catchment/Bmi_Cpp_Adapter.cpp → src/bmi/Bmi_Cpp_Adapter.cpp b/...ealizations/catchment/Bmi_Cpp_Adapter.cpp → src/bmi/Bmi_Cpp_Adapter.cpp
diff --git a/...zations/catchment/Bmi_Fortran_Adapter.cpp → src/bmi/Bmi_Fortran_Adapter.cpp b/...zations/catchment/Bmi_Fortran_Adapter.cpp → src/bmi/Bmi_Fortran_Adapter.cpp
diff --git a/...realizations/catchment/Bmi_Py_Adapter.cpp → src/bmi/Bmi_Py_Adapter.cpp b/...realizations/catchment/Bmi_Py_Adapter.cpp → src/bmi/Bmi_Py_Adapter.cpp
diff --git a/src/bmi/CMakeLists.txt b/src/bmi/CMakeLists.txt
@@ -0,0 +1,24 @@
+include(${PROJECT_SOURCE_DIR}/cmake/dynamic_sourced_library.cmake)
+dynamic_sourced_cxx_library(ngen_bmi "${CMAKE_CURRENT_SOURCE_DIR}")
+
+add_library(NGen::ngen_bmi ALIAS ngen_bmi)
+
+target_include_directories(ngen_bmi PUBLIC
+        ${PROJECT_SOURCE_DIR}/include/
+        ${PROJECT_SOURCE_DIR}/include/bmi
+        ${PROJECT_SOURCE_DIR}/include/geojson
+        ${PROJECT_SOURCE_DIR}/include/core/mediator
+        )
+
+target_link_libraries(ngen_bmi PUBLIC
+        ${CMAKE_DL_LIBS}
+        NGen::logging
+        )
+
+if(NGEN_WITH_PYTHON)
+   target_link_libraries(ngen_bmi PUBLIC pybind11::embed)
+endif()
+
+if(NGEN_WITH_BMI_FORTRAN)
+    target_link_libraries(ngen_bmi PUBLIC bmi_fortran_iso_c)
+endif()
diff --git a/src/core/CMakeLists.txt b/src/core/CMakeLists.txt
@@ -16,6 +16,8 @@ target_include_directories(core PUBLIC
         ${PROJECT_SOURCE_DIR}/include/forcing
         ${PROJECT_SOURCE_DIR}/include/utilities
         ${PROJECT_SOURCE_DIR}/extern/pybind11/include
+        ${PROJECT_SOURCE_DIR}/include/realizations/catchment
+        ${PROJECT_SOURCE_DIR}/include/bmi
         )
 
 if (NGEN_WITH_PYTHON)

diff --git a/src/core/catchment/CMakeLists.txt b/src/core/catchment/CMakeLists.txt
@@ -8,6 +8,7 @@ target_include_directories(core_catchment PUBLIC
         ${PROJECT_SOURCE_DIR}/include/core/catchment
         ${PROJECT_SOURCE_DIR}/include/forcing
         ${PROJECT_SOURCE_DIR}/include/utilities
+        ${PROJECT_SOURCE_DIR}/include/realizations/catchment
         )
 
 target_link_libraries(core_catchment PUBLIC

diff --git a/src/core/hydrolocation/CMakeLists.txt b/src/core/hydrolocation/CMakeLists.txt
@@ -9,6 +9,8 @@ target_include_directories(core_hydrolocation PUBLIC
         ${PROJECT_SOURCE_DIR}/include/core/catchment
         ${PROJECT_SOURCE_DIR}/include/forcing
         ${PROJECT_SOURCE_DIR}/include/utilities
+        ${PROJECT_SOURCE_DIR}/include/realizations/catchment
+        ${PROJECT_SOURCE_DIR}/include/geojson
         )
 
 target_link_libraries(core_hydrolocation PUBLIC

diff --git a/src/core/nexus/CMakeLists.txt b/src/core/nexus/CMakeLists.txt
@@ -10,6 +10,8 @@ target_include_directories(core_nexus PUBLIC
         ${PROJECT_SOURCE_DIR}/include/core/catchment
         ${PROJECT_SOURCE_DIR}/include/forcing
         ${PROJECT_SOURCE_DIR}/include/utilities
+        ${PROJECT_SOURCE_DIR}/include/realizations/catchment
+        ${PROJECT_SOURCE_DIR}/include/geojson
         )
 
 target_link_libraries(core_nexus PUBLIC

diff --git a/src/realizations/catchment/CMakeLists.txt b/src/realizations/catchment/CMakeLists.txt
@@ -11,19 +11,14 @@ target_include_directories(realizations_catchment PUBLIC
         ${PROJECT_SOURCE_DIR}/include/simulation_time
         ${PROJECT_SOURCE_DIR}/include/utilities
         ${PROJECT_SOURCE_DIR}/include/geojson
+        ${PROJECT_SOURCE_DIR}/include/bmi
         )
 
 target_link_libraries(realizations_catchment PUBLIC
         ${CMAKE_DL_LIBS}
         NGen::core_catchment
         NGen::geojson
         NGen::logging
+        NGen::ngen_bmi
         )
 
-if(NGEN_WITH_PYTHON)
-   target_link_libraries(realizations_catchment PUBLIC pybind11::embed)
-endif()
-
-if(NGEN_WITH_BMI_FORTRAN)
-    target_link_libraries(realizations_catchment PUBLIC bmi_fortran_iso_c)
-endif()
diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
@@ -65,6 +65,9 @@ function(ngen_add_test TESTNAME)
 
     if(NGEN_TEST_CREATE)
         add_executable(${TESTNAME} ${NGEN_TEST_OBJECTS})
+        target_include_directories(${TESTNAME} PUBLIC
+            ${CMAKE_CURRENT_LIST_DIR}/bmi
+        )
         target_link_libraries(${TESTNAME} PUBLIC gtest gtest_main ${NGEN_TEST_LIBRARIES})
         set_target_properties(${TESTNAME} PROPERTIES FOLDER test)
         gtest_discover_tests(
@@ -113,6 +116,7 @@ ngen_add_test(
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
         testbmicppmodel
 
 )
@@ -194,27 +198,29 @@ ngen_add_test(
 ngen_add_test(
     test_bmi_cpp
     OBJECTS
-        realizations/catchments/Bmi_Cpp_Adapter_Test.cpp
+        bmi/Bmi_Cpp_Adapter_Test.cpp
         realizations/catchments/Bmi_Cpp_Formulation_Test.cpp
     LIBRARIES
         NGen::core
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
 )
 
 ########################## BMI C Tests
 ngen_add_test(
     test_bmi_c
     OBJECTS
-        realizations/catchments/Bmi_C_Adapter_Test.cpp
+        bmi/Bmi_C_Adapter_Test.cpp
         realizations/catchments/Bmi_C_Formulation_Test.cpp
     LIBRARIES
         gmock
         NGen::core
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
     REQUIRES
         NGEN_WITH_BMI_C
 )
@@ -223,13 +229,14 @@ ngen_add_test(
 ngen_add_test(
     test_bmi_fortran
     OBJECTS
-        realizations/catchments/Bmi_Fortran_Adapter_Test.cpp
+        bmi/Bmi_Fortran_Adapter_Test.cpp
         realizations/catchments/Bmi_Fortran_Formulation_Test.cpp
     LIBRARIES
         NGen::core
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
     REQUIRES
         NGEN_WITH_BMI_FORTRAN
 )
@@ -238,13 +245,14 @@ ngen_add_test(
 ngen_add_test(
     test_bmi_python
     OBJECTS
-        realizations/catchments/Bmi_Py_Adapter_Test.cpp
+        bmi/Bmi_Py_Adapter_Test.cpp
         realizations/catchments/Bmi_Py_Formulation_Test.cpp
     LIBRARIES
         NGen::core
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
     REQUIRES
         NGEN_WITH_PYTHON
 )
@@ -260,17 +268,18 @@ ngen_add_test(
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
 )
 
 ########################## All BMI Unit Tests
 ngen_add_test(
     test_bmi_unit_all
     OBJECTS
-        realizations/catchments/Bmi_C_Adapter_Test.cpp
+        bmi/Bmi_C_Adapter_Test.cpp
         realizations/catchments/Bmi_C_Formulation_Test.cpp
-        realizations/catchments/Bmi_Fortran_Adapter_Test.cpp
+        bmi/Bmi_Fortran_Adapter_Test.cpp
         realizations/catchments/Bmi_Fortran_Formulation_Test.cpp
-        realizations/catchments/Bmi_Py_Adapter_Test.cpp
+        bmi/Bmi_Py_Adapter_Test.cpp
         realizations/catchments/Bmi_Py_Formulation_Test.cpp
         realizations/catchments/Bmi_Multi_Formulation_Test.cpp
     LIBRARIES
@@ -279,6 +288,7 @@ ngen_add_test(
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
     REQUIRES
         NGEN_WITH_BMI_C
         NGEN_WITH_BMI_FORTRAN
@@ -296,6 +306,7 @@ ngen_add_test(
         NGen::realizations_catchment
         NGen::core_mediator
         NGen::forcing
+        NGen::ngen_bmi
 )
 
 ########################## Routing Tests
@@ -372,6 +383,7 @@ ngen_add_test(
         NGen::mdarray
         NGen::mdframe
         NGen::logging
+        NGen::ngen_bmi
         testbmicppmodel
 
 )
@@ -409,5 +421,6 @@ ngen_add_test(
         NGen::mdarray
         NGen::mdframe
         NGen::logging
+        NGen::ngen_bmi
         testbmicppmodel
 )
diff --git a/...zations/catchments/Bmi_C_Adapter_Test.cpp → test/bmi/Bmi_C_Adapter_Test.cpp b/...zations/catchments/Bmi_C_Adapter_Test.cpp → test/bmi/Bmi_C_Adapter_Test.cpp
diff --git a/...tions/catchments/Bmi_Cpp_Adapter_Test.cpp → test/bmi/Bmi_Cpp_Adapter_Test.cpp b/...tions/catchments/Bmi_Cpp_Adapter_Test.cpp → test/bmi/Bmi_Cpp_Adapter_Test.cpp
diff --git a/...s/catchments/Bmi_Fortran_Adapter_Test.cpp → test/bmi/Bmi_Fortran_Adapter_Test.cpp b/...s/catchments/Bmi_Fortran_Adapter_Test.cpp → test/bmi/Bmi_Fortran_Adapter_Test.cpp
diff --git a/...ations/catchments/Bmi_Py_Adapter_Test.cpp → test/bmi/Bmi_Py_Adapter_Test.cpp b/...ations/catchments/Bmi_Py_Adapter_Test.cpp → test/bmi/Bmi_Py_Adapter_Test.cpp
diff --git a/...lizations/catchments/Bmi_Testing_Util.hpp → test/bmi/Bmi_Testing_Util.hpp b/...lizations/catchments/Bmi_Testing_Util.hpp → test/bmi/Bmi_Testing_Util.hpp
diff --git a/test/realizations/Formulation_Manager_Test.cpp b/test/realizations/Formulation_Manager_Test.cpp
@@ -1,4 +1,4 @@
-#include "catchments/Bmi_Testing_Util.hpp"
+#include "Bmi_Testing_Util.hpp"
 #include "Bmi_Cpp_Formulation.hpp"
 #include "DataProvider.hpp"
 #include "DataProviderSelectors.hpp"