From 0827cf8f94f4cbe94e47465b4a2243ecc13a6fbd Mon Sep 17 00:00:00 2001 From: Martin Alonso Moraga <martin.moraga@rwth-aachen.de> Date: Mon, 4 Jun 2018 22:39:16 +0200 Subject: [PATCH] Update README.md --- Py4Mod/py4mod/README.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/Py4Mod/py4mod/README.md b/Py4Mod/py4mod/README.md index b7f4ecb..b064b66 100644 --- a/Py4Mod/py4mod/README.md +++ b/Py4Mod/py4mod/README.md @@ -1,5 +1,8 @@ # Funktionennamen +The following table gives a comparison between the names of the functions of the interfaces and a small description of their function. It is important to keep in mind that some functions receive different arguments depending on the chosen interface. + + | DymolaInterface | OpenModelica Interface | ModelicaModel | | | ------------------------ | ------------------------ | ------------- | ------------------------------------------------------------------------------------------------------ | | __init__ | __init__ | createInterface | In OM creates an OMCSessionZMQ object, in DymInterface starts Dymola | @@ -15,12 +18,15 @@ | dymApplyModifiers | setValue | --- | In Dymola applies modifiers in modifierList. In OM chage the starts values in the XML init file | | buildModel | buildModel | buildModel | Builds a modelica model by generating c code and build it | | --- | simulate | --- | Simulate or re-simulate model by calling the .exe file (generated with buildModel()) | -| simulateModel | simulateModel || Simulates a modelica model by generating c code, build it and run the simulation executable | +| simulateModel | simulateModel | --- | In OM simulates a modelica model by generating c code, build it and run the simulation executable. In Dymola simulates the model and compiles it if it has not been compiled before | | getResultVarNames | getResultVarNames | getResultVarNames | Returns the variablen names from the simulation result | | getResultsFast | getResultsFast | getResults | Returns the trajectories for the variables in outputVarList by using ModelicaRes | | getResults | getResults | --- | To extract simulation results by using OMPython/DymolaInterface | -| close | exit | --- | To close dymola | +| close | close | close | To close dymola or OM | <br /> ** This function is not necesary in Dymola <br /> ---- This function is not implemented in the Interface \ No newline at end of file +--- This function is not implemented in the Interface + +<br /> +The functions that have not been implemented in ModelicaModel but in any of the interfaces can be easily called with the class variable self.interface. -- GitLab