Refactor Load organization and LoadZIP format (#465)

Author: lukelowry

GridKit/Model/PhasorDynamics/CMakeLists.txt

@@ -36,7 +36,6 @@ add_subdirectory(BusToSignalAdapter)
 add_subdirectory(Exciter)
 add_subdirectory(Governor)
 add_subdirectory(Load)
-add_subdirectory(LoadZIP)
 add_subdirectory(Stabilizer)
 add_subdirectory(SynchronousMachine)
 

GridKit/Model/PhasorDynamics/ComponentLibrary.hpp

@@ -8,8 +8,8 @@
 #include <GridKit/Model/PhasorDynamics/Exciter/IEEET1/Ieeet1.hpp>
 #include <GridKit/Model/PhasorDynamics/Exciter/SEXS-PTI/SexsPti.hpp>
 #include <GridKit/Model/PhasorDynamics/Governor/Tgov1/Tgov1.hpp>
-#include <GridKit/Model/PhasorDynamics/Load/Load.hpp>
-#include <GridKit/Model/PhasorDynamics/LoadZIP/LoadZIP.hpp>
+#include <GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZ.hpp>
+#include <GridKit/Model/PhasorDynamics/Load/LoadZIP/LoadZIP.hpp>
 #include <GridKit/Model/PhasorDynamics/SignalNode/SignalNode.hpp>
 #include <GridKit/Model/PhasorDynamics/Stabilizer/IEEEST/Ieeest.hpp>
 #include <GridKit/Model/PhasorDynamics/SynchronousMachine/GENROUwS/Genrou.hpp>

GridKit/Model/PhasorDynamics/Load/CMakeLists.txt

@@ -1,45 +1,2 @@
-# [[
-#  Author(s):
-#    - Cameron Rutherford <cameron.rutherford@pnnl.gov>
-# ]]
-
-set(_install_headers Load.hpp LoadData.hpp)
-
-if(GRIDKIT_ENABLE_ENZYME)
-  gridkit_add_library(
-    phasor_dynamics_load
-    SOURCES LoadEnzyme.cpp
-    HEADERS ${_install_headers}
-    INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
-    LINK_LIBRARIES
-      PRIVATE
-      ClangEnzymeFlags
-      PUBLIC
-      GridKit::phasor_dynamics_core
-    COMPILE_OPTIONS
-      PRIVATE
-      -mllvm
-      -enzyme-auto-sparsity=1
-      -fno-math-errno)
-else()
-  gridkit_add_library(
-    phasor_dynamics_load
-    SOURCES Load.cpp
-    INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
-    LINK_LIBRARIES PUBLIC GridKit::phasor_dynamics_core
-    HEADERS ${_install_headers})
-endif()
-
-gridkit_add_library(
-  phasor_dynamics_load_dependency_tracking
-  SOURCES LoadDependencyTracking.cpp
-  INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
-  LINK_LIBRARIES PUBLIC GridKit::phasor_dynamics_core)
-
-# Link to interface target for all components
-target_link_libraries(
-  phasor_dynamics_components
-  INTERFACE GridKit::phasor_dynamics_load)
-target_link_libraries(
-  phasor_dynamics_components_dependency_tracking
-  INTERFACE GridKit::phasor_dynamics_load_dependency_tracking)
+add_subdirectory(LoadZ)
+add_subdirectory(LoadZIP)

GridKit/Model/PhasorDynamics/Load/LoadZ/CMakeLists.txt

@@ -0,0 +1,45 @@
+# [[
+#  Author(s):
+#    - Cameron Rutherford <cameron.rutherford@pnnl.gov>
+# ]]
+
+set(_install_headers LoadZ.hpp LoadZData.hpp)
+
+if(GRIDKIT_ENABLE_ENZYME)
+  gridkit_add_library(
+    phasor_dynamics_loadz
+    SOURCES LoadZEnzyme.cpp
+    HEADERS ${_install_headers}
+    INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
+    LINK_LIBRARIES
+      PRIVATE
+      ClangEnzymeFlags
+      PUBLIC
+      GridKit::phasor_dynamics_core
+    COMPILE_OPTIONS
+      PRIVATE
+      -mllvm
+      -enzyme-auto-sparsity=1
+      -fno-math-errno)
+else()
+  gridkit_add_library(
+    phasor_dynamics_loadz
+    SOURCES LoadZ.cpp
+    INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
+    LINK_LIBRARIES PUBLIC GridKit::phasor_dynamics_core
+    HEADERS ${_install_headers})
+endif()
+
+gridkit_add_library(
+  phasor_dynamics_loadz_dependency_tracking
+  SOURCES LoadZDependencyTracking.cpp
+  INCLUDE_DIRECTORIES PRIVATE ${GRIDKIT_THIRD_PARTY_DIR}/magic-enum/include
+  LINK_LIBRARIES PUBLIC GridKit::phasor_dynamics_core)
+
+# Link to interface target for all components
+target_link_libraries(
+  phasor_dynamics_components
+  INTERFACE GridKit::phasor_dynamics_loadz)
+target_link_libraries(
+  phasor_dynamics_components_dependency_tracking
+  INTERFACE GridKit::phasor_dynamics_loadz_dependency_tracking)

…idKit/Model/PhasorDynamics/Load/Load.cpp …odel/PhasorDynamics/Load/LoadZ/LoadZ.cppGridKit/Model/PhasorDynamics/Load/Load.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZ.cpp GridKit/Model/PhasorDynamics/Load/Load.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZ.cpp

@@ -1,27 +1,27 @@
-
-#include "LoadImpl.hpp"
-
-namespace GridKit
-{
-  namespace PhasorDynamics
-  {
-    /**
-     * @brief Jacobian evaluation not implemented
-     *
-     * @return int - error code, 0 = success
-     */
-    template <typename scalar_type, typename index_type>
-    int Load<scalar_type, index_type>::evaluateJacobian()
-    {
-      Log::misc() << "Evaluate Jacobian for Load..." << std::endl;
-      Log::misc() << "Jacobian evaluation is not implemented!" << std::endl;
-
-      return 0;
-    }
-
-    // Available template instantiations
-    template class Load<double, long int>;
-    template class Load<double, size_t>;
-
-  } // namespace PhasorDynamics
-} // namespace GridKit
+
+#include "LoadZImpl.hpp"
+
+namespace GridKit
+{
+  namespace PhasorDynamics
+  {
+    /**
+     * @brief Jacobian evaluation not implemented
+     *
+     * @return int - error code, 0 = success
+     */
+    template <typename scalar_type, typename index_type>
+    int LoadZ<scalar_type, index_type>::evaluateJacobian()
+    {
+      Log::misc() << "Evaluate Jacobian for LoadZ..." << std::endl;
+      Log::misc() << "Jacobian evaluation is not implemented!" << std::endl;
+
+      return 0;
+    }
+
+    // Available template instantiations
+    template class LoadZ<double, long int>;
+    template class LoadZ<double, size_t>;
+
+  } // namespace PhasorDynamics
+} // namespace GridKit

…idKit/Model/PhasorDynamics/Load/Load.hpp …odel/PhasorDynamics/Load/LoadZ/LoadZ.hppGridKit/Model/PhasorDynamics/Load/Load.hpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZ.hpp GridKit/Model/PhasorDynamics/Load/Load.hpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZ.hpp

@@ -2,7 +2,7 @@
 
 #include <GridKit/Model/PhasorDynamics/Component.hpp>
 #include <GridKit/Model/PhasorDynamics/ComponentSignals.hpp>
-#include <GridKit/Model/PhasorDynamics/Load/LoadData.hpp>
+#include <GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZData.hpp>
 #include <GridKit/Model/VariableMonitor.hpp>
 
 // Forward declarations.
@@ -14,7 +14,7 @@ namespace GridKit
     class BusBase;
 
     template <typename real_type, typename index_type>
-    struct LoadData;
+    struct LoadZData;
   } // namespace PhasorDynamics
 } // namespace GridKit
 
@@ -27,7 +27,7 @@ namespace GridKit
      *
      */
     template <typename scalar_type, typename index_type>
-    class Load : public Component<scalar_type, index_type>
+    class LoadZ : public Component<scalar_type, index_type>
     {
       using Component<scalar_type, index_type>::gridkit_component_id_;
       using Component<scalar_type, index_type>::size_;
@@ -53,13 +53,13 @@ namespace GridKit
       using IdxT       = index_type;
       using RealT      = typename Component<ScalarT, IdxT>::RealT;
       using BusT       = BusBase<ScalarT, IdxT>;
-      using ModelDataT = LoadData<RealT, IdxT>;
-      using MonitorT   = Model::VariableMonitor<Load, LoadData>;
+      using ModelDataT = LoadZData<RealT, IdxT>;
+      using MonitorT   = Model::VariableMonitor<LoadZ, LoadZData>;
 
-      Load(BusT* bus);
-      Load(BusT* bus, RealT R, RealT X);
-      Load(BusT* bus, const ModelDataT& data);
-      virtual ~Load();
+      LoadZ(BusT* bus);
+      LoadZ(BusT* bus, RealT R, RealT X);
+      LoadZ(BusT* bus, const ModelDataT& data);
+      virtual ~LoadZ();
 
       virtual int setGridKitComponentID(IdxT) override final;
       virtual int allocate() override final;
@@ -78,15 +78,17 @@ namespace GridKit
       void setR(RealT R)
       {
         R_ = R;
+        setDerivedParams();
       }
 
       void setX(RealT X)
       {
-        // std::cout << "Setting X ...\n";
         X_ = X;
+        setDerivedParams();
       }
 
     private:
+      void initializeMonitor();
       void setDerivedParams();
 
       ScalarT& Vr()

…t/Model/PhasorDynamics/Load/LoadData.hpp …/PhasorDynamics/Load/LoadZ/LoadZData.hppGridKit/Model/PhasorDynamics/Load/LoadData.hpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZData.hpp GridKit/Model/PhasorDynamics/Load/LoadData.hpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZData.hpp

@@ -1,5 +1,5 @@
 /**
- * @file LoadData.hpp
+ * @file LoadZData.hpp
  * @author Slaven Peles (peless@ornl.gov)
  * @brief Modeling data for loads
  *
@@ -13,20 +13,20 @@ namespace GridKit
   namespace PhasorDynamics
   {
     /// Initial parameters for a load
-    enum class LoadParameters
+    enum class LoadZParameters
     {
       R, ///< Load resistance
       X, ///< Load reactance
     };
 
     /// Ports for a load
-    enum class LoadPorts
+    enum class LoadZPorts
     {
       bus, ///< Unique ID of the bus to which the load is connected
     };
 
     /// Variables able to be monitored for a load
-    enum class LoadMonitorableVariables
+    enum class LoadZMonitorableVariables
     {
       p,
       q
@@ -41,17 +41,17 @@ namespace GridKit
      * Integer parameters are of the same type as matrix and vector indices.
      */
     template <typename real_type, typename index_type>
-    struct LoadData : public ComponentData<real_type,
-                                           index_type,
-                                           LoadParameters,
-                                           LoadPorts,
-                                           LoadMonitorableVariables>
+    struct LoadZData : public ComponentData<real_type,
+                                            index_type,
+                                            LoadZParameters,
+                                            LoadZPorts,
+                                            LoadZMonitorableVariables>
     {
-      LoadData() = default;
+      LoadZData() = default;
 
-      using Parameters           = LoadParameters;
-      using Ports                = LoadPorts;
-      using MonitorableVariables = LoadMonitorableVariables;
+      using Parameters           = LoadZParameters;
+      using Ports                = LoadZPorts;
+      using MonitorableVariables = LoadZMonitorableVariables;
     };
   } // namespace PhasorDynamics
 } // namespace GridKit

…Dynamics/Load/LoadDependencyTracking.cpp …s/Load/LoadZ/LoadZDependencyTracking.cppGridKit/Model/PhasorDynamics/Load/LoadDependencyTracking.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZDependencyTracking.cpp GridKit/Model/PhasorDynamics/Load/LoadDependencyTracking.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZDependencyTracking.cpp

@@ -1,5 +1,5 @@
 
-#include "LoadImpl.hpp"
+#include "LoadZImpl.hpp"
 
 namespace GridKit
 {
@@ -11,17 +11,17 @@ namespace GridKit
      * @return int - error code, 0 = success
      */
     template <typename scalar_type, typename index_type>
-    int Load<scalar_type, index_type>::evaluateJacobian()
+    int LoadZ<scalar_type, index_type>::evaluateJacobian()
     {
-      Log::misc() << "Evaluate Jacobian for Load..." << std::endl;
+      Log::misc() << "Evaluate Jacobian for LoadZ..." << std::endl;
       Log::misc() << "Jacobian evaluation is not implemented!" << std::endl;
 
       return 0;
     }
 
     // Available template instantiations
-    template class Load<DependencyTracking::Variable, long int>;
-    template class Load<DependencyTracking::Variable, size_t>;
+    template class LoadZ<DependencyTracking::Variable, long int>;
+    template class LoadZ<DependencyTracking::Variable, size_t>;
 
   } // namespace PhasorDynamics
 } // namespace GridKit

…Model/PhasorDynamics/Load/LoadEnzyme.cpp …hasorDynamics/Load/LoadZ/LoadZEnzyme.cppGridKit/Model/PhasorDynamics/Load/LoadEnzyme.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZEnzyme.cpp GridKit/Model/PhasorDynamics/Load/LoadEnzyme.cpp renamed to GridKit/Model/PhasorDynamics/Load/LoadZ/LoadZEnzyme.cpp

@@ -1,12 +1,12 @@
 /**
- * @file LoadEnzyme.cpp
+ * @file LoadZEnzyme.cpp
  * @author Nicholson Koukpaizan (koukpaizannk@ornl.gov)
  *
  */
 
 #include <GridKit/AutomaticDifferentiation/Enzyme/SparseJacobians.hpp>
 
-#include "LoadImpl.hpp"
+#include "LoadZImpl.hpp"
 
 namespace GridKit
 {
@@ -18,9 +18,9 @@ namespace GridKit
      * @return int - error code, 0 = success
      */
     template <typename scalar_type, typename index_type>
-    int Load<scalar_type, index_type>::evaluateJacobian()
+    int LoadZ<scalar_type, index_type>::evaluateJacobian()
     {
-      Log::misc() << "Evaluate Jacobian for Load..." << std::endl;
+      Log::misc() << "Evaluate Jacobian for LoadZ..." << std::endl;
       Log::misc() << "Jacobian evaluation is experimental!" << std::endl;
 
       J_.zeroMatrix();
@@ -33,7 +33,7 @@ namespace GridKit
 
       // DfDy call without alpha_ to indicate that df/dy' is null
       // @todo: deduce from a compile-time differential tag
-      GridKit::Enzyme::Sparse::DfDy<GridKit::PhasorDynamics::Load<ScalarT, IdxT>,
+      GridKit::Enzyme::Sparse::DfDy<GridKit::PhasorDynamics::LoadZ<ScalarT, IdxT>,
                                     GridKit::Enzyme::Sparse::MemberFunctions::InternalResidual,
                                     ScalarT,
                                     IdxT>::eval(this,
@@ -49,7 +49,7 @@ namespace GridKit
                                                 J_vals_buffer_,
                                                 J_);
 
-      GridKit::Enzyme::Sparse::DfDwb<GridKit::PhasorDynamics::Load<ScalarT, IdxT>,
+      GridKit::Enzyme::Sparse::DfDwb<GridKit::PhasorDynamics::LoadZ<ScalarT, IdxT>,
                                      GridKit::Enzyme::Sparse::MemberFunctions::InternalResidual,
                                      ScalarT,
                                      IdxT>::eval(this,
@@ -65,7 +65,7 @@ namespace GridKit
                                                  J_vals_buffer_,
                                                  J_);
 
-      GridKit::Enzyme::Sparse::DhDy<GridKit::PhasorDynamics::Load<ScalarT, IdxT>,
+      GridKit::Enzyme::Sparse::DhDy<GridKit::PhasorDynamics::LoadZ<ScalarT, IdxT>,
                                     GridKit::Enzyme::Sparse::MemberFunctions::BusResidual,
                                     ScalarT,
                                     IdxT>::eval(this,
@@ -85,8 +85,8 @@ namespace GridKit
     }
 
     // Available template instantiations
-    template class Load<double, long int>;
-    template class Load<double, size_t>;
+    template class LoadZ<double, long int>;
+    template class LoadZ<double, size_t>;
 
   } // namespace PhasorDynamics
 } // namespace GridKit