DP_Ph1_Inductor.h

/* Copyright 2017-2021 Institute for Automation of Complex Power Systems,
 *                     EONERC, RWTH Aachen University
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 *********************************************************************************/
 
#pragma once
 
#include <dpsim-models/Base/Base_Ph1_Inductor.h>
#include <dpsim-models/MNASimPowerComp.h>
#include <dpsim-models/Solver/MNATearInterface.h>
 
namespace CPS {
namespace DP {
namespace Ph1 {
class Inductor : public MNASimPowerComp<Complex>,
                 public Base::Ph1::Inductor,
                 public MNATearInterface,
                 public SharedFactory<Inductor> {
protected:
  MatrixComp mEquivCurrent;
  MatrixComp mEquivCond;
  MatrixComp mPrevCurrFac;
  void initVars(Real timeStep);
 
public:
  Inductor(String uid, String name,
           Logger::Level logLevel = Logger::Level::off);
  Inductor(String name, Logger::Level logLevel = Logger::Level::off)
      : Inductor(name, name, logLevel) {}
 
  // #### General ####
  SimPowerComp<Complex>::Ptr clone(String name) override;
  void initialize(Matrix frequencies) override;
  void initializeFromNodesAndTerminals(Real frequency) override;
 
  // #### MNA section ####
  Complex getMNAConductance() const;
  void mnaCompInitialize(Real omega, Real timeStep,
                         Attribute<Matrix>::Ptr leftVector) override;
  void mnaCompInitializeHarm(
      Real omega, Real timeStep,
      std::vector<Attribute<Matrix>::Ptr> leftVectors) override;
  void mnaCompApplySystemMatrixStamp(SparseMatrixRow &systemMatrix) override;
  void mnaCompApplySystemMatrixStampHarm(SparseMatrixRow &systemMatrix,
                                         Int freqIdx) override;
  void mnaCompApplyRightSideVectorStamp(Matrix &rightVector) override;
  void mnaCompApplyRightSideVectorStampHarm(Matrix &rightVector) override;
  void mnaCompUpdateVoltage(const Matrix &leftVector) override;
  void mnaCompUpdateVoltageHarm(const Matrix &leftVector, Int freqIdx);
  void mnaCompUpdateCurrent(const Matrix &leftVector) override;
  void mnaCompUpdateCurrentHarm();
  void mnaCompPreStep(Real time, Int timeStepCount) override;
  void mnaCompPostStep(Real time, Int timeStepCount,
                       Attribute<Matrix>::Ptr &leftVector) override;
  void mnaCompAddPreStepDependencies(
      AttributeBase::List &prevStepDependencies,
      AttributeBase::List &attributeDependencies,
      AttributeBase::List &modifiedAttributes) override;
  void
  mnaCompAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                                 AttributeBase::List &attributeDependencies,
                                 AttributeBase::List &modifiedAttributes,
                                 Attribute<Matrix>::Ptr &leftVector) override;
 
  // #### Tearing methods ####
  void mnaTearInitialize(Real omega, Real timestep) override;
  void mnaTearApplyMatrixStamp(SparseMatrixRow &tearMatrix) override;
  void mnaTearApplyVoltageStamp(Matrix &voltageVector) override;
  void mnaTearPostStep(Complex voltage, Complex current) override;
 
  class MnaPreStepHarm : public Task {
  public:
    MnaPreStepHarm(Inductor &inductor)
        : Task(**inductor.mName + ".MnaPreStepHarm"), mInductor(inductor) {
      // actually depends on L, but then we'd have to modify the system matrix anyway
      mModifiedAttributes.push_back(inductor.attribute("right_vector"));
      mPrevStepDependencies.push_back(inductor.attribute("v_intf"));
      mPrevStepDependencies.push_back(inductor.attribute("i_intf"));
    }
    void execute(Real time, Int timeStepCount);
 
  private:
    Inductor &mInductor;
  };
 
  class MnaPostStepHarm : public Task {
  public:
    MnaPostStepHarm(Inductor &inductor,
                    const std::vector<Attribute<Matrix>::Ptr> &leftVectors)
        : Task(**inductor.mName + ".MnaPostStepHarm"), mInductor(inductor),
          mLeftVectors(leftVectors) {
      for (UInt i = 0; i < mLeftVectors.size(); i++)
        mAttributeDependencies.push_back(mLeftVectors[i]);
      mModifiedAttributes.push_back(mInductor.attribute("v_intf"));
      mModifiedAttributes.push_back(mInductor.attribute("i_intf"));
    }
    void execute(Real time, Int timeStepCount);
 
  private:
    Inductor &mInductor;
    std::vector<Attribute<Matrix>::Ptr> mLeftVectors;
  };
};
} // namespace Ph1
} // namespace DP
} // namespace CPS