Cleanup old Component Constructors (#627)

* Consistant constructors

* Adjust breaking tests and defaults

* Update README and CHANGELOG

Author: lukelowry

CHANGELOG.md

@@ -10,6 +10,7 @@
 - Added `enable` and `disable` solver events that put a branch in or out of service.
 - `verify()` returns `Model::ConfigurationChecks` listing every configuration problem instead of an error count.
 - Added `Model::ParameterReader`
+- Removed legacy PhasorDynamics component constructors in favor of constructors taking model data.
 
 ## v0.2
 

GridKit/Model/PhasorDynamics/Branch/Branch.hpp

@@ -54,15 +54,6 @@ namespace GridKit
       using MonitorT   = Model::VariableMonitor<Branch, BranchData>;
 
     public:
-      Branch(BusT* bus1, BusT* bus2);
-      Branch(BusT* bus1,
-             BusT* bus2,
-             RealT R,
-             RealT X,
-             RealT G,
-             RealT B,
-             RealT tap   = 1.0,
-             RealT phase = 0.0);
       Branch(BusT* bus1, BusT* bus2, const ModelDataT& data);
       virtual ~Branch();
 
@@ -192,7 +183,7 @@ namespace GridKit
       BusT* bus1_;
       BusT* bus2_;
       RealT R_{0.0};
-      RealT X_{0.0};
+      RealT X_{0.01};
       RealT G_{0.0};
       RealT B_{0.0};
       RealT Gmag_{0.0};

GridKit/Model/PhasorDynamics/Branch/BranchImpl.hpp

@@ -26,60 +26,11 @@ namespace GridKit
      * Model size:
      * - Number of equations = 0
      * - Number of internal variables = 0
-     */
-    template <typename scalar_type, typename index_type>
-    Branch<scalar_type, index_type>::Branch(BusT* bus1, BusT* bus2)
-      : bus1_(bus1),
-        bus2_(bus2),
-        R_(0.0),
-        X_(0.01),
-        G_(0.0),
-        B_(0.0),
-        tap_(1.0),
-        phase_(0.0),
-        bus1_id_(0),
-        bus2_id_(0)
-    {
-      size_ = 0;
-      setDerivedParams();
-    }
-
-    /**
-     * @brief Construct a new Branch
      *
      * @param bus1 - pointer to bus-1
      * @param bus2 - pointer to bus-2
-     * @param R - line series resistance
-     * @param X - line series reactance
-     * @param G - total line shunt conductance
-     * @param B - total line shunt susceptance
-     * @param tap - off-nominal tap magnitude on bus1 side
-     * @param phase - phase shift angle in radians
+     * @param data - branch parameters and monitored-variable selections
      */
-    template <typename scalar_type, typename index_type>
-    Branch<scalar_type, index_type>::Branch(BusT* bus1,
-                                            BusT* bus2,
-                                            RealT R,
-                                            RealT X,
-                                            RealT G,
-                                            RealT B,
-                                            RealT tap,
-                                            RealT phase)
-      : bus1_(bus1),
-        bus2_(bus2),
-        R_(R),
-        X_(X),
-        G_(G),
-        B_(B),
-        tap_(tap),
-        phase_(phase),
-        bus1_id_(0),
-        bus2_id_(0)
-    {
-      size_ = 0;
-      setDerivedParams();
-    }
-
     template <typename scalar_type, typename index_type>
     Branch<scalar_type, index_type>::Branch(BusT* bus1, BusT* bus2, const ModelDataT& data)
       : bus1_(bus1),

GridKit/Model/PhasorDynamics/Branch/README.md

@@ -29,7 +29,7 @@ Figure 1: Branch model.
 Symbol           | Units  | JSON    | Description                             | Typical Value | Note
 -----------------|--------|---------|-----------------------------------------|---------------|-----
 $R$              | [p.u.] | `R`     | Branch series resistance                |               |
-$X$              | [p.u.] | `X`     | Branch series reactance                 |               |
+$X$              | [p.u.] | `X`     | Branch series reactance                 | 0.01          | Default when omitted
 $G$              | [p.u.] | `G`     | Total line shunt conductance            | 0.0           |
 $B$              | [p.u.] | `B`     | Total line shunt susceptance            | 0.0           |
 $G_\mathrm{mag}$ | [p.u.] | `Gmag`  | Magnetizing shunt conductance at bus 1  | 0.0           |

GridKit/Model/PhasorDynamics/Controller/REECB/Reecb.hpp

@@ -111,7 +111,6 @@ namespace GridKit
         static constexpr RealT INITIALIZATION_TOLERANCE =
             static_cast<RealT>(100.0) * std::numeric_limits<RealT>::epsilon();
 
-        Reecb(BusT* bus);
         Reecb(BusT* bus, const ModelDataT& data);
         ~Reecb();
 

GridKit/Model/PhasorDynamics/Controller/REECB/ReecbImpl.hpp

@@ -48,19 +48,6 @@ namespace GridKit
         RealT vref{};
       };
 
-      /**
-       * @brief Construct an unconfigured REECB controller
-       *
-       * @param[in] bus Terminal bus measured by the controller.
-       */
-      template <typename scalar_type, typename index_type>
-      Reecb<scalar_type, index_type>::Reecb(BusT* bus)
-        : bus_(bus)
-      {
-        size_ = static_cast<IdxT>(Utilities::enum_size<ReecbInternalVariables>());
-        setDerivedParameters();
-      }
-
       /**
        * @brief Construct REECB from model data
        *

GridKit/Model/PhasorDynamics/Controller/REPCA/Repca.hpp

@@ -116,7 +116,6 @@ namespace GridKit
       public:
         static constexpr RealT INITIALIZATION_TOLERANCE = static_cast<RealT>(1.0e-12);
 
-        Repca(BusT* bus);
         Repca(BusT* bus, const ModelDataT& data);
         ~Repca();
 

GridKit/Model/PhasorDynamics/Controller/REPCA/RepcaImpl.hpp

@@ -28,23 +28,6 @@ namespace GridKit
       /// Logger used for REPCA diagnostics.
       using Log = ::GridKit::Utilities::Logger;
 
-      /**
-       * @brief Construct REPCA with its documented parameter defaults
-       *
-       * The regulated bus is retained, the model is sized, and every
-       * parameter keeps its documented default. No monitor or signal
-       * connection is created.
-       *
-       * @param[in] bus Regulated bus measured by the controller.
-       */
-      template <typename scalar_type, typename index_type>
-      Repca<scalar_type, index_type>::Repca(BusT* bus)
-        : bus_(bus)
-      {
-        size_ = static_cast<IdxT>(Utilities::enum_size<RepcaInternalVariables>());
-        setDerivedParameters();
-      }
-
       /**
        * @brief Construct REPCA from model data
        *

GridKit/Model/PhasorDynamics/Converter/REGCA/Regca.hpp

@@ -99,7 +99,6 @@ namespace GridKit
         using ExternalVariablesT = RegcaExternalVariables;
 
       public:
-        Regca(BusT* bus);
         Regca(BusT* bus, const ModelDataT& data);
         ~Regca();
 

GridKit/Model/PhasorDynamics/Converter/REGCA/RegcaImpl.hpp

@@ -27,18 +27,6 @@ namespace GridKit
     {
       using Log = ::GridKit::Utilities::Logger;
 
-      /**
-       * @brief Construct a sized but unconfigured REGCA converter.
-       *
-       * @param[in] bus Terminal bus the converter injects into.
-       */
-      template <typename scalar_type, typename index_type>
-      Regca<scalar_type, index_type>::Regca(BusT* bus)
-        : bus_(bus)
-      {
-        size_ = static_cast<IdxT>(Utilities::enum_size<RegcaInternalVariables>());
-      }
-
       /**
        * @brief Construct a REGCA converter from model data.
        *