Changeset 96898a5d in OpenModelica

Timestamp:

2016-04-06T18:08:24+02:00 (8 years ago)

Author:

hudson <openmodelica@…>

Branches:

Added-citation-metadata, maintenance/v1.14, maintenance/v1.15, maintenance/v1.16, maintenance/v1.17, maintenance/v1.18, maintenance/v1.19, maintenance/v1.20, maintenance/v1.21, maintenance/v1.22, maintenance/v1.23, master, omlib-staging

Children:

2894deef

Parents:

e44d63b8

git-author:

Willi Braun <wbraun@…> (04/06/16 18:08:24)

git-committer:

hudson <openmodelica@…> (04/06/16 18:08:24)

Message:

generalize and move dasslJacobian flag

Location:

SimulationRuntime/c

Files:

• simulation/solver/dassl.c (modified) (5 diffs)
• simulation/solver/dassl.h (modified) (1 diff)
• util/simulation_options.c (modified) (9 diffs)
• util/simulation_options.h (modified) (3 diffs)

SimulationRuntime/c/simulation/solver/dassl.c

@@ -54 +54 @@
 #endif
 
-static const char *dasslJacobianMethodStr[DASSL_JAC_MAX] = {"unknown",
-                                                "coloredNumerical",
-                                                "coloredSymbolical",
-                                                "internalNumerical",
-                                                "numerical",
-                                                "symbolical"
-                                                };
-
-static const char *dasslJacobianMethodDescStr[DASSL_JAC_MAX] = {"unknown",
-                                                       "colored numerical jacobian - default.",
-                                                       "colored symbolic jacobian - needs omc compiler flags +generateSymbolicJacobian or +generateSymbolicLinearization.",
-                                                       "internal numerical jacobian.",
-                                                       "numerical jacobian.",
-                                                       "symbolic jacobian - needs omc compiler flags +generateSymbolicJacobian or +generateSymbolicLinearization."
-                                                      };
-
 /* experimental flag for SKF TLM Master Solver Interface
  *  - it's used with -noEquidistantTimeGrid flag.
@@ -277 +261 @@
   }
 
-  /* if FLAG_DASSL_JACOBIAN is set, choose dassl jacobian calculation method */
-  if (omc_flag[FLAG_DASSL_JACOBIAN])
-  {
-    for(i=1; i< DASSL_JAC_MAX;i++)
-    {
-      if(!strcmp((const char*)omc_flagValue[FLAG_DASSL_JACOBIAN], dasslJacobianMethodStr[i])){
+  /* if FLAG_JACOBIAN is set, choose dassl jacobian calculation method */
+  if (omc_flag[FLAG_JACOBIAN])
+  {
+    for(i=1; i< JAC_MAX;i++)
+    {
+      if(!strcmp((const char*)omc_flagValue[FLAG_JACOBIAN], JACOBIAN_METHOD[i])){
         dasslData->dasslJacobian = (int)i;
         break;
       }
     }
-    if(dasslData->dasslJacobian == DASSL_JAC_UNKNOWN)
+    if(dasslData->dasslJacobian == JAC_UNKNOWN)
     {
       if (ACTIVE_WARNING_STREAM(LOG_SOLVER))
       {
-        warningStreamPrint(LOG_SOLVER, 1, "unrecognized jacobian calculation method %s, current options are:", (const char*)omc_flagValue[FLAG_DASSL_JACOBIAN]);
-        for(i=1; i < DASSL_JAC_MAX; ++i)
+        warningStreamPrint(LOG_SOLVER, 1, "unrecognized jacobian calculation method %s, current options are:", (const char*)omc_flagValue[FLAG_JACOBIAN]);
+        for(i=1; i < JAC_MAX; ++i)
         {
-          warningStreamPrint(LOG_SOLVER, 0, "%-15s [%s]", dasslJacobianMethodStr[i], dasslJacobianMethodDescStr[i]);
+          warningStreamPrint(LOG_SOLVER, 0, "%-15s [%s]", JACOBIAN_METHOD[i], JACOBIAN_METHOD_DESC[i]);
         }
         messageClose(LOG_SOLVER);
       }
-      throwStreamPrint(threadData,"unrecognized jacobian calculation method %s", (const char*)omc_flagValue[FLAG_DASSL_JACOBIAN]);
+      throwStreamPrint(threadData,"unrecognized jacobian calculation method %s", (const char*)omc_flagValue[FLAG_JACOBIAN]);
     }
   /* default case colored numerical jacobian */
@@ -304 +288 @@
   else
   {
-    dasslData->dasslJacobian = DASSL_COLOREDNUMJAC;
+    dasslData->dasslJacobian = COLOREDNUMJAC;
   }
 
 
   /* selects the calculation method of the jacobian */
-  if(dasslData->dasslJacobian == DASSL_COLOREDNUMJAC ||
-     dasslData->dasslJacobian == DASSL_COLOREDSYMJAC ||
-     dasslData->dasslJacobian == DASSL_SYMJAC)
+  if(dasslData->dasslJacobian == COLOREDNUMJAC ||
+     dasslData->dasslJacobian == COLOREDSYMJAC ||
+     dasslData->dasslJacobian == SYMJAC)
   {
     if (data->callback->initialAnalyticJacobianA(data, threadData))
     {
       infoStreamPrint(LOG_STDOUT, 0, "Jacobian or SparsePattern is not generated or failed to initialize! Switch back to normal.");
-      dasslData->dasslJacobian = DASSL_INTERNALNUMJAC;
+      dasslData->dasslJacobian = INTERNALNUMJAC;
     }
   }
@@ -324 +308 @@
   /* set up the appropriate function pointer */
   switch (dasslData->dasslJacobian){
-    case DASSL_COLOREDNUMJAC:
+    case COLOREDNUMJAC:
       data->simulationInfo->jacobianEvals = data->simulationInfo->analyticJacobians[data->callback->INDEX_JAC_A].sparsePattern.maxColors;
       dasslData->jacobianFunction =  JacobianOwnNumColored;
       break;
-    case DASSL_COLOREDSYMJAC:
+    case COLOREDSYMJAC:
       data->simulationInfo->jacobianEvals = data->simulationInfo->analyticJacobians[data->callback->INDEX_JAC_A].sparsePattern.maxColors;
       dasslData->jacobianFunction =  JacobianSymbolicColored;
       break;
-    case DASSL_SYMJAC:
+    case SYMJAC:
       dasslData->jacobianFunction =  JacobianSymbolic;
       break;
-    case DASSL_NUMJAC:
+    case NUMJAC:
       dasslData->jacobianFunction =  JacobianOwnNum;
       break;
-    case DASSL_INTERNALNUMJAC:
+    case INTERNALNUMJAC:
       dasslData->jacobianFunction =  dummy_Jacobian;
       /* no user sub-routine for JAC */
@@ -344 +328 @@
       break;
     default:
-      throwStreamPrint(threadData,"unrecognized jacobian calculation method %s", (const char*)omc_flagValue[FLAG_DASSL_JACOBIAN]);
+      throwStreamPrint(threadData,"unrecognized jacobian calculation method %s", (const char*)omc_flagValue[FLAG_JACOBIAN]);
       break;
   }
-  infoStreamPrint(LOG_SOLVER, 0, "jacobian is calculated by %s", dasslJacobianMethodDescStr[dasslData->dasslJacobian]);
-
+  infoStreamPrint(LOG_SOLVER, 0, "jacobian is calculated by %s", JACOBIAN_METHOD_DESC[dasslData->dasslJacobian]);
 
   /* if FLAG_DASSL_NO_ROOTFINDING is set, choose dassl with out internal root finding */

SimulationRuntime/c/simulation/solver/dassl.h

@@ -38 +38 @@
 static const unsigned int maxOrder = 5;
 static const unsigned int infoLength = 20;
-
-enum DASSL_JACOBIAN
-{
-  DASSL_JAC_UNKNOWN = 0,
-  DASSL_COLOREDNUMJAC,
-  DASSL_COLOREDSYMJAC,
-  DASSL_INTERNALNUMJAC,
-  DASSL_NUMJAC,
-  DASSL_SYMJAC,
-  DASSL_JAC_MAX
-};
 
 typedef struct DASSL_DATA{

SimulationRuntime/c/util/simulation_options.c

@@ -39 +39 @@
   /* FLAG_CPU */                   "cpu",
   /* FLAG_CSV_OSTEP */             "csvOstep",
-  /* FLAG_DASSL_JACOBIAN */        "dasslJacobian",
   /* FLAG_DASSL_NO_RESTART */      "dasslnoRestart",
   /* FLAG_DASSL_NO_ROOTFINDING */  "dasslnoRootFinding",
@@ -60 +59 @@
   /* FLAG_IPOPT_MAX_ITER */        "ipopt_max_iter",
   /* FLAG_IPOPT_WARM_START */      "ipopt_warm_start",
+  /* FLAG_JACOBIAN */              "jacobian",
   /* FLAG_L */                     "l",
   /* FLAG_L_DATA_RECOVERY */       "l_datarec",
@@ -105 +105 @@
   /* FLAG_CPU */                   "dumps the cpu-time into the results-file",
   /* FLAG_CSV_OSTEP */             "value specifies csv-files for debuge values for optimizer step",
-  /* FLAG_DASSL_JACOBIAN */        "selects the type of the jacobians that is used for the dassl solver.\n  dasslJacobian=[coloredNumerical (default) |numerical|internalNumerical|coloredSymbolical|symbolical].",
   /* FLAG_DASSL_NO_RESTART */      "flag deactivates the restart of dassl after an event is performed.",
   /* FLAG_DASSL_NO_ROOTFINDING */  "flag deactivates the internal root finding procedure of dassl.",
@@ -126 +125 @@
   /* FLAG_IPOPT_MAX_ITER */        "value specifies the max number of iteration for ipopt",
   /* FLAG_IPOPT_WARM_START */      "value specifies lvl for a warm start in ipopt: 1,2,3,...",
+  /* FLAG_JACOBIAN */              "selects the type of the jacobians that is used for the integrator.\n  jacobian=[coloredNumerical (default) |numerical|internalNumerical|coloredSymbolical|symbolical].",
   /* FLAG_L */                     "value specifies a time where the linearization of the model should be performed",
   /* FLAG_L_DATA_RECOVERY */       "emit data recovery matrices with model linearization",
@@ -178 +178 @@
   /* FLAG_CSV_OSTEP */
   "value specifies csv-files for debuge values for optimizer step",
-  /* FLAG_DASSL_JACOBIAN */
-  "  Selects the type of the Jacobian that is used for the dassl solver:\n\n"
-  "  * coloredNumerical (colored numerical Jacobian, the default).\n"
-  "  * internalNumerical (internal dassl numerical Jacobian).\n"
-  "  * coloredSymbolical (colored symbolical Jacobian. Only usable if the simulation is compiled with --generateSymbolicJacobian or --generateSymbolicLinearization.\n"
-  "  * numerical - numerical Jacobian.\n\n"
-  "  * symbolical - symbolical Jacobian. Only usable if the simulation is compiled with --generateSymbolicJacobian or --generateSymbolicLinearization.",
   /* FLAG_DASSL_NO_RESTART */
   "  Deactivates the restart of dassl after an event is performed.",
@@ -231 +224 @@
   /* FLAG_IPOPT_WARM_START */
   "  Value specifies lvl for a warm start in ipopt: 1,2,3,...",
+  /* FLAG_JACOBIAN */
+  "  Selects the type of the Jacobian that is used for the integrator:\n\n"
+  "  * coloredNumerical (colored numerical Jacobian, the default).\n"
+  "  * internalNumerical (internal dassl numerical Jacobian).\n"
+  "  * coloredSymbolical (colored symbolical Jacobian. Only usable if the simulation is compiled with --generateSymbolicJacobian or --generateSymbolicLinearization.\n"
+  "  * numerical - numerical Jacobian.\n\n"
+  "  * symbolical - symbolical Jacobian. Only usable if the simulation is compiled with --generateSymbolicJacobian or --generateSymbolicLinearization.",
   /* FLAG_L */
   "  Value specifies a time where the linearization of the model should be performed.",
@@ -339 +339 @@
   /* FLAG_CPU */                   FLAG_TYPE_FLAG,
   /* FLAG_CSV_OSTEP */             FLAG_TYPE_OPTION,
-  /* FLAG_DASSL_JACOBIAN */        FLAG_TYPE_OPTION,
   /* FLAG_DASSL_NO_RESTART */      FLAG_TYPE_FLAG,
   /* FLAG_DASSL_NO_ROOTFINDING */  FLAG_TYPE_FLAG,
@@ -360 +359 @@
   /* FLAG_IPOPT_MAX_ITER */        FLAG_TYPE_OPTION,
   /* FLAG_IPOPT_WARM_START */      FLAG_TYPE_OPTION,
+  /* FLAG_JACOBIAN */              FLAG_TYPE_OPTION,
   /* FLAG_L */                     FLAG_TYPE_OPTION,
   /* FLAG_L_DATA_RECOVERY */       FLAG_TYPE_FLAG,
@@ -550 +550 @@
   "NEWTON_MAX"
 };
+
+
+const char *JACOBIAN_METHOD[JAC_MAX+1] = {
+  "unknown",
+
+  "coloredNumerical",
+  "coloredSymbolical",
+  "internalNumerical",
+  "numerical",
+  "symbolical",
+
+  "JAC_MAX"
+};
+
+const char *JACOBIAN_METHOD_DESC[JAC_MAX+1] = {
+  "unknown",
+
+  "colored numerical jacobian - default.",
+  "colored symbolic jacobian - needs omc compiler flags +generateSymbolicJacobian or +generateSymbolicLinearization.",
+  "internal numerical jacobian.",
+  "numerical jacobian.",
+  "symbolic jacobian - needs omc compiler flags +generateSymbolicJacobian or +generateSymbolicLinearization.",
+
+  "JAC_MAX"
+ };
+

SimulationRuntime/c/util/simulation_options.h

@@ -47 +47 @@
   FLAG_CPU,
   FLAG_CSV_OSTEP,
-  FLAG_DASSL_JACOBIAN,
   FLAG_DASSL_NO_RESTART,
   FLAG_DASSL_NO_ROOTFINDING,
@@ -68 +67 @@
   FLAG_IPOPT_MAX_ITER,
   FLAG_IPOPT_WARM_START,
+  FLAG_JACOBIAN,
   FLAG_L,
   FLAG_L_DATA_RECOVERY,
@@ -225 +225 @@
 extern const char *NEWTONSTRATEGY_DESC[NEWTON_MAX+1];
 
+enum JACOBIAN_METHOD
+{
+  JAC_UNKNOWN = 0,
+
+  COLOREDNUMJAC,
+  COLOREDSYMJAC,
+  INTERNALNUMJAC,
+  NUMJAC,
+  SYMJAC,
+
+  JAC_MAX
+};
+
+extern const char *JACOBIAN_METHOD[JAC_MAX+1];
+extern const char *JACOBIAN_METHOD_DESC[JAC_MAX+1];
+
+
+
+
 #if defined(__cplusplus)
   }