MNAStateSpaceContributor.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Institute for Automation of Complex Power Systems, EONERC, RWTH Aachen University
// SPDX-License-Identifier: MPL-2.0
 
#pragma once
 
#include <array>
#include <memory>
#include <vector>
 
#include <dpsim-models/Solver/MNAInterface.h>
#include <dpsim/Definitions.h>
 
namespace DPsim {
 
struct StateSpaceAbcStateBlock {
  std::array<UInt, 3> indices;

  String name;
};
 
struct StateSpaceMetadata {
  std::vector<String> stateNames;

  std::vector<StateSpaceAbcStateBlock> abcStateBlocks;
};

class MNAStateSpaceContributor {
public:
  using Ptr = std::shared_ptr<MNAStateSpaceContributor>;
  using List = std::vector<Ptr>;
 
  virtual ~MNAStateSpaceContributor() = default;

  virtual UInt getStateCount() const = 0;

  virtual Bool contributesToUpdatedMatrices() const { return false; }

  virtual Bool requiresUpdate() const { return false; }

  virtual CPS::AttributeBase::List getAttributeDependencies() const {
    return {};
  }

  virtual void stamp(Matrix &AdLocal, Matrix &BdMna, Matrix &CdMna,
                     UInt stateOffset, UInt mnaVectorSize) const = 0;

  virtual void contributeMetadata(StateSpaceMetadata &metadata,
                                  UInt stateOffset) const {}
};

class MNAStateSpaceContributorFactory {
public:
  static MNAStateSpaceContributor::List
  createList(const CPS::MNAInterface::List &components);
 
private:
  static MNAStateSpaceContributor::Ptr
  create(const CPS::MNAInterface::Ptr &component);
};
 
} // namespace DPsim