Integrator.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 <vector>
 
#include <dpsim-models/SimPowerComp.h>
#include <dpsim-models/SimSignalComp.h>
#include <dpsim-models/Task.h>
 
namespace CPS {
namespace Signal {
class Integrator : public SimSignalComp, public SharedFactory<Integrator> {
 
protected:
  Real mTimeStep;
 
public:
  const Attribute<Real>::Ptr mInputRef;
 
  const Attribute<Real>::Ptr mInputPrev;
  const Attribute<Real>::Ptr mInputCurr;
  const Attribute<Real>::Ptr mStatePrev;
  const Attribute<Real>::Ptr mStateCurr;
  const Attribute<Real>::Ptr mOutputPrev;
  const Attribute<Real>::Ptr mOutputCurr;
 
  Integrator(String name, Logger::Level logLevel = Logger::Level::off);
  void setParameters(Real timestep);
  void setInitialValues(Real input_init, Real state_init, Real output_init);
  void signalPreStep(Real time, Int timeStepCount);
  void signalStep(Real time, Int timeStepCount);
  void signalAddPreStepDependencies(AttributeBase::List &prevStepDependencies,
                                    AttributeBase::List &attributeDependencies,
                                    AttributeBase::List &modifiedAttributes);
  void signalAddStepDependencies(AttributeBase::List &prevStepDependencies,
                                 AttributeBase::List &attributeDependencies,
                                 AttributeBase::List &modifiedAttributes);
 
  Task::List getTasks();
 
  class PreStep : public Task {
  public:
    PreStep(Integrator &integrator)
        : Task(**integrator.mName + ".PreStep"), mIntegrator(integrator) {
      mIntegrator.signalAddPreStepDependencies(
          mPrevStepDependencies, mAttributeDependencies, mModifiedAttributes);
    }
    void execute(Real time, Int timeStepCount) {
      mIntegrator.signalPreStep(time, timeStepCount);
    };
 
  private:
    Integrator &mIntegrator;
  };
 
  class Step : public Task {
  public:
    Step(Integrator &integrator)
        : Task(**integrator.mName + ".Step"), mIntegrator(integrator) {
      mIntegrator.signalAddStepDependencies(
          mPrevStepDependencies, mAttributeDependencies, mModifiedAttributes);
    }
    void execute(Real time, Int timeStepCount) {
      mIntegrator.signalStep(time, timeStepCount);
    };
 
  private:
    Integrator &mIntegrator;
  };
};
} // namespace Signal
} // namespace CPS