Base_ReducedOrderSynchronGenerator.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_Exciter.h>
#include <dpsim-models/Base/Base_Governor.h>
#include <dpsim-models/Base/Base_PSS.h>
#include <dpsim-models/Base/Base_Turbine.h>
#include <dpsim-models/MNASimPowerComp.h>
#include <dpsim-models/Signal/TurbineGovernorType1.h>
#include <dpsim-models/Solver/MNAInterface.h>
 
namespace CPS {
namespace Base {
 
template <typename VarType>
class ReducedOrderSynchronGenerator : public MNASimPowerComp<VarType> {
 
public:
  // ### State variables [p.u.]###
  const Attribute<Matrix>::Ptr mVdq0;
  const Attribute<Matrix>::Ptr mIdq0;
  const Attribute<Matrix>::Ptr mVdq;
  const Attribute<Matrix>::Ptr mIdq;
  const Attribute<Complex>::Ptr mPower;
  const Attribute<Real>::Ptr mElecTorque;
  const Attribute<Real>::Ptr mMechTorque;
  Real mMechTorque_prev;
  const Attribute<Real>::Ptr mOmMech;
  const Attribute<Real>::Ptr mThetaMech;
  const Attribute<Real>::Ptr mDelta;
  const Attribute<Real>::Ptr mEf;
  Real mEf_prev;

  virtual ~ReducedOrderSynchronGenerator() {}
  virtual void setModelAsNortonSource(Bool modelAsCurrentSource);
  void setBaseParameters(Real nomPower, Real nomVolt, Real nomFreq);
  void setOperationalParametersPerUnit(Real nomPower, Real nomVolt,
                                       Real nomFreq, Real H, Real Ld, Real Lq,
                                       Real L0, Real Ld_t, Real Td0_t);
  void setOperationalParametersPerUnit(Real nomPower, Real nomVolt,
                                       Real nomFreq, Real H, Real Ld, Real Lq,
                                       Real L0, Real Ld_t, Real Lq_t,
                                       Real Td0_t, Real Tq0_t);
  void setOperationalParametersPerUnit(Real nomPower, Real nomVolt,
                                       Real nomFreq, Real H, Real Ld, Real Lq,
                                       Real L0, Real Ld_t, Real Lq_t,
                                       Real Td0_t, Real Tq0_t, Real Ld_s,
                                       Real Lq_s, Real Td0_s, Real Tq0_s,
                                       Real Taa = 0);
  void setInitialValues(Complex initComplexElectricalPower,
                        Real initMechanicalPower, Complex initTerminalVoltage);

  void addGovernor(Real T3, Real T4, Real T5, Real Tc, Real Ts, Real R,
                   Real Pmin, Real Pmax, Real OmRef, Real TmRef);
  void
  addGovernor(std::shared_ptr<Signal::TurbineGovernorType1> turbineGovernor);
  void
  addGovernorAndTurbine(std::shared_ptr<Base::Governor> governor,
                        std::shared_ptr<Base::GovernorParameters> govParams,
                        std::shared_ptr<Base::Turbine> turbine,
                        std::shared_ptr<Base::TurbineParameters> turbineParams);
  void addGovernorAndTurbine(std::shared_ptr<Base::Governor> governor,
                             std::shared_ptr<Base::Turbine> turbine);
  void addExciter(std::shared_ptr<Base::Exciter> exciter,
                  std::shared_ptr<Base::ExciterParameters> params);
  void addExciter(std::shared_ptr<Base::Exciter> exciter);
 
  // Deprecated method
  void addExciter(Real Ta, Real Ka, Real Te, Real Ke, Real Tf, Real Kf,
                  Real Tr);
  void addPSS(std::shared_ptr<Base::PSS> pss,
              std::shared_ptr<Base::PSSParameters> parameters);
  void addPSS(std::shared_ptr<Base::PSS> pss);

  void scaleInertiaConstant(Real scalingFactor);
 
protected:
  using MNASimPowerComp<VarType>::mRightVector;
  using MNASimPowerComp<VarType>::mIntfVoltage;

  ReducedOrderSynchronGenerator(String uid, String name,
                                Logger::Level logLevel);
  void calculateVBRconstants();
  void calculateResistanceMatrixConstants();
  virtual void initializeResistanceMatrix() = 0;
  void initializeFromNodesAndTerminals(Real frequency) override;
  virtual void specificInitialization() = 0;
  virtual void stepInPerUnit() = 0;
 
  // ### MNA Section ###
  void mnaCompInitialize(Real omega, Real timeStep,
                         Attribute<Matrix>::Ptr leftVector) override;
  void mnaCompAddPreStepDependencies(
      AttributeBase::List &prevStepDependencies,
      AttributeBase::List &attributeDependencies,
      AttributeBase::List &modifiedAttributes) override;
  void mnaCompPreStep(Real time, Int timeStepCount) override;
  void
  mnaCompAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                                 AttributeBase::List &attributeDependencies,
                                 AttributeBase::List &modifiedAttributes,
                                 Attribute<Matrix>::Ptr &leftVector) override;
  void mnaCompPostStep(Real time, Int timeStepCount,
                       Attribute<Matrix>::Ptr &leftVector) final;
  virtual void mnaCompPostStep(const Matrix &leftVector) = 0;
  virtual void
  mnaCompApplySystemMatrixStamp(SparseMatrixRow &systemMatrix) override = 0;
  Bool mModelAsNortonSource;
  // Model flag indicating the SG order to be used
  SGOrder mSGOrder;
 
  // ### Base quantities (stator refered) ###
  Real mNomPower;
  Real mNomVolt;
  // Nominal frequency
  Real mNomFreq;
  Real mNomOmega;
  Real mBase_V_RMS;
  Real mBase_V;
  Real mBase_I_RMS;
  Real mBase_I;
  Real mBase_Z;
  Real mBase_OmElec;
  Real mBase_L;
  Real mBase_OmMech;
  Real mH;
 
  // ### Operational Parameters  (p.u.) ###
  Real mLd = 0;
  Real mLq = 0;
  Real mL0 = 0;
  Real mLd_t = 0;
  Real mLq_t = 0;
  Real mLd_s = 0;
  Real mLq_s = 0;
  Real mTd0_t = 0;
  Real mTq0_t = 0;
  Real mTd0_s = 0;
  Real mTq0_s = 0;
  Real mTaa = 0;
 
  // ### VBR constants ###
  Real mAd_t = 0;
  Real mBd_t = 0;
  Real mAq_t = 0;
  Real mBq_t = 0;
  Real mDq_t = 0;
  Real mAd_s = 0;
  Real mAq_s = 0;
  Real mBd_s = 0;
  Real mBq_s = 0;
  Real mCd_s = 0;
  Real mCq_s = 0;
  Real mDq_s = 0;
  Real mYd = 0;
  Real mYq = 0;
 
  // ### Constants of resistance matrix (VBR) ###
  Real mA = 0;
  Real mB = 0;
 
  // ### Initial values ###
  Complex mIntfCurrentComplex;
  Complex mIntfVoltageComplex;
  Complex mInitElecPower;
  Real mInitMechPower;
  Complex mInitVoltage;
  Real mInitVoltageAngle;
  Complex mInitCurrent;
  Real mInitCurrentAngle;

  Bool mInitialValuesSet = false;
 
  // #### Controllers ####
  Bool mHasTurbineGovernor = false;
  Bool mHasGovernorAndTurbine = false;
  Bool mHasExciter = false;
  Bool mHasPSS = false;
  std::shared_ptr<Signal::TurbineGovernorType1> mTurbineGovernor;
  std::shared_ptr<Base::Governor> mGovernor;
  std::shared_ptr<Base::Turbine> mTurbine;
  std::shared_ptr<Base::Exciter> mExciter;
  std::shared_ptr<Base::PSS> mPSS;

  Real mTimeStep;
  Real mSimTime;
  Real mVpss = 0;
};
} // namespace Base
} // namespace CPS