blueprint.md

OpenModelica functions

pseudocode for the om-functions
self wont be described in parametersections

global reminder:

• check for None as result for functions that call OpenModelicas internal API

omOpen(self)

• @params: none
• set up a OM server
  • [ ] OMCSession
  • ModelicaSystem
    • has its own OMCSession
• set options like dymOpen() does ?

omTranslate(self)

• @params: none
• should compile the model (to FMU?)
  • ModelicaSystem.convertMo2Fmu()
• compile the model to c code?
  • Already done in ModelicaSystem's constructor?
    • precisely in with the call to its internal API
• check the result and catch exception

omApplyModifier(self, modifiersList)

• @params:
  • modifiersList:
    • format: [['submodule1','param1','value1'],['submodule2','param2','value2'],...]
• change the given parameters with the coresponding value
  • ModelicaSystem.setParameters(param1=val1,...) ?

omSimulate(self, simOptions = "", resultName = "simResults")

• @params:
  • simOptions:
    • simply add as parameter to ModelicaSystem.setSimulationOptions(_simOptions_)?
    • are these options like eg. startTime?
  • resultName:
    • not needed as OpenModelica automatically writes the results to a file called "modelName_res.mat"
  • TODO check how to aply these options (does such an option exist?)
  • set options
  • call ModelicaSystem's simulate() function

omSimulateMultiResults(self, resultName = "simResult", simOptions = "", initialNames="", initialValues="", resultNames="")

• @params:
  • resultName:
    • string with name of the file, the result should be written to
  • simOptions:
    • ?
  • initialNames:
    • ?
  • initialValues:
    • ?
  • resultNames:
    • not needed as OpenModelica automatically writes the results to a file called "modelName_res.mat"
• TODO check which options are available
• see omSimulate for further informations

omGetResultsFast(self, resultName = "simResult", outputVarList = [])

• @params:
  • resultName:
    • not needed as OpenModelica automatically writes the results to a file called "modelName_res.mat"
  • outputVarList:
    • array with the wanted variables
• return an numpy.array containing the trajectories for the variables in outputVarList using ModelicaRes's SimRes() function

omGetResults(self, resultName = "simResult", outputVarList = [])

• @params:
  • resultName:
    • not needed as OpenModelica automatically writes the results to a file called "modelName_res.mat"
  • outputVarList:
    • array with the wanted variables
• values are read from the file with the name resultName
• return numpy.array with the results for the given variables
• OpenModelica's function getSolutions()
  • check if the variablesNames are in it
  • get value with getSolutions(variableName1, variableName2,...), where variableName is a string containing the wanted variables's name

omGetResultVarNames(self, resultName = "simResult")

• @params:
  • resultName:
    • not needed as OpenModelica automatically writes the results to a file called "modelName_res.mat"
• return the variable names from the simulation result
• OpenModelica's function getSolutions()

omClose(self)

• @params: none
• close the OpenModelica session with ModelicaSystem.getconn.sendExpression(close()) like here
• set the ModelicaSystem-Object self.__omObj to None
  • ModelicaSystem handles shutdown of OMCSession etc. in its Destructor