MNAInterface.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/AttributeList.h>
#include <dpsim-models/Config.h>
#include <dpsim-models/Definitions.h>
#include <dpsim-models/Task.h>
 
namespace CPS {
class MNAInterface {
public:
  typedef std::shared_ptr<MNAInterface> Ptr;
  typedef std::vector<Ptr> List;
 
  // #### MNA Base Functions ####
  virtual void createSubComponents() {}
  virtual void mnaInitialize(Real omega, Real timeStep) = 0;
  virtual void mnaInitialize(Real omega, Real timeStep,
                             Attribute<Matrix>::Ptr leftVector) = 0;
  virtual void mnaApplySystemMatrixStamp(SparseMatrixRow &systemMatrix) = 0;
  virtual void mnaApplyRightSideVectorStamp(Matrix &rightVector) = 0;
  virtual void mnaUpdateVoltage(const Matrix &leftVector) = 0;
  virtual void mnaUpdateCurrent(const Matrix &leftVector) = 0;
  virtual void mnaPreStep(Real time, Int timeStepCount) = 0;
  virtual void mnaPostStep(Real time, Int timeStepCount,
                           Attribute<Matrix>::Ptr &leftVector) = 0;
  virtual void
  mnaAddPreStepDependencies(AttributeBase::List &prevStepDependencies,
                            AttributeBase::List &attributeDependencies,
                            AttributeBase::List &modifiedAttributes) = 0;
  virtual void
  mnaAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                             AttributeBase::List &attributeDependencies,
                             AttributeBase::List &modifiedAttributes,
                             Attribute<Matrix>::Ptr &leftVector) = 0;
 
  // #### MNA Harmonic Base Functions ####
  virtual void
  mnaInitializeHarm(Real omega, Real timeStep,
                    std::vector<Attribute<Matrix>::Ptr> leftVector) = 0;
  virtual void mnaApplySystemMatrixStampHarm(SparseMatrixRow &systemMatrix,
                                             Int freqIdx) = 0;
  virtual void mnaApplyRightSideVectorStampHarm(Matrix &sourceVector) = 0;
  virtual void mnaApplyRightSideVectorStampHarm(Matrix &sourceVector,
                                                Int freqIdx) = 0;
  virtual const Task::List &mnaTasks() const = 0;
  // Return right vector attribute
  virtual Attribute<Matrix>::Ptr getRightVector() const = 0;
};
} // namespace CPS