DecouplingIdealTransformer_EMT_Ph1.h

// SPDX-FileCopyrightText: 2026 Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include <vector>
 
#include "dpsim-models/Definitions.h"
#include "dpsim-models/EMT/EMT_Ph1_VoltageSource.h"
#include <dpsim-models/EMT/EMT_Ph1_CurrentSource.h>
#include <dpsim-models/EMT/EMT_Ph1_Resistor.h>
#include <dpsim-models/SimSignalComp.h>
#include <dpsim-models/Task.h>
 
namespace CPS {
namespace Signal {
 
class DecouplingIdealTransformer_EMT_Ph1
    : public SimSignalComp,
      public SharedFactory<DecouplingIdealTransformer_EMT_Ph1> {
protected:
  Real mDelay;
  Real mInternalSeriesResistance = 1e-6;
  Real mInternalParallelResistance = 1e6;
 
  std::shared_ptr<EMT::SimNode> mNode1, mNode2, mVirtualNode;
  std::shared_ptr<EMT::Ph1::Resistor> mRes1, mRes2;
  std::shared_ptr<EMT::Ph1::CurrentSource> mCurrentSrc;
  std::shared_ptr<EMT::Ph1::VoltageSource> mVoltageSrc;
  Attribute<Complex>::Ptr mSrcCurrent, mSrcVoltage;
 
  // Ringbuffers for the values of previous timesteps
  // TODO make these matrix attributes
  std::vector<Real> mCur1, mVol2;
 
  // Copy of the most recent elements of the ring buffers
  // They are used to perform extrapolation
  std::vector<Real> mCur1Extrap, mVol2Extrap;
  Real mCurrent1Extrap0;
 
  UInt mBufIdx = 0;
  UInt mMacroBufIdx = 0;
  UInt mBufSize;
  Real mAlpha;
  CouplingMethod mCouplingMethod;
  UInt mExtrapolationDegree = 0;
  Eigen::MatrixXd mVoltageSrcIntfCurr;
 
  // Get an approximate value of the signal in between steps when the delay is not an integer multiple of the step size
  Real interpolate(std::vector<Real> &data);
 
  // Estimates the value of the input signal in the next step
  Real extrapolate(std::vector<Real> &data);
 
public:
  typedef std::shared_ptr<DecouplingIdealTransformer_EMT_Ph1> Ptr;
 
  const Attribute<Real>::Ptr mSourceVoltageIntfVoltage;
  const Attribute<Real>::Ptr mSourceVoltageIntfCurrent;
  const Attribute<Real>::Ptr mSrcCurrentRef;
  const Attribute<Real>::Ptr mSrcVoltageRef;

  const Attribute<Matrix>::Ptr mStates;
 
  DecouplingIdealTransformer_EMT_Ph1(
      String name, Logger::Level logLevel = Logger::Level::info);
 
  void setParameters(SimNode<Real>::Ptr node1, SimNode<Real>::Ptr node2,
                     Real delay, Matrix voltageSrcIntfCurr,
                     Real current1Extrap0,
                     CouplingMethod method = CouplingMethod::DELAY);
  void initialize(Real omega, Real timeStep);
  void step(Real time, Int timeStepCount);
  void postStep();
  Task::List getTasks();
  IdentifiedObject::List getComponents();
  TopologicalNode::Ptr getVirtualNode();
 
  class PreStep : public Task {
  public:
    PreStep(DecouplingIdealTransformer_EMT_Ph1 &itm)
        : Task(**itm.mName + ".MnaPreStep"), mITM(itm) {
      mPrevStepDependencies.push_back(mITM.mStates);
      mModifiedAttributes.push_back(mITM.mVoltageSrc->mVoltageRef);
      mModifiedAttributes.push_back(mITM.mCurrentSrc->mCurrentRef);
    }
 
    void execute(Real time, Int timeStepCount);
 
  private:
    DecouplingIdealTransformer_EMT_Ph1 &mITM;
  };
 
  class PostStep : public Task {
  public:
    PostStep(DecouplingIdealTransformer_EMT_Ph1 &itm)
        : Task(**itm.mName + ".PostStep"), mITM(itm) {
      mAttributeDependencies.push_back(mITM.mVoltageSrc->mIntfVoltage);
      mAttributeDependencies.push_back(mITM.mVoltageSrc->mIntfCurrent);
      mAttributeDependencies.push_back(mITM.mCurrentSrc->mIntfVoltage);
      mAttributeDependencies.push_back(mITM.mCurrentSrc->mIntfCurrent);
      mModifiedAttributes.push_back(mITM.mStates);
    }
 
    void execute(Real time, Int timeStepCount);
 
  private:
    DecouplingIdealTransformer_EMT_Ph1 &mITM;
  };
};
} // namespace Signal
} // namespace CPS