fmu1 Class Reference

#include <mbdynFMI.h>

Inheritance diagram for fmu1:

Collaboration diagram for fmu1:

Public Member Functions
void	parseXML (fmi_import_context_t *context, const char *dirPath)
void	setCallBackFunction ()
	fmu1 (fmi_import_context_t *text, int type)
void	ImportCreateDLL (void)
bool	CheckInput (const std::string)
int	GetNumOfContinousStates (void)
int	GetNumOfEventIndicators (void)
int	GetNumOfVar (void)
void	Initialize (double dTol, double time, double rTol)
void	EventIndicatorInit (void)
void	SetRelativeTol (double dTol)
void	SetTime (double time)
void	SetStates (double *states)
void	SetValuesByVariable (const std::string, double)
int	GetRefValueFromString (const char *s)
double	GetStateFromRefValue (unsigned int i)
void	GetStateDerivatives (double *)
void	GetStates (double *)
void	GetDirectionalDerivatives (FullMatrixHandler *, int *, int, double *)
bool	SupportsDirectionalDerivatives ()
bool	CheckInterrupts (double, double *)
void	InitializeAsSlave (const char *location, double tstart, double tend)
void	CSPropogate (double tcur, double dt)
virtual	~fmu1 (void)
Public Member Functions inherited from fmu
	fmu (fmi_import_context_t *text, int type)
virtual	~fmu (void)

Private Attributes
fmi1_callback_functions_t	callBackFunctions
fmi1_import_t *	fmu
fmi1_status_t	fmistatus
jm_status_enu_t	jmstatus
fmi1_real_t	currTime
fmi1_real_t	relativeTolerance
fmi1_event_info_t	eventInfo
size_t	nEventIndicators
fmi1_real_t *	eventIndicators
fmi1_real_t *	eventIndicatorsPrev
fmi1_import_variable_t *	v
int	numOfContStates
fmi1_real_t *	deriv
fmi1_value_reference_t *	vrs
fmi1_boolean_t	intermediateResults

Additional Inherited Members
Public Types inherited from fmu
enum	SimulationTypes { IMPORT, COSIM }
Public Attributes inherited from fmu
int	simType
fmi_import_context_t *	context

Detailed Description

Definition at line 115 of file mbdynFMI.h.

Constructor & Destructor Documentation

fmu1::fmu1 ( fmi_import_context_t *  text, int  type  )

inline

Definition at line 143 of file mbdynFMI.h.

References NO_OP.

                                                  :fmu::fmu(text, type){
                NO_OP;
        }

fmu1::~fmu1 ( void  )

virtual

Definition at line 472 of file mbdynFMI.cc.

References fmu::context, deriv, eventIndicators, eventIndicatorsPrev, fmistatus, fmu::IMPORT, fmu::simType, STATUSCHECK, and vrs.

               {
        fmi_xml_free_context(context);

        if(simType == IMPORT){

                fmi1_capi_free_dll(fmu->capi);

                delete[] eventIndicators;
                delete[] eventIndicatorsPrev;
                //      delete[] currStates;

                delete[] deriv;
                delete[] vrs;

                fmi1_import_free_model_instance(fmu);
                fmi1_import_destroy_dllfmu(fmu);
                fmi1_import_free(fmu);

        } else {

                fmistatus = fmi1_import_terminate_slave(fmu);
                STATUSCHECK(fmistatus);
                fmi1_import_free_slave_instance(fmu);

        }
}

Member Function Documentation

bool fmu1::CheckInput ( const std::string  s )

virtual

Implements fmu.

Definition at line 598 of file mbdynFMI.cc.

References v.

                                      {
        v = fmi1_import_get_variable_by_name(fmu, s.c_str());
        if(v==NULL){
                silent_cout(s.c_str()<<" is not defined in XML, hence ");
                return false;
        }

        return ((fmi1_import_get_causality(v))==0);
}

bool fmu1::CheckInterrupts ( double  currTime, double *  states  )

virtual

Implements fmu.

Definition at line 576 of file mbdynFMI.cc.

References eventIndicators, eventIndicatorsPrev, eventInfo, fmistatus, intermediateResults, nEventIndicators, numOfContStates, and STATUSCHECK.

                                                         {
        int zeroCrossningEvent = 0;

        fmistatus = fmi1_import_get_event_indicators(fmu, eventIndicators, nEventIndicators);
        STATUSCHECK(fmistatus);
        for (unsigned int k = 0; k < nEventIndicators; k++) {
              if (eventIndicators[k]*eventIndicatorsPrev[k] < 0) {
                      zeroCrossningEvent = 1;
                      break;
              }
        }

        if ( zeroCrossningEvent || (eventInfo.upcomingTimeEvent && currTime == eventInfo.nextEventTime)) {
                fmistatus = fmi1_import_eventUpdate(fmu, intermediateResults, &eventInfo);
                fmistatus = fmi1_import_get_continuous_states(fmu, states, numOfContStates);
                fmistatus = fmi1_import_get_event_indicators(fmu, eventIndicatorsPrev, nEventIndicators);
                return true;
        } else {
                return false;
        }       
}

void fmu1::CSPropogate ( double  tcur, double  dt  )

virtual

Implements fmu.

Definition at line 711 of file mbdynFMI.cc.

References fmistatus, and STATUSCHECK.

                                            {
        fmistatus = fmi1_import_do_step(fmu, tcur, dt, fmi1_true);
        STATUSCHECK(fmistatus);
}

void fmu1::EventIndicatorInit ( void  )

virtual

Implements fmu.

Definition at line 699 of file mbdynFMI.cc.

References eventIndicators, eventIndicatorsPrev, fmistatus, and nEventIndicators.

                                 {
        nEventIndicators = fmi1_import_get_number_of_event_indicators(fmu);

        eventIndicators = new fmi1_real_t [nEventIndicators];
        eventIndicatorsPrev = new fmi1_real_t [nEventIndicators];

        fmistatus = fmi1_import_get_event_indicators(fmu, eventIndicatorsPrev, nEventIndicators);       
        if(fmistatus){  
                silent_cout("This FMU does triggers events. Warning: Event triggers not supported by MBDyn\n");
        }
}

void fmu1::GetDirectionalDerivatives ( FullMatrixHandler *  jacobian, int *  vector, int  vectorLength, double *  seedVector  )

virtual

Implements fmu.

Definition at line 685 of file mbdynFMI.cc.

References NO_OP.

                                                                                                                  {
        NO_OP;
}

int fmu1::GetNumOfContinousStates ( void  )

virtual

Implements fmu.

Definition at line 524 of file mbdynFMI.cc.

References deriv, numOfContStates, and vrs.

                                     {
        numOfContStates = fmi1_import_get_number_of_continuous_states(fmu);
//      currStates      = new double [numOfContStates];
//      currStatesDer   = new double [numOfContStates]; 
        vrs             = new fmi1_value_reference_t [numOfContStates];
        deriv           = new fmi1_real_t [numOfContStates];
        return numOfContStates;
}

int fmu1::GetNumOfEventIndicators ( void  )

virtual

Implements fmu.

Definition at line 572 of file mbdynFMI.cc.

                                     {
        return fmi1_import_get_number_of_event_indicators(fmu);
}

int fmu1::GetNumOfVar ( void  )

virtual

Implements fmu.

Definition at line 689 of file mbdynFMI.cc.

                     {
        fmi1_import_variable_list_t* vl;
        vl = fmi1_import_get_variable_list(fmu);
        return fmi1_import_get_variable_list_size(vl);
}

int fmu1::GetRefValueFromString ( const char *  s )

virtual

Implements fmu.

Definition at line 646 of file mbdynFMI.cc.

References v.

                                            {
        v = fmi1_import_get_variable_by_name(fmu, s);
        return  static_cast<int>(fmi1_import_get_variable_vr(v));
}

void fmu1::GetStateDerivatives ( double *  derivatives )

virtual

Implements fmu.

Definition at line 651 of file mbdynFMI.cc.

References fmistatus, numOfContStates, and STATUSCHECK.

                                                 {

        fmistatus = fmi1_import_get_derivatives(fmu, derivatives, numOfContStates);
        STATUSCHECK(fmistatus);
}

double fmu1::GetStateFromRefValue ( unsigned int  i )

virtual

Implements fmu.

Definition at line 672 of file mbdynFMI.cc.

References fmistatus, and STATUSCHECK.

                                               {
        double realValue[1];
        fmi1_value_reference_t valueReference = {i};
        fmistatus = fmi1_import_get_real(fmu, &valueReference, 1, realValue);   
        STATUSCHECK(fmistatus);
        
        return realValue[0];
} 

void fmu1::GetStates ( double *  states )

virtual

Implements fmu.

Definition at line 717 of file mbdynFMI.cc.

References fmistatus, and numOfContStates.

                                  {

        fmistatus = fmi1_import_get_continuous_states(fmu, states, numOfContStates);
        if(!fmistatus){ 
                fmistatus = fmi1_import_get_nominal_continuous_states(fmu, states, numOfContStates);
        }
        if(!fmistatus){
                for(int i=0; i<numOfContStates; i++){
                        states[i] = 0;
                }
        }
        
//      STATUSCHECK(fmistatus);
        
}

void fmu1::ImportCreateDLL ( void  )

virtual

Implements fmu.

Definition at line 517 of file mbdynFMI.cc.

References callBackFunctions, jmstatus, and STATUSCHECK.

                              {
        jmstatus = fmi1_import_create_dllfmu(fmu, callBackFunctions, 1);
        STATUSCHECK(jmstatus);
        
        silent_cout("Successfully created the DLL loading mechanism.\n");
}

void fmu1::Initialize ( double  dTol, double  time, double  rTol  )

virtual

Implements fmu.

Definition at line 533 of file mbdynFMI.cc.

References currTime, eventInfo, fmistatus, intermediateResults, jmstatus, and STATUSCHECK.

                                                          {

        fmi1_boolean_t tolControlled = fmi1_true;

        if (dTol ==0 ){
                dTol = fmi1_import_get_default_experiment_tolerance(fmu);
                tolControlled = fmi1_false;
        }
        currTime  = time;

        STATUSCHECK(fmi1_status_ok);

        jmstatus  = fmi1_import_instantiate_model(fmu, "Test ME model instance");
        STATUSCHECK(jmstatus);

        fmistatus = fmi1_import_initialize(fmu, tolControlled, dTol, &eventInfo);
        STATUSCHECK(fmistatus);

        fmistatus = fmi1_import_set_time(fmu, currTime);
        STATUSCHECK(fmistatus);

// Necessary to initialize model as capi
        fmi1_capi_load_dll(fmu->capi);

        jmstatus = fmi1_capi_load_fcn(fmu->capi);       
        STATUSCHECK(jmstatus);

#ifdef DEBUG
        fmi1_boolean_t loggingOn = fmi1_true;
#else
        fmi1_boolean_t loggingOn = fmi1_false;
#endif

        fmi1_capi_instantiate_model(fmu->capi, "noName", fmi1_import_get_GUID(fmu), loggingOn); 

        intermediateResults = fmi1_false;
        silent_cout("FMU Initialized\n");
}

void fmu1::InitializeAsSlave ( const char *  location, double  tstart, double  tend  )

virtual

Implements fmu.

Definition at line 733 of file mbdynFMI.cc.

References fmistatus, jmstatus, and STATUSCHECK.

                                                                            {
        std::stringstream resourceLocation;
        std::string strLocation = location;

        resourceLocation << "file://" << strLocation;
        jmstatus = fmi1_import_instantiate_slave(fmu, "Test CS model instance", resourceLocation.str().c_str(), "", 0.0, fmi1_false, fmi1_false);
        STATUSCHECK(jmstatus);
// INITIALIZE PRINTS SOME WARNINGS.
        fmistatus = fmi1_import_initialize_slave(fmu, 1.0, fmi1_false, 10.0);
        STATUSCHECK(fmistatus);

}

void fmu1::parseXML ( fmi_import_context_t *  context, const char *  dirPath  )

virtual

Implements fmu.

Definition at line 500 of file mbdynFMI.cc.

References MBDYN_EXCEPT_ARGS.

                                                                     {
        fmu = fmi1_import_parse_xml(context, dirPath);
        if (!fmu){
                silent_cout("Error parsing XML\n");
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        } else {
                silent_cout("XML Parsed successfully\n");
        }
}

void fmu1::setCallBackFunction ( )

virtual

Implements fmu.

Definition at line 510 of file mbdynFMI.cc.

References callBackFunctions.

                              {
        callBackFunctions.logger = fmi1_log_forwarding;
        callBackFunctions.allocateMemory = calloc;
        callBackFunctions.freeMemory = free;
        silent_cout("Callback Functions Set.\n");
}

void fmu1::SetRelativeTol ( double  dTol )

virtual

Implements fmu.

Definition at line 695 of file mbdynFMI.cc.

References relativeTolerance.

                                    {
        relativeTolerance = (fmi1_real_t)dTol;
}

void fmu1::SetStates ( double *  states )

virtual

Implements fmu.

Definition at line 663 of file mbdynFMI.cc.

References fmistatus, numOfContStates, STATUSCHECK, and vrs.

                                  {

        fmistatus = fmi1_capi_get_state_value_references(fmu->capi, vrs, numOfContStates);
        STATUSCHECK(fmistatus);
        fmistatus = fmi1_import_set_real(fmu, vrs, numOfContStates, states);
        STATUSCHECK(fmistatus);

}

void fmu1::SetTime ( double  time )

virtual

Implements fmu.

Definition at line 657 of file mbdynFMI.cc.

References currTime, fmistatus, and STATUSCHECK.

                             {
        currTime = time;
        fmistatus = fmi1_import_set_time(fmu, currTime);
        STATUSCHECK(fmistatus);
}

void fmu1::SetValuesByVariable ( const std::string  s, double  value  )

virtual

Implements fmu.

Definition at line 610 of file mbdynFMI.cc.

References fmistatus, MBDYN_EXCEPT_ARGS, STATUSCHECK, and v.

                                                             {
        fmi1_value_reference_t ref;
        fmi1_variable_alias_kind_enu_t aliasKind;
        fmi1_base_type_enu_t baseType;

        fmi1_import_variable_t* v = fmi1_import_get_variable_by_name(fmu, s.c_str());

        ref = fmi1_import_get_variable_vr(v);
        aliasKind = fmi1_import_get_variable_alias_kind(v);
        baseType = fmi1_import_get_variable_base_type(v);

        if (aliasKind == fmi1_variable_is_negated_alias){
                if(baseType != fmi1_base_type_bool){
                        value = -value;
                }
                else {
                        value = (bool)!value; 
                }
        }

        if (baseType == fmi1_base_type_real){
                fmistatus = fmi1_import_set_real(fmu, &ref, 1, &value);
        }
        else if (baseType == fmi1_base_type_int){
                fmistatus = fmi1_import_set_integer(fmu, &ref, 1, (const int*)&value);
        }
        else if (baseType == fmi1_base_type_bool){
                fmistatus = fmi1_import_set_boolean(fmu, &ref, 1, (const fmi1_boolean_t*)&value);
        }
        else{
                silent_cerr("Input type not Supported");
                throw ErrGeneric(MBDYN_EXCEPT_ARGS);
        }
        STATUSCHECK(fmistatus);
}

bool fmu1::SupportsDirectionalDerivatives ( )

virtual

Implements fmu.

Definition at line 681 of file mbdynFMI.cc.

                                         {
        return false;
}

Member Data Documentation

fmi1_callback_functions_t fmu1::callBackFunctions

private

Definition at line 117 of file mbdynFMI.h.

Referenced by ImportCreateDLL(), and setCallBackFunction().

fmi1_real_t fmu1::currTime

private

Definition at line 123 of file mbdynFMI.h.

Referenced by Initialize(), and SetTime().

fmi1_real_t* fmu1::deriv

private

Definition at line 133 of file mbdynFMI.h.

Referenced by GetNumOfContinousStates(), and ~fmu1().

fmi1_real_t* fmu1::eventIndicators

private

Definition at line 128 of file mbdynFMI.h.

Referenced by CheckInterrupts(), EventIndicatorInit(), and ~fmu1().

fmi1_real_t* fmu1::eventIndicatorsPrev

private

Definition at line 129 of file mbdynFMI.h.

Referenced by CheckInterrupts(), EventIndicatorInit(), and ~fmu1().

fmi1_event_info_t fmu1::eventInfo

private

Definition at line 125 of file mbdynFMI.h.

Referenced by CheckInterrupts(), and Initialize().

fmi1_status_t fmu1::fmistatus

private

Definition at line 120 of file mbdynFMI.h.

Referenced by CheckInterrupts(), CSPropogate(), EventIndicatorInit(), GetStateDerivatives(), GetStateFromRefValue(), GetStates(), Initialize(), InitializeAsSlave(), SetStates(), SetTime(), SetValuesByVariable(), and ~fmu1().

fmi1_import_t* fmu1::fmu

private

Definition at line 118 of file mbdynFMI.h.

fmi1_boolean_t fmu1::intermediateResults

private

Definition at line 136 of file mbdynFMI.h.

Referenced by CheckInterrupts(), and Initialize().

jm_status_enu_t fmu1::jmstatus

private

Definition at line 121 of file mbdynFMI.h.

Referenced by ImportCreateDLL(), Initialize(), and InitializeAsSlave().

size_t fmu1::nEventIndicators

private

Definition at line 127 of file mbdynFMI.h.

Referenced by CheckInterrupts(), and EventIndicatorInit().

int fmu1::numOfContStates

private

Definition at line 132 of file mbdynFMI.h.

Referenced by CheckInterrupts(), GetNumOfContinousStates(), GetStateDerivatives(), GetStates(), and SetStates().

fmi1_real_t fmu1::relativeTolerance

private

Definition at line 124 of file mbdynFMI.h.

Referenced by SetRelativeTol().

fmi1_import_variable_t* fmu1::v

private

Definition at line 130 of file mbdynFMI.h.

Referenced by CheckInput(), GetRefValueFromString(), and SetValuesByVariable().

fmi1_value_reference_t* fmu1::vrs

private

Definition at line 134 of file mbdynFMI.h.

Referenced by GetNumOfContinousStates(), SetStates(), and ~fmu1().

---

The documentation for this class was generated from the following files:

• mbdynFMI.h
• mbdynFMI.cc