Regulator class for automatic tap changer

code_generation/data/attribute_classes/input.json

@@ -420,6 +420,53 @@
                     "description": "short circuit impedance"
                 }
             ]
+        },
+        {
+            "name": "RegulatorInput",
+            "base": "BaseInput",
+            "attributes": [
+                {
+                    "data_type": "ID",
+                    "names": "regulated_object",
+                    "description": "ID of the regulated object"
+                },
+                {
+                    "data_type": "IntS",
+                    "names": "status",
+                    "description": "regulator enabled"
+                }
+            ]
+        },
+        {
+            "name": "TransformerTapRegulatorInput",
+            "base": "RegulatorInput",
+            "attributes": [
+                {
+                    "data_type": "ControlSide",
+                    "names": "control_side",
+                    "description": "control side of the (three winding) transformer"
+                },
+                {
+                    "data_type": "double",
+                    "names": "u_set",
+                    "description": "voltage setpoint"
+                },
+                {
+                    "data_type": "double",
+                    "names": "u_band",
+                    "description": "voltage bandwidth"
+                },
+                {
+                    "data_type": "double",
+                    "names": "line_drop_compensation_r",
+                    "description": "line drop compensation resistance"
+                },
+                {
+                    "data_type": "double",
+                    "names": "line_drop_compensation_x",
+                    "description": "line drop compensation reactance"
+                }
+            ]
         }
     ]
 }

code_generation/data/attribute_classes/output.json

@@ -275,6 +275,24 @@
             "base": "BaseOutput",
             "is_template": false,
             "attributes": []
+        },
+        {
+            "name": "TransformerTapRegulatorOutput",
+            "base": "BaseOutput",
+            "is_template": false,
+            "attributes": [
+                {
+                    "data_type": "IntS",
+                    "names": "tap_pos",
+                    "description": "result of regulated tap position"
+                }
+            ]
+        },
+        {
+            "name": "RegulatorShortCircuitOutput",
+            "base": "BaseOutput",
+            "is_template": false,
+            "attributes": []
         }
     ]
 }

code_generation/data/attribute_classes/update.json

@@ -206,6 +206,43 @@
                     "description": "short circuit impedance"
                 }
             ]
+        },
+        {
+            "name": "RegulatorUpdate",
+            "base": "BaseUpdate",
+            "attributes": [
+                {
+                    "data_type": "IntS",
+                    "names": "status",
+                    "description": "regulator enables"
+                }
+            ]
+        },
+        {
+            "name": "TransformerTapRegulatorUpdate",
+            "base": "RegulatorUpdate",
+            "attributes": [
+                {
+                    "data_type": "double",
+                    "names": "u_set",
+                    "description": "voltage setpoint"
+                },
+                {
+                    "data_type": "double",
+                    "names": "u_band",
+                    "description": "voltage bandwidth"
+                },
+                {
+                    "data_type": "double",
+                    "names": "line_drop_compensation_r",
+                    "description": "line drop compensation resistance"
+                },
+                {
+                    "data_type": "double",
+                    "names": "line_drop_compensation_x",
+                    "description": "line drop compensation reactance"
+                }
+            ]
         }
     ]
 }

power_grid_model_c/power_grid_model/include/power_grid_model/all_components.hpp

@@ -20,12 +20,13 @@
 #include "component/source.hpp"
 #include "component/three_winding_transformer.hpp"
 #include "component/transformer.hpp"
+#include "component/transformer_tap_regulator.hpp"
 #include "component/voltage_sensor.hpp"
 
 namespace power_grid_model {
 
-using AllComponents =
-    ComponentList<Node, Line, Link, Transformer, ThreeWindingTransformer, Shunt, Source, SymGenerator, AsymGenerator,
-                  SymLoad, AsymLoad, SymPowerSensor, AsymPowerSensor, SymVoltageSensor, AsymVoltageSensor, Fault>;
+using AllComponents = ComponentList<Node, Line, Link, Transformer, ThreeWindingTransformer, Shunt, Source, SymGenerator,
+                                    AsymGenerator, SymLoad, AsymLoad, SymPowerSensor, AsymPowerSensor, SymVoltageSensor,
+                                    AsymVoltageSensor, Fault, TransformerTapRegulator>;
 
 } // namespace power_grid_model

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/input.hpp

@@ -392,6 +392,35 @@ struct FaultInput {
     operator BaseInput const&() const { return reinterpret_cast<BaseInput const&>(*this); }
 };
 
+struct RegulatorInput {
+    ID id;  // ID of the object
+    ID regulated_object;  // ID of the regulated object
+    IntS status;  // regulator enabled
+
+    // implicit conversions to BaseInput
+    operator BaseInput&() { return reinterpret_cast<BaseInput&>(*this); }
+    operator BaseInput const&() const { return reinterpret_cast<BaseInput const&>(*this); }
+};
+
+struct TransformerTapRegulatorInput {
+    ID id;  // ID of the object
+    ID regulated_object;  // ID of the regulated object
+    IntS status;  // regulator enabled
+    ControlSide control_side;  // control side of the (three winding) transformer
+    double u_set;  // voltage setpoint
+    double u_band;  // voltage bandwidth
+    double line_drop_compensation_r;  // line drop compensation resistance
+    double line_drop_compensation_x;  // line drop compensation reactance
+
+    // implicit conversions to BaseInput
+    operator BaseInput&() { return reinterpret_cast<BaseInput&>(*this); }
+    operator BaseInput const&() const { return reinterpret_cast<BaseInput const&>(*this); }
+
+    // implicit conversions to RegulatorInput
+    operator RegulatorInput&() { return reinterpret_cast<RegulatorInput&>(*this); }
+    operator RegulatorInput const&() const { return reinterpret_cast<RegulatorInput const&>(*this); }
+};
+
 
 
 } // namespace power_grid_model

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/meta_gen/input.hpp

@@ -349,6 +349,33 @@ struct get_attributes_list<FaultInput> {
     };
 };
 
+template<>
+struct get_attributes_list<RegulatorInput> {
+    static constexpr std::array<MetaAttribute, 3> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<RegulatorInput, &RegulatorInput::id, offsetof(RegulatorInput, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<RegulatorInput, &RegulatorInput::regulated_object, offsetof(RegulatorInput, regulated_object), []{ return "regulated_object"; }>::value,
+            meta_data_gen::get_meta_attribute<RegulatorInput, &RegulatorInput::status, offsetof(RegulatorInput, status), []{ return "status"; }>::value,
+    };
+};
+
+template<>
+struct get_attributes_list<TransformerTapRegulatorInput> {
+    static constexpr std::array<MetaAttribute, 8> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::id, offsetof(TransformerTapRegulatorInput, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::regulated_object, offsetof(TransformerTapRegulatorInput, regulated_object), []{ return "regulated_object"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::status, offsetof(TransformerTapRegulatorInput, status), []{ return "status"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::control_side, offsetof(TransformerTapRegulatorInput, control_side), []{ return "control_side"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::u_set, offsetof(TransformerTapRegulatorInput, u_set), []{ return "u_set"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::u_band, offsetof(TransformerTapRegulatorInput, u_band), []{ return "u_band"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::line_drop_compensation_r, offsetof(TransformerTapRegulatorInput, line_drop_compensation_r), []{ return "line_drop_compensation_r"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorInput, &TransformerTapRegulatorInput::line_drop_compensation_x, offsetof(TransformerTapRegulatorInput, line_drop_compensation_x), []{ return "line_drop_compensation_x"; }>::value,
+    };
+};
+
 
 
 // template specialization functors to get nan
@@ -719,6 +746,37 @@ struct get_component_nan<FaultInput> {
     }
 };
 
+template<>
+struct get_component_nan<RegulatorInput> {
+    RegulatorInput operator() () const {
+        RegulatorInput comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.regulated_object);
+        set_nan(comp.status);
+        return comp;
+    }
+};
+
+template<>
+struct get_component_nan<TransformerTapRegulatorInput> {
+    TransformerTapRegulatorInput operator() () const {
+        TransformerTapRegulatorInput comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.regulated_object);
+        set_nan(comp.status);
+        set_nan(comp.control_side);
+        set_nan(comp.u_set);
+        set_nan(comp.u_band);
+        set_nan(comp.line_drop_compensation_r);
+        set_nan(comp.line_drop_compensation_x);
+        return comp;
+    }
+};
+
 
 
 } // namespace power_grid_model::meta_data

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/meta_gen/output.hpp

@@ -226,6 +226,27 @@ struct get_attributes_list<SensorShortCircuitOutput> {
     };
 };
 
+template<>
+struct get_attributes_list<TransformerTapRegulatorOutput> {
+    static constexpr std::array<MetaAttribute, 3> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorOutput, &TransformerTapRegulatorOutput::id, offsetof(TransformerTapRegulatorOutput, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorOutput, &TransformerTapRegulatorOutput::energized, offsetof(TransformerTapRegulatorOutput, energized), []{ return "energized"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorOutput, &TransformerTapRegulatorOutput::tap_pos, offsetof(TransformerTapRegulatorOutput, tap_pos), []{ return "tap_pos"; }>::value,
+    };
+};
+
+template<>
+struct get_attributes_list<RegulatorShortCircuitOutput> {
+    static constexpr std::array<MetaAttribute, 2> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<RegulatorShortCircuitOutput, &RegulatorShortCircuitOutput::id, offsetof(RegulatorShortCircuitOutput, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<RegulatorShortCircuitOutput, &RegulatorShortCircuitOutput::energized, offsetof(RegulatorShortCircuitOutput, energized), []{ return "energized"; }>::value,
+    };
+};
+
 
 
 // template specialization functors to get nan
@@ -463,6 +484,31 @@ struct get_component_nan<SensorShortCircuitOutput> {
     }
 };
 
+template<>
+struct get_component_nan<TransformerTapRegulatorOutput> {
+    TransformerTapRegulatorOutput operator() () const {
+        TransformerTapRegulatorOutput comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.energized);
+        set_nan(comp.tap_pos);
+        return comp;
+    }
+};
+
+template<>
+struct get_component_nan<RegulatorShortCircuitOutput> {
+    RegulatorShortCircuitOutput operator() () const {
+        RegulatorShortCircuitOutput comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.energized);
+        return comp;
+    }
+};
+
 
 
 } // namespace power_grid_model::meta_data

power_grid_model_c/power_grid_model/include/power_grid_model/auxiliary/meta_gen/update.hpp

@@ -173,6 +173,30 @@ struct get_attributes_list<FaultUpdate> {
     };
 };
 
+template<>
+struct get_attributes_list<RegulatorUpdate> {
+    static constexpr std::array<MetaAttribute, 2> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<RegulatorUpdate, &RegulatorUpdate::id, offsetof(RegulatorUpdate, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<RegulatorUpdate, &RegulatorUpdate::status, offsetof(RegulatorUpdate, status), []{ return "status"; }>::value,
+    };
+};
+
+template<>
+struct get_attributes_list<TransformerTapRegulatorUpdate> {
+    static constexpr std::array<MetaAttribute, 6> value{
+            // all attributes including base class
+
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::id, offsetof(TransformerTapRegulatorUpdate, id), []{ return "id"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::status, offsetof(TransformerTapRegulatorUpdate, status), []{ return "status"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::u_set, offsetof(TransformerTapRegulatorUpdate, u_set), []{ return "u_set"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::u_band, offsetof(TransformerTapRegulatorUpdate, u_band), []{ return "u_band"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::line_drop_compensation_r, offsetof(TransformerTapRegulatorUpdate, line_drop_compensation_r), []{ return "line_drop_compensation_r"; }>::value,
+            meta_data_gen::get_meta_attribute<TransformerTapRegulatorUpdate, &TransformerTapRegulatorUpdate::line_drop_compensation_x, offsetof(TransformerTapRegulatorUpdate, line_drop_compensation_x), []{ return "line_drop_compensation_x"; }>::value,
+    };
+};
+
 
 
 // template specialization functors to get nan
@@ -353,6 +377,34 @@ struct get_component_nan<FaultUpdate> {
     }
 };
 
+template<>
+struct get_component_nan<RegulatorUpdate> {
+    RegulatorUpdate operator() () const {
+        RegulatorUpdate comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.status);
+        return comp;
+    }
+};
+
+template<>
+struct get_component_nan<TransformerTapRegulatorUpdate> {
+    TransformerTapRegulatorUpdate operator() () const {
+        TransformerTapRegulatorUpdate comp;
+        // all attributes including base class
+
+        set_nan(comp.id);
+        set_nan(comp.status);
+        set_nan(comp.u_set);
+        set_nan(comp.u_band);
+        set_nan(comp.line_drop_compensation_r);
+        set_nan(comp.line_drop_compensation_x);
+        return comp;
+    }
+};
+
 
 
 } // namespace power_grid_model::meta_data