DAESolver.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 <iostream>
#include <list>
#include <vector>
 
#include <dpsim/Solver.h>
 
#include <dpsim-models/Logger.h>
#include <dpsim-models/Solver/DAEInterface.h>
#include <dpsim-models/SystemTopology.h>
 
#include <ida/ida.h>
#include <ida/ida_direct.h>
#include <nvector/nvector_serial.h>
#include <sundials/sundials_types.h>
#include <sunlinsol/sunlinsol_dense.h>
 
namespace DPsim {

class DAESolver : public Solver {
protected:
  // General simulation parameters
  CPS::SystemTopology mSystem;
  std::vector<Int> mOffsets;
  Real mTimestep;
  Int mNEQ;
  CPS::IdentifiedObject::List mComponents;
  CPS::SimNode<Complex>::List mNodes;
 
  // Initial time t0
  Real mT0;
 
  // IDA simulation variables
  void *mem = NULL;
  N_Vector state = NULL;
  N_Vector dstate_dt = NULL;
  realtype tret;
  realtype abstol;
  realtype rtol;
  SUNMatrix A = NULL;
  SUNLinearSolver LS = NULL;
  long int interalSteps = 0;
  long int resEval = 0;
  std::vector<CPS::DAEInterface::ResFn> mResidualFunctions;

  static int residualFunctionWrapper(realtype ttime, N_Vector state,
                                     N_Vector dstate_dt, N_Vector resid,
                                     void *user_data);
  int residualFunction(realtype ttime, N_Vector state, N_Vector dstate_dt,
                       N_Vector resid);
 
public:
  DAESolver(String name, const CPS::SystemTopology &system, Real dt, Real mT0);
  ~DAESolver();
  void initialize() final;

  Real step(Real time);
 
  CPS::Task::List getTasks() override;
};
} // namespace DPsim