NGWPC NWM PI-3 Formulation Selection Delivery 2025-11-21

.github/workflows/Build_and_Run_Standalone_Test.yml

@@ -57,15 +57,6 @@ jobs:
         make
         cd ..
         ./run_cfe.sh FORCINGPET
-
-    - name : Build and Run AETROOTZONE option
-      run: |
-        git clone https://github.com/NOAA-OWP/SoilMoistureProfiles extern/SoilMoistureProfiles
-        cd build
-        cmake ../ -DAETROOTZONE=ON
-        make
-        cd ..
-        ./run_cfe.sh AETROOTZONE
 
     - name: Build and Run BMI Unit Test
       run: |

.github/workflows/ngen_integration.yaml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Build the CFE Library
         run: |
-          cmake -B cmake_build -S . -DNGEN=ON -DCMAKE_C_FLAGS='-g -Og -fsanitize=address -Werror'
+          cmake -B cmake_build -S . -DNGEN=ON
           make -C cmake_build
 
       - name: Save CFE to a Temp Directory
@@ -88,7 +88,7 @@ jobs:
       - name: Run NGen Test for CFE (cfe1.0) Coupled with PET
         run: |
           mv ${{ steps.ngen_id1.outputs.build-dir }} ./ngen-build/
-          inputfile='extern/cfe/cfe/realizations/realization_cfe_pet_surfgiuh.json'
+          inputfile='extern/cfe/cfe/realizations/realization_cfe_pet.json'
           ./ngen-build/ngen ./data/catchment_data.geojson "cat-27" ./data/nexus_data.geojson "nex-26" $inputfile
 
       - name: Run Ngen Test for CFE (cfe2.0) Coupled with PET

CMakeLists.txt

@@ -7,6 +7,9 @@ set(Red         "${Esc}[32m")
 set(CMAKE_CXX_STANDARD 14)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
+set(CMAKE_C_COMPILER $ENV{CC})
+set(CMAKE_CXX_COMPILER $ENV{CXX})
+
 # module setup options
 
 option(BASE "BASE" OFF)
@@ -43,6 +46,7 @@ endif()
 # set the project name
 project(cfebmi VERSION 1.0.0 DESCRIPTION "OWP CFE BMI Module Shared Library")
 
+set(CMAKE_BUILD_TYPE Debug)
 IF(CMAKE_BUILD_TYPE MATCHES Debug)
     message("Debug build.")
 ENDIF(CMAKE_BUILD_TYPE MATCHES Debug)
@@ -51,39 +55,49 @@ message(CMAKE_CXX_COMPILER " ${CMAKE_CXX_COMPILER}")
 message(CMAKE_C_COMPILER " ${CMAKE_C_COMPILER}")
 message("CMAKE_BUILD_TYPE = ${CMAKE_BUILD_TYPE}")
 
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0")
+set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -O0")
+
 # add the executable
 
 ## cfe + aorc + pet + smp
 if(AETROOTZONE)
-add_executable(${exe_name} ./src/main_cfe_aorc_pet_rz_aet.cxx ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c
-			   ./src/conceptual_reservoir.c ./src/nash_cascade.c ./extern/aorc_bmi/src/aorc.c
-			   ./extern/aorc_bmi/src/bmi_aorc.c ./extern/evapotranspiration/src/pet.c
-			   ./extern/evapotranspiration/src/bmi_pet.c)
-
-add_library(cfelib ./extern/SoilMoistureProfiles/src/bmi_soil_moisture_profile.cxx
-		   ./extern/SoilMoistureProfiles/src/soil_moisture_profile.cxx
-                   ./extern/SoilMoistureProfiles/include/bmi_soil_moisture_profile.hxx
-		   ./extern/SoilMoistureProfiles/include/soil_moisture_profile.hxx)
+add_executable(${exe_name} ./src/main_cfe_aorc_pet_rz_aet.cxx ./src/cfe.c ./src/bmi_cfe.c ./src/logger.c ./src/giuh.c ./src/conceptual_reservoir.c
+    			   ./extern/aorc_bmi/src/aorc.c ./extern/aorc_bmi/src/bmi_aorc.c ./extern/evapotranspiration/src/pet.c
+			   ./extern/evapotranspiration/src/bmi_pet.c ./src/bmi_serialization.cxx ./src/nash_cascade.c)
+
+add_library(cfelib ./extern/SoilMoistureProfiles/src/bmi_soil_moisture_profile.cxx ./extern/SoilMoistureProfiles/src/soil_moisture_profile.cxx
+                   ./extern/SoilMoistureProfiles/include/bmi_soil_moisture_profile.hxx ./extern/SoilMoistureProfiles/include/soil_moisture_profile.hxx)
 target_link_libraries(${exe_name} LINK_PUBLIC cfelib)
 elseif(FORCING)
-add_executable(${exe_name} ./src/main_pass_forcings.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
-			   ./src/nash_cascade.c ./extern/aorc_bmi/src/aorc.c ./extern/aorc_bmi/src/bmi_aorc.c)
+add_executable(${exe_name} ./src/main_pass_forcings.c ./src/cfe.c ./src/bmi_cfe.c ./src/logger.c ./src/giuh.c ./src/conceptual_reservoir.c
+			   ./extern/aorc_bmi/src/aorc.c ./extern/aorc_bmi/src/bmi_aorc.c ./src/bmi_serialization.cxx ./src/nash_cascade.c)
 elseif(FORCINGPET)
-add_executable(${exe_name} ./src/main_cfe_aorc_pet.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
-			   ./src/nash_cascade.c ./extern/aorc_bmi/src/aorc.c ./extern/aorc_bmi/src/bmi_aorc.c
-			   ./extern/evapotranspiration/src/pet.c ./extern/evapotranspiration/src/bmi_pet.c)
+add_executable(${exe_name} ./src/main_cfe_aorc_pet.c ./src/cfe.c ./src/bmi_cfe.c ./src/logger.c ./src/giuh.c ./src/conceptual_reservoir.c
+			   ./extern/aorc_bmi/src/aorc.c ./extern/aorc_bmi/src/bmi_aorc.c ./extern/evapotranspiration/src/pet.c
+			   ./extern/evapotranspiration/src/bmi_pet.c ./src/bmi_serialization.cxx ./src/nash_cascade.c)
 elseif(BASE)
-add_executable(${exe_name} ./src/main.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
-			   ./src/nash_cascade.c)
+add_executable(${exe_name} ./src/main.c ./src/cfe.c ./src/bmi_cfe.c ./src/logger.c ./src/giuh.c ./src/conceptual_reservoir.c
+                    ./src/bmi_serialization.cxx ./src/nash_cascade.c)
 elseif(UNITTEST)
-add_executable(${exe_name} ./test/main_unit_test.c ./src/cfe.c ./src/bmi_cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
-			   ./src/nash_cascade.c)
+add_executable(${exe_name} ./test/main_unit_test.c ./src/cfe.c ./src/bmi_cfe.c ./src/logger.c ./src/giuh.c ./src/conceptual_reservoir.c
+                    ./src/bmi_serialization.cxx ./src/nash_cascade.c)
 endif()
 
 
+# -----------------------------------------------------------------------------
+# Find the Boost library and configure usage
+set(Boost_USE_STATIC_LIBS OFF)
+set(Boost_USE_MULTITHREADED ON)
+set(Boost_USE_STATIC_RUNTIME OFF)
+find_package(Boost 1.79.0 REQUIRED COMPONENTS serialization)
+
+
+
 if(NOT NGEN)
 target_link_libraries(${exe_name} PRIVATE m)
 target_include_directories(${exe_name} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/include)
+target_link_libraries(${exe_name} PRIVATE Boost::serialization)
 endif()
 
 
@@ -96,9 +110,11 @@ set(CFE_LIB_DESC_CMAKE "OWP CFE BMI Module Shared Library")
 add_compile_definitions(BMI_ACTIVE)
 
 if(WIN32)
-    add_library(cfebmi ./src/bmi_cfe.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c ./src/nash_cascade.c)
+    add_library(cfebmi ./src/bmi_cfe.c ./src/logger.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
+                       ./src/bmi_serialization.cxx)
 else()
-    add_library(cfebmi SHARED ./src/bmi_cfe.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c ./src/nash_cascade.c)
+    add_library(cfebmi SHARED ./src/bmi_cfe.c ./src/logger.c ./src/cfe.c ./src/giuh.c ./src/conceptual_reservoir.c
+                              ./src/bmi_serialization.cxx)
 endif()
 
 target_include_directories(cfebmi PRIVATE include)
@@ -107,6 +123,8 @@ set_target_properties(cfebmi PROPERTIES VERSION ${PROJECT_VERSION})
 
 set_target_properties(cfebmi PROPERTIES PUBLIC_HEADER ./include/bmi_cfe.h)
 
+target_link_libraries(cfebmi PRIVATE Boost::serialization)
+
 include(GNUInstallDirs)
 
 install(TARGETS cfebmi

LICENSE

@@ -1,5 +1,28 @@
+Copyright 2025 Raytheon Company
 
-                                 Apache License
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+
+Licensed under: https://opensource.org/license/bsd-2-clause
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+All rights reserved. Based on Government sponsored work under contract GS-35F-204GA.
+
+-----------------
+
+
+“Software code created by U.S. Government employees is not subject to copyright
+in the United States (17 U.S.C. §105). The United States/Department of Commerce
+reserve all rights to seek and obtain copyright protection in countries other
+than the United States for Software authored in its entirety by the Department
+of Commerce. To this end, the Department of Commerce hereby grants to Recipient
+a royalty-free, nonexclusive license to use, copy, and create derivative works
+of the Software outside of the United States.”
+
+                       Apache License
                            Version 2.0, January 2004
                         http://www.apache.org/licenses/
 
@@ -199,4 +222,4 @@
    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.
+

bmi/bmi.h

@@ -35,8 +35,8 @@ SOFTWARE.
 extern "C" {
 #endif
 
-const static int BMI_SUCCESS = 0;
-const static int BMI_FAILURE = 1;
+#define BMI_SUCCESS (0)
+#define BMI_FAILURE (1)
 
 #define BMI_MAX_UNITS_NAME (2048)
 #define BMI_MAX_TYPE_NAME (2048)

bmi/bmi.hxx

@@ -0,0 +1,84 @@
+// The Basic Model Interface (BMI) C++ specification.
+//
+// This language specification is derived from the Scientific
+// Interface Definition Language (SIDL) file bmi.sidl located at
+// https://github.com/csdms/bmi.
+
+#ifndef BMI_HXX
+#define BMI_HXX
+#include <string>
+#include <vector>
+
+namespace bmixx {
+
+  //const int BMI_SUCCESS = 0;
+  //  const int BMI_FAILURE = 1;
+
+  const int MAX_COMPONENT_NAME = 2048;
+  const int MAX_VAR_NAME = 2048;
+  const int MAX_UNITS_NAME = 2048;
+  const int MAX_TYPE_NAME = 2048;
+
+  class Bmi {
+    public:
+      // Model control functions.
+      virtual void Initialize(std::string config_file) = 0;
+      virtual void Update() = 0;
+      virtual void UpdateUntil(double time) = 0;
+      virtual void Finalize() = 0;
+
+      // Model information functions.
+      virtual std::string GetComponentName() = 0;
+      virtual int GetInputItemCount() = 0;
+      virtual int GetOutputItemCount() = 0;
+      virtual std::vector<std::string> GetInputVarNames() = 0;
+      virtual std::vector<std::string> GetOutputVarNames() = 0;
+
+      // Variable information functions
+      virtual int GetVarGrid(std::string name) = 0;
+      virtual std::string GetVarType(std::string name) = 0;
+      virtual std::string GetVarUnits(std::string name) = 0;
+      virtual int GetVarItemsize(std::string name) = 0;
+      virtual int GetVarNbytes(std::string name) = 0;
+      virtual std::string GetVarLocation(std::string name) = 0;
+
+      virtual double GetCurrentTime() = 0;
+      virtual double GetStartTime() = 0;
+      virtual double GetEndTime() = 0;
+      virtual std::string GetTimeUnits() = 0;
+      virtual double GetTimeStep() = 0;
+
+      // Variable getters
+      virtual void GetValue(std::string name, void *dest) = 0;
+      virtual void *GetValuePtr(std::string name) = 0;
+      virtual void GetValueAtIndices(std::string name, void *dest, int *inds, int count) = 0;
+
+      // Variable setters
+      virtual void SetValue(std::string name, void *src) = 0;
+      virtual void SetValueAtIndices(std::string name, int *inds, int count, void *src) = 0;
+
+      // Grid information functions
+      virtual int GetGridRank(const int grid) = 0;
+      virtual int GetGridSize(const int grid) = 0;
+      virtual std::string GetGridType(const int grid) = 0;
+
+      virtual void GetGridShape(const int grid, int *shape) = 0;
+      virtual void GetGridSpacing(const int grid, double *spacing) = 0;
+      virtual void GetGridOrigin(const int grid, double *origin) = 0;
+
+      virtual void GetGridX(const int grid, double *x) = 0;
+      virtual void GetGridY(const int grid, double *y) = 0;
+      virtual void GetGridZ(const int grid, double *z) = 0;
+
+      virtual int GetGridNodeCount(const int grid) = 0;
+      virtual int GetGridEdgeCount(const int grid) = 0;
+      virtual int GetGridFaceCount(const int grid) = 0;
+
+      virtual void GetGridEdgeNodes(const int grid, int *edge_nodes) = 0;
+      virtual void GetGridFaceEdges(const int grid, int *face_edges) = 0;
+      virtual void GetGridFaceNodes(const int grid, int *face_nodes) = 0;
+      virtual void GetGridNodesPerFace(const int grid, int *nodes_per_face) = 0;
+  };
+}
+
+#endif

configs/cfe1.0/cfe_config_cat_87.txt

@@ -20,13 +20,12 @@ nash_storage=0.0,0.0
 giuh_ordinates=0.06,0.51,0.28,0.12,0.03
 num_timesteps=1
 verbosity=2
-surface_runoff_scheme=GIUH
-surface_water_partitioning_scheme=Xinanjiang
+surface_partitioning_scheme=Xinanjiang
 a_Xinanjiang_inflection_point_parameter=1
 b_Xinanjiang_shape_parameter=1
 x_Xinanjiang_shape_parameter=1
 urban_decimal_fraction=0.0
 DEBUG=0
-#surface_water_partitioning_scheme=Schaake
+#surface_partitioning_scheme=Schaake
 #ice_fraction=0
 #ice_content_threshold=0.15

configs/cfe1.0/cfe_config_laramie_pass_aet_rz.txt

@@ -20,9 +20,8 @@ nash_storage=0.0,0.0
 giuh_ordinates=0.06,0.51,0.28,0.12,0.03
 num_timesteps=1
 verbosity=1
-surface_runoff_scheme=GIUH
-surface_water_partitioning_scheme=Schaake
-#surface_water_partitioning_scheme=Xinanjiang
+surface_partitioning_scheme=Schaake
+#surface_partitioning_scheme=Xinanjiang
 #a_Xinanjiang_inflection_point_parameter=1
 #b_Xinanjiang_shape_parameter=1
 #x_Xinanjiang_shape_parameter=1

include/bmi.h

@@ -35,8 +35,8 @@ SOFTWARE.
 extern "C" {
 #endif
 
-const static int BMI_SUCCESS = 0;
-const static int BMI_FAILURE = 1;
+#define BMI_SUCCESS (0)
+#define BMI_FAILURE (1)
 
 #define BMI_MAX_UNITS_NAME (2048)
 #define BMI_MAX_TYPE_NAME (2048)

include/bmi_cfe.h

@@ -7,6 +7,7 @@ extern "C" {
 
 #include "./cfe.h"
 #include "bmi.h"
+#include <stdint.h>
 
 //--------------------------------------------------
 // Experiment to simplify BMI implementation (SDP)
@@ -111,6 +112,9 @@ struct cfe_state_struct {
 
     int verbosity;
 
+    char* serialized;
+    uint64_t serialized_length; // needs a permanent anchor for get_value_ptr
+
 };
 typedef struct cfe_state_struct cfe_state_struct;
 

include/bmi_serialization.h

@@ -0,0 +1,18 @@
+#ifndef CFE_BMI_SERIALIZATION
+#define CFE_BMI_SERIALIZATION
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "bmi.h"
+
+int free_serialized_cfe(Bmi* bmi);
+int load_serialized_cfe(Bmi* bmi, const char* data);
+int new_serialized_cfe(Bmi* bmi);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

include/cfe.h

@@ -17,7 +17,7 @@
 
 // t-shirt approximation of the hydrologic routing funtionality of the National Water Model v 1.2, 2.0, and 2.1
 // This code was developed to test the hypothesis that the National Water Model runoff generation, vadose zone
-// dynamics, and conceptual groundwater model can be greatly simplified by acknowledging that it is truly a
+// dynamics, and conceptual groundwater model can be greatly simplified by acknowledging that it is truly a 
 // conceptual model.  The hypothesis is supported by a number of observations made during a 2017-2018 deep dive
 // into the NWM code.  Thesed are:
 //
@@ -26,7 +26,7 @@
 //    function by Moore, 1985.   The Schaake function is a single valued function of soil moisture deficit,
 //    predicts 100% runoff when the soil is saturated, like the curve-number method, and is fundamentally simple.
 // 2. Run-on infiltration is strictly not calculated.  Overland flow routing applies the Schaake function repeatedly
-//    to predict this phenomenon, which violates the underlying assumption of the PDM method that only rainfall
+//    to predict this phenomenon, which violates the underlying assumption of the PDM method that only rainfall 
 //    inputs affect soil moisture.
 // 3. The water-content based Richards' equation, applied using a coarse-discretization, can be replaced with a simple
 //    conceptual reservoir because it never allows saturation or infiltration-excess runoff unless deactivated by
@@ -118,8 +118,8 @@ struct massbal
     double vol_soil_to_gw      ;  // this should equal vol_to_gw
     double vol_soil_end        ;
     double vol_et_from_soil    ;
-    double vol_et_from_rain    ;
-    double vol_et_to_atm       ;
+    double vol_et_from_rain    ; 
+    double vol_et_to_atm       ;   
     double volin               ;
     double volout              ;
     double volend              ;

include/giuh.h

@@ -2,6 +2,6 @@
 #define _GIUH_H
 
 extern double giuh_convolution_integral(double runoff_m, int num_giuh_ordinates, 
-					double *giuh_ordinates, double *runoff_queue_m_per_timestep);
+                                   double *giuh_ordinates, double *runoff_queue_m_per_timestep);
 
 #endif