SP_Ph1_SynchronGeneratorTrStab.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_SynchronGenerator.h>
#include <dpsim-models/CompositePowerComp.h>
#include <dpsim-models/SP/SP_Ph1_Inductor.h>
#include <dpsim-models/SP/SP_Ph1_VoltageSource.h>
#include <dpsim-models/Solver/MNAInterface.h>
 
namespace CPS {
namespace SP {
namespace Ph1 {
class SynchronGeneratorTrStab : public CompositePowerComp<Complex>,
                                public Base::SynchronGenerator,
                                public SharedFactory<SynchronGeneratorTrStab> {
protected:
  // #### Model specific variables ####
  Real mXpd;
  Real mLpd;
  Real mKd;
  Complex mImpedance;
  std::shared_ptr<VoltageSource> mSubVoltageSource;
  std::shared_ptr<Inductor> mSubInductor;
  Matrix mStates;
  Bool mUseOmegaRef = false;
  Bool mConvertWithOmegaMech = true;
 
public:
  // #### Model specific variables ####
  const Attribute<Complex>::Ptr mEp;
  const Attribute<Real>::Ptr mEp_abs;
  const Attribute<Real>::Ptr mEp_phase;
  const Attribute<Real>::Ptr mDelta_p;
  const Attribute<Real>::Ptr mRefOmega;
  const Attribute<Real>::Ptr mRefDelta;
  SynchronGeneratorTrStab(String uid, String name,
                          Logger::Level logLevel = Logger::Level::off);
  SynchronGeneratorTrStab(String name,
                          Logger::Level logLevel = Logger::Level::off)
      : SynchronGeneratorTrStab(name, name, logLevel) {}
 
  SimPowerComp<Complex>::Ptr clone(String name) override;
 
  // #### General Functions ####
  void setModelFlags(Bool convertWithOmegaMech);
  void setInitialValues(Complex elecPower, Real mechPower);
  void setFundamentalParametersPU(Real nomPower, Real nomVolt, Real nomFreq,
                                  Real Ll, Real Lmd, Real Llfd, Real inertia,
                                  Real D = 0);
  void setStandardParametersSI(Real nomPower, Real nomVolt, Real nomFreq,
                               Int polePairNumber, Real Rs, Real Lpd,
                               Real inertiaJ, Real Kd = 0);
  void setStandardParametersPU(Real nomPower, Real nomVolt, Real nomFreq,
                               Real Xpd, Real inertia, Real Rs = 0, Real D = 0);
  void step(Real time);
  void initializeFromNodesAndTerminals(Real frequency) override;
 
  // #### MNA Functions ####
  void mnaParentInitialize(Real omega, Real timeStep,
                           Attribute<Matrix>::Ptr leftVector) override;
 
  void mnaParentPreStep(Real time, Int timeStepCount) override;
  void mnaParentPostStep(Real time, Int timeStepCount,
                         Attribute<Matrix>::Ptr &leftVector) override;
  void mnaCompUpdateCurrent(const Matrix &leftVector) override;
  void mnaCompUpdateVoltage(const Matrix &leftVector) override;
 
  void mnaParentAddPreStepDependencies(
      AttributeBase::List &prevStepDependencies,
      AttributeBase::List &attributeDependencies,
      AttributeBase::List &modifiedAttributes) override;
  void
  mnaParentAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                                   AttributeBase::List &attributeDependencies,
                                   AttributeBase::List &modifiedAttributes,
                                   Attribute<Matrix>::Ptr &leftVector) override;
 
  void setReferenceOmega(Attribute<Real>::Ptr refOmegaPtr,
                         Attribute<Real>::Ptr refDeltaPtr);
  class AddBStep : public Task {
  public:
    AddBStep(SynchronGeneratorTrStab &generator)
        : Task(**generator.mName + ".AddBStep"), mGenerator(generator) {
      mAttributeDependencies.push_back(
          generator.mSubVoltageSource->attribute("right_vector"));
      mAttributeDependencies.push_back(
          generator.mSubInductor->attribute("right_vector"));
      mModifiedAttributes.push_back(generator.attribute("right_vector"));
    }
 
    void execute(Real time, Int timeStepCount);
 
  private:
    SynchronGeneratorTrStab &mGenerator;
  };
};
} // namespace Ph1
} // namespace SP
} // namespace CPS