Decoupling ITM by pipeacosta · Pull Request #423 · sogno-platform/dpsim

pipeacosta · 2025-11-21T12:49:13Z

This PR implements new decoupling elements based on the Ideal Transformer Model (ITM) for exemplifying co-simulation scenarios.

codecov · 2025-11-21T13:20:31Z

Codecov Report

❌ Patch coverage is 71.98795% with 186 lines in your changes missing coverage. Please review.
✅ Project coverage is 65.79%. Comparing base (379e89e) to head (579b4bf).

Files with missing lines	Patch %	Lines
.../src/Signal/DecouplingIdealTransformer_EMT_Ph1.cpp	0.00%	100 Missing ⚠️
.../src/Signal/DecouplingIdealTransformer_EMT_Ph3.cpp	84.61%	18 Missing ⚠️
...s/src/Signal/DecouplingIdealTransformer_SP_Ph1.cpp	86.84%	15 Missing ⚠️
...models/Signal/DecouplingIdealTransformer_EMT_Ph1.h	0.00%	12 Missing ⚠️
...m-models/src/SP/SP_Ph1_ControlledCurrentSource.cpp	76.92%	12 Missing ⚠️
...m-models/src/SP/SP_Ph1_ControlledVoltageSource.cpp	83.33%	11 Missing ⚠️
dpsim-models/src/EMT/EMT_Ph3_RXLoad.cpp	73.07%	7 Missing ⚠️
dpsim-models/src/SimNode.cpp	0.00%	4 Missing ⚠️
dpsim-models/src/SystemTopology.cpp	0.00%	4 Missing ⚠️
dpsim/src/pybind/SignalComponents.cpp	91.17%	3 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #423      +/-   ##
==========================================
+ Coverage   65.22%   65.79%   +0.57%     
==========================================
  Files         374      385      +11     
  Lines       22723    23369     +646     
  Branches    11240    11616     +376     
==========================================
+ Hits        14820    15375     +555     
- Misses       7877     7939      +62     
- Partials       26       55      +29

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

a initPowerFromTerminal method was implemented to be able to set the parameters of the load before running the simulation. Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Modified the setParameters function of the DecouplingIdealTransformerEMT. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

…xample. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

delay in the ITM. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

- Add parameters for consistent initialization using extrapolation - Improve initialization - Refactor: Rename decoupling node specifying that it is Ph1 Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

leonardocarreras

Hi Andres! Thanks for the PR! This is just a quick first comment. We can discuss more and see how to integrate it.

leonardocarreras · 2025-11-21T12:57:24Z

dpsim-models/include/dpsim-models/EMT/EMT_Ph3_RXLoad.h

  /// Initializes component from power flow data
  void initializeFromNodesAndTerminals(Real frequency) override;
+  ///
+  void initPowerFromTerminal();


Is good to use a verb for the function name, i.e. initializePowerFromTerminal... In my opinion is also important to see if this is active, reactive or both powers. I think is possible to use the comment on top to say this in the code.

leonardocarreras · 2025-11-21T13:06:20Z

dpsim-models/src/SystemTopology.cpp

+void SystemTopology::removeNode(const String &name) {
+  for (auto it = mNodes.begin(); it != mNodes.end(); ) {
+    if ((*it)->name() == name) {
+      it = mNodes.erase(it);


Does this makes sure to collect the components connected to the node and erase them too?

leonardocarreras · 2025-11-21T13:08:28Z

dpsim/examples/cxx/CIM/EMT_WSCC_9bus_split_decoupled_node.cpp

+  if (args.options.find("seq") != args.options.end())
+    numSeq = args.getOptionInt("seq");
+
+  std::cout << "Simulate with " << numThreads


Please use a logger

leonardocarreras · 2025-11-26T15:05:42Z

dpsim-models/include/dpsim-models/Signal/DecouplingIdealTransformer_EMT_Ph1.h

+  UInt mExtrapolationDegree = 0;
+  Eigen::MatrixXd mVoltageSrcIntfCurr;
+
+  Real interpolate(std::vector<Real> &data);


what does this inter/extrapolate? maybe more explanation can help

leonardocarreras · 2025-11-26T15:06:20Z

dpsim-models/include/dpsim-models/Signal/DecouplingIdealTransformer_EMT_Ph1.h

+public:
+  typedef std::shared_ptr<DecouplingIdealTransformer_EMT_Ph1> Ptr;
+
+  const Attribute<Real>::Ptr mSourceVoltageIntfVoltage;


if possible, a drawing of this circuit in the documentation will help

leonardocarreras · 2025-11-26T15:16:07Z

dpsim-models/src/EMT/EMT_Ph3_RXLoad.cpp

-                       Logger::matrixToString(**mActivePower),
-                       Logger::matrixToString(**mReactivePower));
-    SPDLOG_LOGGER_INFO(mSLog, "Nominal Voltage={} [V]", **mNomVoltage);
+  if (doInitPowerFromTerminal) {


why is this change needed?

leonardocarreras · 2025-11-26T15:17:09Z

dpsim-models/src/EMT/EMT_Ph3_RXLoad.cpp

+
+SimPowerComp<Real>::Ptr EMT::Ph3::RXLoad::clone(String name) {
+  if (doInitPowerFromTerminal) {
+    initPowerFromTerminal();


why is this needed/cannot use existing function?

leonardocarreras · 2025-11-26T15:23:43Z

dpsim-models/include/dpsim-models/EMT/EMT_Ph3_RXLoad.h

  Matrix mCapacitance;
  ///
-  Bool initPowerFromTerminal = true;
+  Bool doInitPowerFromTerminal = true;


mInitPowerFromTerminals ? new name has verb, is preferable that variables have noun names

leonardocarreras · 2025-11-26T15:24:05Z

dpsim-models/include/dpsim-models/Signal/DecouplingIdealTransformer_EMT_Ph1.h

+protected:
+  Real mDelay;
+
+  std::shared_ptr<EMT::SimNode> mNode1, mNode2;


please draw the circuit and add it to the documentation

leonardocarreras · 2025-11-26T15:27:28Z

dpsim/src/pybind/main.cpp

      .def(py::init<CPS::Real>())
      .def("add", &DPsim::SystemTopology::addComponent)
      .def("add", &DPsim::SystemTopology::addComponents)
+      .def("add_node", &DPsim::SystemTopology::addNode)


should we overload add? as we do not have add component or add signal separately

leonardocarreras

Hi Andres! Please have a look to the comments! Thanks for the PR!

pipeacosta requested a review from leonardocarreras November 21, 2025 12:49

pipeacosta self-assigned this Nov 21, 2025

pipeacosta added the enhancement New feature or request label Nov 21, 2025

leonardocarreras added this to DPsim Nov 21, 2025

leonardocarreras moved this to In Progress in DPsim Nov 21, 2025

pipeacosta force-pushed the decoupling-itm branch from e427a58 to 38abe56 Compare November 23, 2025 10:54

pipeacosta added 23 commits November 24, 2025 12:37

Implement clone method in SimNode class.

e4bff3f

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Initial implementation of decoupling node example.

1bacff4

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement EMT_Ph3_RXLoad clone method. Moreover,

6401969

a initPowerFromTerminal method was implemented to be able to set the parameters of the load before running the simulation. Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement removeNode method in SystemTopology.

dc44ce9

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement new component DecouplingIdealTransformerEMT.

eee452b

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Add decoupling ideal transformer to the decoupling node example.

894f985

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Implemented simplified decoupling node example.

fbbe9c3

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Relocate simplified circuit for decoupling node testing.

af63b26

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Implement getComponents method in DecouplingIdealTransformerEMT.

3888c49

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Fix decoupling node example by adding ITM components.

6501968

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Add extrapolation methods to the DecouplingIdealTransformerEMT class

12db29a

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Improve decoupling node example with extrapolation methods

f0d0138

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Fixed bug in the 9 bus decoupling node example.

8be6126

Modified the setParameters function of the DecouplingIdealTransformerEMT. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Implement command line arguments in the EMT_RC_split_decoupled_node e…

653fe33

…xample. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Fixed bug in the setParameters method of DecouplingIdealTransformerEMT.

ee5e903

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Add default value to the delay parameter in EMT_RC_split_decoupled_node.

bed81ed

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Validate co-simulation method in DecouplingIdealTransformerEMT example.

bdfbc7e

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Implement support for zero delay in DecouplingIdealTransformerEMT.

57ee6bd

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Finalize implementation of EMT_WSCC_9bus_split_decoupled_node with zero

e71df43

delay in the ITM. Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Initialize co-simulation method in EMT_RC_split_decoupled_node example.

bf8389e

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Add default prefix to EMT_RC_split_decoupled_node example.

f4f487d

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

- Implement voltage and current interface parameters in decoupling ITM

8dff905

- Add parameters for consistent initialization using extrapolation - Improve initialization - Refactor: Rename decoupling node specifying that it is Ph1 Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

Implement Notebook to validate the accuracy of the decoupling ITM

fa5b2b5

Signed-off-by: Andres Acosta <pipeacosta@gmail.com>

pipeacosta added 10 commits November 24, 2025 12:37

Implement and text DecouplingIdealTransformer_EMT_Ph3.

a237538

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement new Notebook to test the decoupling ITM Ph3.

14cc930

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Improve nine bus decoupling example with 3ph decoupling ITM.

52614ab

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Add DecouplingIdealTransformer_EMT_Ph3 to dpsimpy

3889fcc

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Add extrapolation method types to dpsimpy.

52459ae

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Improvements to the Decoupling ITM examples. Code cleaning.

44d15d0

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement component DecouplingIdealTransformer_SP_Ph1.

5876bf8

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Implement new Notebook to test the decoupling ITM.

695d2d3

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Run pre-commit hooks.

a61bc19

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

Add internal resistors to 3-phase decoupling ITM,

3df984d

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

pipeacosta force-pushed the decoupling-itm branch from 37bcc73 to 3df984d Compare November 24, 2025 12:39

Add SP_ITM_withPiLine_Ph1.cpp to 'tests' target.

05e6e85

Signed-off-by: pipeacosta <pipeacosta@gmail.com>

leonardocarreras added this to the Release: Next version milestone Nov 25, 2025

pipeacosta marked this pull request as ready for review November 25, 2025 11:57

pipeacosta requested review from dinkelbachjan, gnakti, m-mirz and stv0g as code owners November 25, 2025 11:57

Merge branch 'master' into decoupling-itm

579b4bf

leonardocarreras moved this from In Progress to Ready for Review in DPsim Nov 26, 2025

leonardocarreras approved these changes Nov 26, 2025

View reviewed changes

leonardocarreras requested changes Nov 26, 2025

View reviewed changes

Conversation

pipeacosta commented Nov 21, 2025

Uh oh!

codecov bot commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

leonardocarreras left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leonardocarreras left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov bot commented Nov 21, 2025 •

edited

Loading