VCO.cpp

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
 
#include <dpsim-models/Signal/VCO.h>
 
using namespace CPS;
using namespace CPS::Signal;
 
VCO::VCO(String name, Logger::Level logLevel)
    : SimSignalComp(name, name, logLevel),
      mInputRef(mAttributes->createDynamic<Real>("input_ref")),
      mInputPrev(mAttributes->create<Real>("input_prev", 0)),
      mStatePrev(mAttributes->create<Real>("state_prev", 0)),
      mOutputPrev(mAttributes->create<Real>("output_prev", 0)),
      mInputCurr(mAttributes->create<Real>("input_curr", 0)),
      mStateCurr(mAttributes->create<Real>("state_curr", 0)),
      mOutputCurr(mAttributes->create<Real>("output_curr", 0)) {}
 
void VCO::setParameters(Real omegaNom) {
  // Input is OmegaNom
  // Output is Theta
  mOmegaNom = omegaNom;
  SPDLOG_LOGGER_INFO(mSLog, "OmegaNom = {}", mOmegaNom);
 
  **mInputCurr = mOmegaNom;
  **mInputRef = mOmegaNom;
}
 
void VCO::setSimulationParameters(Real timestep) {
  mTimeStep = timestep;
  SPDLOG_LOGGER_INFO(mSLog, "Integration step = {}", mTimeStep);
}
 
void VCO::setInitialValues(Real input_init, Real state_init, Real output_init) {
  **mInputCurr = input_init;
  **mStateCurr = state_init;
  **mOutputCurr = output_init;
 
  SPDLOG_LOGGER_INFO(mSLog, "Initial values:");
  SPDLOG_LOGGER_INFO(
      mSLog,
      "inputCurrInit = ({}), stateCurrInit = ({}), outputCurrInit = ({})",
      **mInputCurr, **mStateCurr, **mOutputCurr);
}
 
void VCO::signalAddPreStepDependencies(
    AttributeBase::List &prevStepDependencies,
    AttributeBase::List &attributeDependencies,
    AttributeBase::List &modifiedAttributes) {
  prevStepDependencies.push_back(mInputCurr);
  prevStepDependencies.push_back(mOutputCurr);
  modifiedAttributes.push_back(mInputPrev);
  modifiedAttributes.push_back(mOutputPrev);
};
 
void VCO::signalPreStep(Real time, Int timeStepCount) {
  **mInputPrev = **mInputCurr;
  **mStatePrev = **mStateCurr;
  **mOutputPrev = **mOutputCurr;
}
 
void VCO::signalAddStepDependencies(AttributeBase::List &prevStepDependencies,
                                    AttributeBase::List &attributeDependencies,
                                    AttributeBase::List &modifiedAttributes) {
  attributeDependencies.push_back(mInputRef);
  modifiedAttributes.push_back(mInputCurr);
  modifiedAttributes.push_back(mOutputCurr);
};
 
void VCO::signalStep(Real time, Int timeStepCount) {
  **mInputCurr = **mInputRef;
 
  SPDLOG_LOGGER_DEBUG(
      mSLog,
      "Time {}\n: inputCurr = \n{}\n , inputPrev = \n{}\n , statePrev = \n{}",
      time, **mInputCurr, **mInputPrev, **mStatePrev);
 
  // calculate new states
  **mStateCurr = (**mStatePrev + mTimeStep * **mInputCurr);
  SPDLOG_LOGGER_DEBUG(mSLog, "stateCurr = \n {}", **mStateCurr);
 
  // calculate new outputs
  **mOutputCurr = **mStateCurr;
  SPDLOG_LOGGER_DEBUG(mSLog, "Output values: outputCurr = \n{}", **mOutputCurr);
}
 
Task::List VCO::getTasks() {
  return Task::List(
      {std::make_shared<PreStep>(*this), std::make_shared<Step>(*this)});
}