CompositePowerComp.h

// SPDX-License-Identifier: Apache-2.0
 
#pragma once
 
#include <dpsim-models/MNASimPowerComp.h>
 
namespace CPS {
enum class MNA_SUBCOMP_TASK_ORDER {
  NO_TASK,
  TASK_BEFORE_PARENT,
  TASK_AFTER_PARENT
};

template <typename VarType>
class CompositePowerComp : public MNASimPowerComp<VarType> {
 
private:
  MNAInterface::List mSubcomponentsMNA;
  MNAInterface::List mSubcomponentsPreStepBeforeParent;
  MNAInterface::List mSubcomponentsPreStepAfterParent;
  MNAInterface::List mSubcomponentsPostStepBeforeParent;
  MNAInterface::List mSubcomponentsPostStepAfterParent;
 
  std::vector<CPS::Attribute<Matrix>::Ptr> mRightVectorStamps;
 
protected:
  bool mSubCompCreated = false;
 
public:
  using Type = VarType;
  using Ptr = std::shared_ptr<CompositePowerComp<VarType>>;
  using List = std::vector<Ptr>;

  CompositePowerComp(String uid, String name, Bool hasPreStep, Bool hasPostStep,
                     Logger::Level logLevel)
      : MNASimPowerComp<VarType>(uid, name, hasPreStep, hasPostStep, logLevel) {
  }

  CompositePowerComp(String name, Bool hasPreStep = true,
                     Bool hasPostStep = true,
                     Logger::Level logLevel = Logger::Level::off)
      : CompositePowerComp<VarType>(name, name, hasPreStep, hasPostStep,
                                    logLevel) {}

  virtual ~CompositePowerComp() = default;

  const MNAInterface::List &mnaSubComponents() const noexcept {
    return mSubcomponentsMNA;
  }

  void initializeFromNodesAndTerminals(Real frequency) override final;

  virtual void initializeParentFromNodesAndTerminals(Real frequency) = 0;

  void addMNASubComponent(typename SimPowerComp<VarType>::Ptr subc,
                          MNA_SUBCOMP_TASK_ORDER preStepOrder,
                          MNA_SUBCOMP_TASK_ORDER postStepOrder,
                          Bool contributeToRightVector);
 
  // #### MNA Interface Functions ####
  void mnaCompInitialize(Real omega, Real timeStep,
                         Attribute<Matrix>::Ptr leftVector) override;
  void mnaCompApplySystemMatrixStamp(SparseMatrixRow &systemMatrix) override;
  void mnaCompApplyRightSideVectorStamp(Matrix &rightVector) override;
  void mnaCompPreStep(Real time, Int timeStepCount) override;
  void mnaCompPostStep(Real time, Int timeStepCount,
                       Attribute<Matrix>::Ptr &leftVector) override;
  void mnaCompAddPreStepDependencies(
      AttributeBase::List &prevStepDependencies,
      AttributeBase::List &attributeDependencies,
      AttributeBase::List &modifiedAttributes) override;
  void
  mnaCompAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                                 AttributeBase::List &attributeDependencies,
                                 AttributeBase::List &modifiedAttributes,
                                 Attribute<Matrix>::Ptr &leftVector) override;
 
  // #### MNA Parent Functions ####
  virtual void mnaParentInitialize(Real omega, Real timeStep,
                                   Attribute<Matrix>::Ptr leftVector){
      // By default, the parent has no custom initialization beyond what is done in CompositePowerComp::mnaCompInitialize
  };
  virtual void mnaParentApplySystemMatrixStamp(SparseMatrixRow &systemMatrix){
      // By default, the parent has no custom stamp on the system matrix, only the subcomponents are stamped
  };
  virtual void mnaParentApplyRightSideVectorStamp(Matrix &rightVector){
      // By default, the parent has no custom stamp on the right vector, only the subcomponents are stamped
  };
  virtual void mnaParentPreStep(Real time, Int timeStepCount){
      // By default, the parent has no custom pre-step, only the subcomponents' pre-steps are executed
  };
  virtual void mnaParentPostStep(Real time, Int timeStepCount,
                                 Attribute<Matrix>::Ptr &leftVector){
      // By default, the parent has no custom post-step, only the subcomponents' post-steps are executed
  };
  virtual void
  mnaParentAddPreStepDependencies(AttributeBase::List &prevStepDependencies,
                                  AttributeBase::List &attributeDependencies,
                                  AttributeBase::List &modifiedAttributes){
      // By default, the parent has no custom pre-step-dependencies, only the subcomponents' dependencies are added
  };
  virtual void
  mnaParentAddPostStepDependencies(AttributeBase::List &prevStepDependencies,
                                   AttributeBase::List &attributeDependencies,
                                   AttributeBase::List &modifiedAttributes,
                                   Attribute<Matrix>::Ptr &leftVector){
      // By default, the parent has no custom post-step-dependencies, only the subcomponents' dependencies are added
  };
};
} // namespace CPS