New England IEEE 39-Bus Case (#310)

* Initial case file and README

* Cmake, source, and headers

* change log and improved oneline

---------

Co-authored-by: lukelowry <lukelowry@users.noreply.github.com>

Author: lukelowry

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## v0.2
 
-- Added 3, 10, and 37 bus test cases.
+- Added 3, 10, 37, and 39 bus test cases.
 - Updated documentation.
 - Added JSON parsing.
 - Automatic differentiation with enzyme (w.r.t. internal and external variables).

examples/PhasorDynamics/Medium/CMakeLists.txt

@@ -1 +1,2 @@
 add_subdirectory(Hawaii)
+add_subdirectory(NewEngland)

examples/PhasorDynamics/Medium/NewEngland/CMakeLists.txt

@@ -0,0 +1,16 @@
+gridkit_example_current_install_path(_install_path)
+
+add_executable(newengland newengland.cpp)
+target_link_libraries(newengland
+    GridKit::phasor_dynamics_core
+	GridKit::phasor_dynamics_components
+	GridKit::phasor_dynamics_signal
+	GridKit::solvers_dyn)
+install(TARGETS newengland RUNTIME DESTINATION ${_install_path})
+gridkit_example_add_file(newengland.json)
+
+add_test(NAME newengland
+    COMMAND newengland ${CMAKE_CURRENT_BINARY_DIR}/newengland.json)
+add_test(NAME newengland_no_arg
+    COMMAND newengland
+    WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})

examples/PhasorDynamics/Medium/NewEngland/README.md

@@ -0,0 +1,29 @@
+# **Synthetic Hawaii Case**
+
+## One-Line Diagram
+
+<div align="center">
+   <img align="center" src="newengland-oneline.png">
+   
+  Figure 1: Oneline of the New England IEEE 39-bus case, courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
+</div>
+
+## Case Description
+
+This case is a modified version of the NE 39-bus case, available at the Texas A&M University [Electric Grid Test Case Repository](https://electricgrids.engr.tamu.edu/electric-grid-test-cases/). It has been modified to include GridKit-compatible generator models.
+
+Model       | Count  
+------------|--------
+[Bus](../../../../GridKit/Model/PhasorDynamics/Bus/README.md)         | 39
+[Branch](../../../../GridKit/Model/PhasorDynamics/Branch/README.md)     | 46
+[GENROU](../../../../GridKit/Model/PhasorDynamics/SynchronousMachine/GENROUwS/README.md)       | 10
+[TGOV1](../../../../GridKit/Model/PhasorDynamics/Governor/Tgov1/README.md)        | 10
+[IEEET1](../../../../GridKit/Model/PhasorDynamics/Exciter/IEEET1/README.md)  | 10
+
+## Case Events
+
+The following examples needs to be constructed with this case. Currently the only events that have been implemented are faults. This is a practical case to use for modeling outages, or even forced oscillations.
+- Bus Fault
+- Line Outage
+- Generator Outage
+- Forced Oscillations

examples/PhasorDynamics/Medium/NewEngland/newengland-oneline.png

@@ -0,0 +1,75 @@
+/**
+ * @file newengland.cpp
+ * @author Luke Lowery (lukel@tamu.edu)
+ * @author Adam Birchfield (abirchfield@tamu.edu)
+ * @author Slaven Peles (peless@ornl.gov)
+ * @brief Example running the New England IEEE 39-Bus Case
+ *
+ * Simulates a New England IEEE 39-Bus with Genrou 6th order generator model and
+ * compares results with data generated for the same system by Poweworld.
+ *
+ */
+#include "newengland.hpp"
+
+#include <ctime>
+#include <filesystem>
+#include <iostream>
+
+#include <GridKit/Model/PhasorDynamics/ComponentLibrary.hpp>
+#include <GridKit/Model/PhasorDynamics/SystemModel.hpp>
+#include <GridKit/Model/PhasorDynamics/SystemModelData.hpp>
+#include <GridKit/Solver/Dynamic/Ida.hpp>
+#include <GridKit/Utilities/Testing.hpp>
+
+int main(int argc, const char* argv[])
+{
+  using namespace GridKit::PhasorDynamics;
+  using namespace AnalysisManager::Sundials;
+
+  using scalar_type = double;
+  // using real_type   = double;
+  using index_type  = size_t;
+
+  // Read Input JSON File
+  std::filesystem::path input_file;
+  if (argc < 2)
+  {
+    if (std::filesystem::exists("newengland.json"))
+    {
+      input_file = std::filesystem::current_path() / "newengland.json";
+    }
+    else
+    {
+      std::cout << "\n"
+                   "ERROR: No input file found or provided.\n"
+                   "\n"
+                   "Usage:\n"
+                   "       newengland <json-input-file>\n"
+                   "\n"
+                   "Please provide a JSON input file as a positional command-line \n"
+                   "argument.\n"
+                   "\n"
+                   "By default this example will look for \"newengland.json\" in the \n"
+                   "current working directory and use that if found.\n"
+                   "\n";
+      exit(1);
+    }
+  }
+  else
+  {
+    input_file = argv[1];
+  }
+
+  std::cout << "Example: newengland\n";
+  std::cout << "Input file: " << input_file << '\n';
+
+  // Parse Model Data
+  auto data = parseSystemModelData(input_file);
+
+  //  Instantiate System Model
+  SystemModel<scalar_type, index_type> sys(data);
+  sys.allocate();
+
+  int status = 0;
+  return status;
+}

examples/PhasorDynamics/Medium/NewEngland/newengland-oneline.webp

@@ -0,0 +1,15 @@
+/**
+ * @file newengland.hpp
+ * @author Luke Lowery (lukel@tamu.edu)
+ * @author Adam Birchfield (abirchfield@tamu.edu)
+ *
+ */
+#include <vector>
+
+// Columns:
+// Time, Machine Speed (PowerWorld), Bus 1 Voltage Magnitude (PowerWorld)},
+std::vector<std::vector<double>> reference_solution =
+    {{0, 1, 0}, // It should be {0,1,1.000000477} but something is wrong in GridKit
+     {0.004167, 1, 1.000000477},
+     {0.008333, 1, 1.000000477},
+     {0.0125, 0.99999994, 1.000000477}};