SimPowerComp.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/SimNode.h>
#include <dpsim-models/SimTerminal.h>
#include <dpsim-models/TopologicalPowerComp.h>
 
namespace CPS {
template <typename VarType> class SimPowerComp : public TopologicalPowerComp {
 
protected:
  typename SimTerminal<VarType>::List mTerminals;
  typename SimNode<VarType>::List mVirtualNodes;
  Matrix mFrequencies;
  UInt mNumFreqs = 0;
  PhaseType mPhaseType = PhaseType::Single;

  typename std::vector<std::shared_ptr<SimPowerComp<VarType>>> mSubComponents;
  std::vector<UInt> mMatrixNodeIndices;
  std::vector<bool> mMatrixNodeIndexIsGround;
 
public:
  typedef VarType Type;
  typedef std::shared_ptr<SimPowerComp<VarType>> Ptr;
  typedef std::vector<Ptr> List;

  const typename Attribute<MatrixVar<VarType>>::Ptr mIntfVoltage;
  const typename Attribute<MatrixVar<VarType>>::Ptr mIntfCurrent;

  SimPowerComp(String uid, String name,
               Logger::Level logLevel = Logger::Level::off);
  SimPowerComp(String name, Logger::Level logLevel = Logger::Level::off)
      : SimPowerComp(name, name, logLevel) {}

  virtual ~SimPowerComp() {}

  virtual typename SimPowerComp<VarType>::Ptr clone(String name);
 
  // #### Terminals ####
  UInt terminalNumber();
  UInt terminalNumberConnected();
  Bool hasUnconnectedTerminals();
  void checkForUnconnectedTerminals();
  typename SimTerminal<VarType>::List terminals();
  typename SimTerminal<VarType>::Ptr terminal(UInt index);
  TopologicalTerminal::List topologicalTerminals();
  void setTerminalNumber(UInt num);
  void setTerminals(typename SimTerminal<VarType>::List terminals);
  void setTerminalAt(typename SimTerminal<VarType>::Ptr terminal,
                     UInt terminalPosition);

  void updateMatrixNodeIndices();
 
  // #### Nodes ####
  UInt nodeNumber();
  typename SimNode<VarType>::Ptr node(UInt index);
 
  UInt matrixNodeIndex(UInt nodeIndex);
 
  UInt matrixNodeIndex(UInt nodeIndex, UInt phaseIndex);
  std::vector<UInt> matrixNodeIndices(UInt index);
  TopologicalNode::List topologicalNodes();
 
  // #### Virtual Nodes ####
  UInt virtualNodesNumber();
  Bool hasVirtualNodes();
  Bool hasSubComponents();
  typename SimPowerComp<VarType>::List subComponents();
  typename SimNode<VarType>::List &virtualNodes();
  typename SimNode<VarType>::Ptr virtualNode(UInt index);
  std::vector<UInt> virtualMatrixNodeIndices(UInt index);
  UInt virtualSimNode(UInt nodeIndex, UInt phaseIndex = 0);
 
  // #### States ####
  const MatrixVar<VarType> &intfCurrent();
  const MatrixVar<VarType> &intfVoltage();
  MatrixComp initialVoltage(UInt index);
  Complex initialSingleVoltage(UInt index);
  Bool terminalNotGrounded(UInt index);
 
  // #### Setters ####
  void setIntfCurrent(MatrixVar<VarType> current);
  void setIntfVoltage(MatrixVar<VarType> voltage);
  void setVirtualNodeNumber(UInt num);
  void setVirtualNodeAt(typename SimNode<VarType>::Ptr virtualNode,
                        UInt nodeNum);
  void connect(typename SimNode<VarType>::List nodes);
 
  // #### Calculations ####
  virtual void initialize(Matrix frequencies);
  virtual void initializeFromNodesAndTerminals(Real frequency) {}
};
} // namespace CPS