ct_wrappers.hpp

Go to the documentation of this file.

/**********************************************************************           
    * ct_wrappers.hpp -- Co-simulation wrappers for the CT MOC        *
    *                                                                 *
    * Author:  Hosein Attarzadeh (shan2@kth.se)                       *
    *          FMI code adopted from QTronic GmbH's FMI 2.0 SDK       *
    *                                                                 *
    * Purpose: Providing co-simulation wrappers for integration of    *
    *          foreign models into ForSyDe                            *
    *                                                                 *
    * Usage:   This file is included automatically                    *
    *                                                                 *
    * License: BSD3                                                   *
    *******************************************************************/

#ifndef CT_WRAPPERS_HPP
#define CT_WRAPPERS_HPP

#include "fmi2/fmi2.h"
#include "fmi2/sim_support.h"

#include "sub_signal.hpp"
#include "ct_process.hpp"

namespace ForSyDe
{

namespace CT
{

using namespace sc_core;


class fmi2cswrap : public ct_process
{
public:
    CT_in  iport1;       
    CT_out oport1;       


    fmi2cswrap(sc_module_name _name,    
         const std::string& fmu_file,   
         const unsigned int& input_index,
         const unsigned int& output_index,
         const sc_time& sample_period   
         ) : ct_process(_name), iport1("iport1"), oport1("oport1"),
             fmuFileName(fmu_file), input_index(input_index),
             output_index(output_index), h(sample_period)
    {
#ifdef FORSYDE_INTROSPECTION
        arg_vec.push_back(std::make_tuple("fmuFileName",fmuFileName));
        std::stringstream ss;
        ss << input_index;
        arg_vec.push_back(std::make_tuple("input_index", ss.str()));
        ss.str("");
        ss << output_index;
        arg_vec.push_back(std::make_tuple("output_index", ss.str()));
        ss.str("");
        ss << sample_period;
        arg_vec.push_back(std::make_tuple("sample_period", ss.str()));
#endif
    }
    
    std::string forsyde_kind() const {return "CT::fmi2cswrap";}

private:
    // Inputs and output variables
    sub_signal oval;
    sub_signal ival1;
    
    std::string fmuFileName;
    unsigned int input_index, output_index;
    sc_time h;
    
    sc_time time;
    FMU fmu;                        // the fmu to simulate
    const char *guid;               // global unique id of the fmu
    const char *instanceName;       // instance name
    fmi2Component c;                // instance of the fmu
    fmi2Status fmi2Flag;            // return code of the fmu functions
    char *fmuResourceLocation;      // path to the fmu resources as URL
    fmi2Boolean visible;            // no simulator user interface
    fmi2CallbackFunctions callbacks = {fmuLogger, calloc, free, NULL, &fmu};// called by the model during simulation
    ModelDescription* md;           // handle to the parsed XML file
    fmi2Boolean toleranceDefined;   // true if model description define tolerance
    fmi2Real tolerance;             // used in setting up the experiment
    ValueStatus vs;
    Element *defaultExp;
    
    //Implementing the abstract semantics
    void init()
    {
        time = SC_ZERO_TIME;
        fmuResourceLocation = getTempResourcesLocation();
        visible = fmi2False;
        //~ callbacks = {fmuLogger, calloc, free, NULL, fmu};
        toleranceDefined = fmi2False;
        tolerance = 0;
        //~ vs = 0;
        
        // load the FMU
        loadFMU(fmuFileName.c_str(), &fmu);
        
        // run the simulation
        // instantiate the fmu   
        md = fmu.modelDescription;
        guid = getAttributeValue((Element *)md, att_guid);
        instanceName = getAttributeValue((Element *)getCoSimulation(md),
            att_modelIdentifier);
        c = fmu.instantiate(instanceName, fmi2CoSimulation, guid,
            fmuResourceLocation, &callbacks, visible, fmi2False/*logging off*/);
        free(fmuResourceLocation);
        if (!c) return SC_REPORT_ERROR(name(),"could not instantiate model");
        
        defaultExp = getDefaultExperiment(md);
        if (defaultExp) tolerance = getAttributeDouble(defaultExp, att_tolerance, &vs);
        if (vs == valueDefined) {
            toleranceDefined = fmi2True;
        }
        
        fmi2Flag = fmu.setupExperiment(c, toleranceDefined, tolerance, 0, fmi2True, 1000/* FIXME */);
        if (fmi2Flag > fmi2Warning) {
            return SC_REPORT_ERROR(name(),"could not initialize model; failed FMI setup experiment");
        }
        
        fmi2Flag = fmu.enterInitializationMode(c);
        if (fmi2Flag > fmi2Warning) {
            return SC_REPORT_ERROR(name(),"could not initialize model; failed FMI enter initialization mode");
        }
        
        fmi2Flag = fmu.exitInitializationMode(c);
        if (fmi2Flag > fmi2Warning) {
            return SC_REPORT_ERROR(name(),"could not initialize model; failed FMI exit initialization mode");
        }
        
        // output solution for time t0
        // FIXME: outputRow(fmu, c, tStart, file, separator, fmi2False); // output values
        //~ auto res = getRealOutput(fmu, c, 0);
        //~ oval = sub_signal(time, time+h,
                    //~ [this,res](const sc_time& t)
                    //~ {
                        //~ return res;
                    //~ }
               //~ );
        //~ WRITE_MULTIPORT(oport1, oval)
        //~ time += h;
        //~ wait(time - sc_time_stamp());
        ival1 = iport1.read();
    }
    
    void prep()
    {
        while (time >= get_end_time(ival1)) ival1 = iport1.read();
        setRealInput(&fmu, c, input_index, ival1(time));
    }
    
    void exec()
    {
        fmi2Flag = fmu.doStep(c, time.to_seconds(), h.to_seconds(), fmi2True);
        if (fmi2Flag == fmi2Discard) {
            fmi2Boolean b;
            // check if model requests to end simulation
            if (fmi2OK != fmu.getBooleanStatus(c, fmi2Terminated, &b)) {
                return SC_REPORT_ERROR(name(),"could not complete simulation of the model. getBooleanStatus return other than fmi2OK");
            }
            if (b == fmi2True) {
                return SC_REPORT_ERROR(name(),"the model requested to end the simulation");
            }
            return SC_REPORT_ERROR(name(),"could not complete simulation of the model");
        }
        if (fmi2Flag != fmi2OK)
            return SC_REPORT_ERROR(name(),"could not complete simulation of the model");
        
        // FIXME: res = outputRow(fmu, c, time, file, separator, fmi2False); // output values for this step
        auto res = getRealOutput(&fmu, c, output_index);
        oval = sub_signal(time, time+h,
                    [this,res](const sc_time& t)
                    {
                        return res;
                    }
               );
    }
    
    void prod()
    {
        WRITE_MULTIPORT(oport1, oval)
        time += h;
        wait(time - sc_time_stamp());
    }
    
    void clean()
    {
        // end simulation
        fmu.terminate(c);
        fmu.freeInstance(c);
    
        #ifdef _MSC_VER
            FreeLibrary(fmu.dllHandle);
        #else
            dlclose(fmu.dllHandle);
        #endif
        freeModelDescription(fmu.modelDescription);
        deleteUnzippedFiles();
    }
    
#ifdef FORSYDE_INTROSPECTION
    void bindInfo()
    {
        boundInChans.resize(1);     // only one input port
        boundInChans[0].port = &iport1;
        boundOutChans.resize(1);    // only one output port
        boundOutChans[0].port = &oport1;
    }
#endif
};


template <class OIf, class I1If>
inline fmi2cswrap* make_fmi2cswrap(const std::string& pName,
    const std::string& fmu_file,
    const unsigned& input_index,
    const unsigned& output_index,
    const sc_time& sample_period,
    OIf& outS,
    I1If& inp1S
    )
{
    auto p = new fmi2cswrap(pName.c_str(), fmu_file, input_index, output_index, sample_period);
    
    (*p).iport1(inp1S);
    (*p).oport1(outS);
    
    return p;
}

}
}

#endif