SystemSC.h

Go to the documentation of this file.

/*
 * This file is part of OpenModelica.
 *
 * Copyright (c) 1998-2026, Open Source Modelica Consortium (OSMC),
 * c/o Linköpings universitet, Department of Computer and Information Science,
 * SE-58183 Linköping, Sweden.
 *
 * All rights reserved.
 *
 * THIS PROGRAM IS PROVIDED UNDER THE TERMS OF AGPL VERSION 3 LICENSE OR
 * THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.8.
 * ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
 * RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GNU AGPL
 * VERSION 3, ACCORDING TO RECIPIENTS CHOICE.
 *
 * The OpenModelica software and the OSMC (Open Source Modelica Consortium)
 * Public License (OSMC-PL) are obtained from OSMC, either from the above
 * address, from the URLs:
 * http://www.openmodelica.org or
 * https://github.com/OpenModelica/ or
 * http://www.ida.liu.se/projects/OpenModelica,
 * and in the OpenModelica distribution.
 *
 * GNU AGPL version 3 is obtained from:
 * https://www.gnu.org/licenses/licenses.html#GPL
 *
 * This program is distributed WITHOUT ANY WARRANTY; without
 * even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
 * IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
 *
 * See the full OSMC Public License conditions for more details.
 *
 */
 
#ifndef _OMS_SYSTEM_SC_H_
#define _OMS_SYSTEM_SC_H_
 
#include "ComRef.h"
#include "System.h"
#include "OMSimulator/Types.h"
 
#include <memory>
 
#include <sundials/sundials_context.h>  /* SUNContext */
#include <sundials/sundials_logger.h>   /* SUNLogger */
#include <cvode/cvode.h>                /* prototypes for CVODE fcts., consts. */
#include <nvector/nvector_serial.h>     /* serial N_Vector types, fcts., macros */
#include <sunlinsol/sunlinsol_dense.h>  /* Default dense linear solver */
 
namespace oms
{
  class Model;
  class ComponentFMUME;
  class Component;
  int cvode_rhs(sunrealtype t, N_Vector y, N_Vector ydot, void* user_data);
  int cvode_rhs_algebraic(sunrealtype t, N_Vector y, N_Vector ydot, void* user_data);
  int cvode_roots(sunrealtype t, N_Vector y, sunrealtype *gout, void* user_data);
 
  class SystemSC : public System
  {
  public:
    ~SystemSC();
 
    static System* NewSystem(const oms::ComRef& cref, Model* parentModel, System* parentSystem);
    oms_status_enu_t exportToSSD_SimulationInformation(pugi::xml_node& node) const;
    oms_status_enu_t importFromSSD_SimulationInformation(const pugi::xml_node& node, const std::string& sspVersion);
 
    oms_status_enu_t instantiate();
    oms_status_enu_t initialize();
    oms_status_enu_t terminate();
    oms_status_enu_t reset();
    oms_status_enu_t doStep();
    oms_status_enu_t stepUntil(double stopTime);
 
    oms_status_enu_t updateInputs(DirectedGraph& graph);
 
    std::string getSolverName() const;
    oms_status_enu_t setSolverMethod(std::string);
 
    oms_status_enu_t setSolver(oms_solver_enu_t solver) {if (solver > oms_solver_sc_min && solver < oms_solver_sc_max) {solverMethod=solver; return oms_status_ok;} return oms_status_error;}
 
  private:
    oms_status_enu_t doStepEuler();
    oms_status_enu_t doStepCVODE();
 
  protected:
    SystemSC(const ComRef& cref, Model* parentModel, System* parentSystem);
 
    // stop the compiler generating methods copying the object
    SystemSC(SystemSC const& copy);            
    SystemSC& operator=(SystemSC const& copy); 
 
  private:
    std::vector<Component*> fmus; // use Component Base class to support FMI 2 ME and FMI 3 ME
 
    // One entry per FMU, allocated by initialize() once fmus is filled.
    std::unique_ptr<bool[]> callEventUpdate;     //initialized with false
    std::unique_ptr<bool[]> terminateSimulation; //initialized with false
 
    std::vector<size_t> nStates;
    std::vector<size_t> nEventIndicators;
 
    std::vector<double*> states;
    std::vector<double*> states_der;
    std::vector<double*> states_nominal;
    std::vector<double*> event_indicators;
    std::vector<double*> event_indicators_prev;
 
    bool algebraic = false;
 
    struct SolverDataEuler_t
    {
    };
 
    struct SolverDataCVODE_t
    {
      SUNContext sunctx;      /* SUNDIALS simulation context */
      void *mem;
      N_Vector y;
      SUNLinearSolver linSol; /* linear solver object */
      SUNMatrix J;            /* Matrix used by linear solver */
      N_Vector liny;          /* Vector used by linear solver */
      N_Vector abstol;
    };
 
    union SolverData_t
    {
      SolverDataEuler_t euler;
      SolverDataCVODE_t cvode;
    } solverData;
 
    friend int oms::cvode_rhs(sunrealtype t, N_Vector y, N_Vector ydot, void* user_data);
    friend int oms::cvode_rhs_algebraic(sunrealtype t, N_Vector y, N_Vector ydot, void* user_data);
    friend int oms::cvode_roots(sunrealtype t, N_Vector y, sunrealtype *gout, void* user_data);
  };
}
 
#endif