TopologicalNode.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/IdentifiedObject.h>
#include <dpsim-models/MathUtils.h>
#include <dpsim-models/PtrFactory.h>
 
namespace CPS {
 
class TopologicalNode : public IdentifiedObject {
protected:
  PhaseType mPhaseType = PhaseType::Single;
  Bool mIsGround = false;
 
public:
  typedef std::shared_ptr<TopologicalNode> Ptr;
  typedef std::vector<Ptr> List;
 
  const Attribute<MatrixComp>::Ptr mInitialVoltage;
 
  TopologicalNode() {}
  TopologicalNode(String uid, String name, PhaseType phaseType,
                  const std::vector<Complex> &initialVoltage);
  virtual ~TopologicalNode() {}

  Bool isGround() const;
  MatrixComp initialVoltage() const;
  void setInitialVoltage(MatrixComp voltage) const;
  void setInitialVoltage(Complex voltage) const;
  void setInitialVoltage(Complex voltage, Int phaseIndex) const;
  Complex initialSingleVoltage(PhaseType phaseType = PhaseType::Single);
  PhaseType phaseType() const;
  virtual UInt matrixNodeIndex(PhaseType phaseType = PhaseType::Single) = 0;
  virtual std::vector<UInt> matrixNodeIndices() = 0;
  virtual void setMatrixNodeIndex(UInt phase, UInt matrixNodeIndex) = 0;
};
} // namespace CPS