Xcos solvers : Renamed "Dormand-Price" to correct name "Dormand-Prince" 46/10046/4
Paul BIGNIER [Tue, 18 Dec 2012 13:40:10 +0000 (14:40 +0100)]
Also corrected in the doc

Change-Id: Ia314f17859478068705720cba6235c682a43f5c3

scilab/CHANGES_5.4.X
scilab/modules/scicos/src/c/scicos.c
scilab/modules/scicos/src/scicos_sundials/src/cvode/cvode.c
scilab/modules/xcos/examples/solvers/integDoPri.sce
scilab/modules/xcos/help/en_US/solvers/0-LSodar.xml
scilab/modules/xcos/help/en_US/solvers/1-CVode.xml
scilab/modules/xcos/help/en_US/solvers/2-Runge-Kutta.xml
scilab/modules/xcos/help/en_US/solvers/3-Dormand-Prince.xml [moved from scilab/modules/xcos/help/en_US/solvers/3-Dormand-Price.xml with 86% similarity]
scilab/modules/xcos/help/en_US/solvers/7-IDA.xml

index a660e1d..43f11e4 100644 (file)
@@ -57,7 +57,7 @@ Xcos
 
 * Add a new ODE solver : LSodar. Automatically switches methods to efficiently solve both stiff and nonstiff problems. Includes a rootfinding feature.
 
-* Add two new Fixed-size step ODE solvers : Dormand-Price 4(5) then Runge-Kutta 4(5). Included in the CVode package, so benefit from the rootfinding feature.
+* Add two new Fixed-size step ODE solvers : Dormand-Prince 4(5) then Runge-Kutta 4(5). Included in the CVode package, so benefit from the rootfinding feature.
 
 * Add an implicit Fixed-size stop ODE solver : Implicit Runge-Kutta 4(5). Also benefits from the CVode rootfinding feature.
 
index c65bbb8..6842a3e 100644 (file)
@@ -823,7 +823,7 @@ int C2F(scicos)(double *x_in, int *xptr_in, double *z__,
         {
             cossim(t0);
         }
-        else if (C2F(cmsolver).solver == 5)   /*  DOPRI: Method: Dormand-Price, Nonlinear solver=  */
+        else if (C2F(cmsolver).solver == 5)   /*  DOPRI: Method: Dormand-Prince, Nonlinear solver=  */
         {
             cossim(t0);
         }
index 1ccc3dd..6636aab 100644 (file)
@@ -357,7 +357,7 @@ void *CVodeCreate(int lmm, int iter)
 
   maxord = (lmm == CV_ADAMS) ? ADAMS_Q_MAX : BDF_Q_MAX;
 
-  /* If Dormand-Price is selected, then maxord = 8 to use the 7 extra vectors allocated (zn[2, 3, 4, 5, 6, 7, 8]) */
+  /* If Dormand-Prince is selected, then maxord = 8 to use the 7 extra vectors allocated (zn[2, 3, 4, 5, 6, 7, 8]) */
   maxord = (lmm == CV_DOPRI) ? 8 : maxord;
 
   /* If Runge-Kutta is selected, then maxord = 1 */
@@ -2403,7 +2403,7 @@ static int CVStep(CVodeMem cv_mem)
 /*
  * CVStepDoPri
  *
- * This routine performs one internal cvode step using the Dormand-Price 4(5) method, from tn to tn + h.
+ * This routine performs one internal cvode step using the Dormand-Prince 4(5) method, from tn to tn + h.
  * Proceed to computing the K[i] coefficients, build the final solution, increment tn and return CV_SUCCESS.
  *
  * In order to temporarily store the results, we use tempv and ftemp.
@@ -2493,11 +2493,11 @@ static int CVStepDoPri(CVodeMem cv_mem)
 
   /* Check for errors in the evaluations of f thanks to retval */
   if (retval < 0) {
-    CVProcessError(cv_mem, CV_RHSFUNC_FAIL, "Dormand-Price", "CVStepDoPri", MSGCV_RHSFUNC_FAILED, tn);
+    CVProcessError(cv_mem, CV_RHSFUNC_FAIL, "Dormand-Prince", "CVStepDoPri", MSGCV_RHSFUNC_FAILED, tn);
     return(CV_RHSFUNC_FAIL);
   }
   if (retval > 0) {
-    CVProcessError(cv_mem, CV_FIRST_RHSFUNC_ERR, "Dormand-Price", "CVStepDoPri", MSGCV_RHSFUNC_FIRST);
+    CVProcessError(cv_mem, CV_FIRST_RHSFUNC_ERR, "Dormand-Prince", "CVStepDoPri", MSGCV_RHSFUNC_FIRST);
     return(CV_FIRST_RHSFUNC_ERR);
   }
 
index a75698b..fae1fab 100644 (file)
@@ -15,7 +15,7 @@ loadXcosLibs();
 importXcosDiagram("SCI/modules/xcos/examples/solvers/ODE_Example.xcos");
 scs_m.props.tf = 30000;
 
-solverName=["BDF/Newton", "BDF/Functional", "Adams/Newton", "Adams/Functional", "Dormand-Price"];
+solverName=["BDF/Newton", "BDF/Functional", "Adams/Newton", "Adams/Functional", "Dormand-Prince"];
 
 for solver=1:5
 
index 8601f06..ca130ea 100644 (file)
@@ -168,7 +168,7 @@ Time for Adams / Functional :
                 <link linkend="RK">Runge-Kutta 4(5)</link>
             </member>
             <member>
-                <link linkend="DoPri">Dormand-Price 4(5)</link>
+                <link linkend="DoPri">Dormand-Prince 4(5)</link>
             </member>
             <member>
                 <link linkend="ImpRK">Implicit Runge-Kutta 4(5)</link>
index f3d94ff..bf76d64 100644 (file)
@@ -262,7 +262,7 @@ Time for Adams / Functional :
                 <link linkend="RK">Runge-Kutta 4(5)</link>
             </member>
             <member>
-                <link linkend="DoPri">Dormand-Price 4(5)</link>
+                <link linkend="DoPri">Dormand-Prince 4(5)</link>
             </member>
             <member>
                 <link linkend="ImpRK">Implicit Runge-Kutta 4(5)</link>
index 034fd7d..7ae6ba5 100644 (file)
@@ -225,7 +225,7 @@ Time for Runge-Kutta :
                 <link linkend="IDA">IDA</link>
             </member>
             <member>
-                <link linkend="DoPri">Dormand-Price 4(5)</link>
+                <link linkend="DoPri">Dormand-Prince 4(5)</link>
             </member>
             <member>
                 <link linkend="ImpRK">Implicit Runge-Kutta 4(5)</link>
  -->
 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg"  xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en_US" xml:id="DoPri">
     <refnamediv>
-        <refname>Dormand-Price 4(5)</refname>
+        <refname>Dormand-Prince 4(5)</refname>
         <refpurpose>
-            <emphasis>Dormand-Price</emphasis> is a numerical solver providing an efficient explicit method to solve Ordinary Differential Equations (ODEs) Initial Value Problems.
+            <emphasis>Dormand-Prince</emphasis> is a numerical solver providing an efficient explicit method to solve Ordinary Differential Equations (ODEs) Initial Value Problems.
         </refpurpose>
     </refnamediv>
     <refsection>
         <title>Description</title>
         <para>
-            Called by <link linkend="xcos">xcos</link>, <emphasis>Dormand-Price</emphasis> is a numerical solver providing an efficient fixed-size step method to solve Initial Value Problems of the form :
+            Called by <link linkend="xcos">xcos</link>, <emphasis>Dormand-Prince</emphasis> is a numerical solver providing an efficient fixed-size step method to solve Initial Value Problems of the form :
         </para>
         <para>
             <latex>
@@ -32,7 +32,7 @@
             <emphasis>CVode</emphasis> and <emphasis>IDA</emphasis> use variable-size steps for the integration.
         </para>
         <para>
-            A drawback of that is the unpredictable computation time. With Dormand-Price, we do not adapt to the complexity of the problem, but we guarantee a stable computation time.
+            A drawback of that is the unpredictable computation time. With Dormand-Prince, we do not adapt to the complexity of the problem, but we guarantee a stable computation time.
         </para>
         <para>
             As of now, this method is explicit, so it is not concerned with Newton or Functional iterations, and not advised for stiff problems.
@@ -48,7 +48,7 @@
             By convention, to use fixed-size steps, the program first computes a fitting <emphasis>h</emphasis> that approaches the simulation parameter <link linkend="Simulatemenu_Menu_entries">max step size</link>.
         </para>
         <para>
-            An important difference of Dormand-Price with the previous methods is that it computes up to the seventh derivative of <emphasis>y</emphasis>, while the others only use linear combinations of <emphasis>y</emphasis> and <emphasis>y'</emphasis>.
+            An important difference of Dormand-Prince with the previous methods is that it computes up to the seventh derivative of <emphasis>y</emphasis>, while the others only use linear combinations of <emphasis>y</emphasis> and <emphasis>y'</emphasis>.
         </para>
         <para>
             Here, the next value is determined by the present value 
@@ -95,7 +95,7 @@
             .
         </para>
         <para>
-            That error analysis baptized the method <emphasis>Dormand-Price 4(5)</emphasis> : 
+            That error analysis baptized the method <emphasis>Dormand-Prince 4(5)</emphasis> : 
             <emphasis>
                 O(h<superscript>5</superscript>)
             </emphasis>
@@ -137,7 +137,7 @@ try xcos_simulate(scs_m, 4); catch disp(lasterror()); end
 ]]></scilab:image>
         </para>
         <para>
-            The integral block returns its continuous state, we can evaluate it with Dormand-Price by running the example :
+            The integral block returns its continuous state, we can evaluate it with Dormand-Prince by running the example :
         </para>
         <para>
             <programlisting language="example"><![CDATA[
@@ -147,7 +147,7 @@ try xcos_simulate(scs_m, 4); catch disp(lasterror()); end
       importXcosDiagram("SCI/modules/xcos/examples/solvers/ODE_Example.xcos");
       scs_m.props.tf = 5000;
 
-      // Select the Dormand-Price solver and set the precision
+      // Select the Dormand-Prince solver and set the precision
       scs_m.props.tol(6) = 5;
       scs_m.props.tol(7) = 10^-2;
 
@@ -155,18 +155,18 @@ try xcos_simulate(scs_m, 4); catch disp(lasterror()); end
       tic();
       try xcos_simulate(scs_m, 4); catch disp(lasterror()); end
       t = toc();
-      disp(t, "Time for Dormand-Price :");
+      disp(t, "Time for Dormand-Prince :");
       ]]></programlisting>
         </para>
         <para>
             The Scilab console displays :
             <screen><![CDATA[
-Time for Dormand-Price :
+Time for Dormand-Prince :
  17.226
             ]]></screen>
         </para>
         <para>
-            Now, in the following script, we compare the time difference between Dormand-Price and Sundials by running the example with the five solvers in turn :
+            Now, in the following script, we compare the time difference between Dormand-Prince and Sundials by running the example with the five solvers in turn :
             <link type="scilab" linkend ="scilab.scinotes/xcos/examples/solvers/integDoPri.sce">
                 Open the script
             </link>
@@ -190,7 +190,7 @@ Time for DoPri :
             ]]></screen>
         </para>
         <para>
-            These results show that on a nonstiff problem, for relatively same precision required and forcing the same step size, Dormand-Price's computational overhead (compared to Runge-Kutta) is significant and is close to <emphasis>Adams/Functional</emphasis>. Its error to the solution is althought much smaller than the regular Runge-Kutta 4(5), for a small overhead in time.
+            These results show that on a nonstiff problem, for relatively same precision required and forcing the same step size, Dormand-Prince's computational overhead (compared to Runge-Kutta) is significant and is close to <emphasis>Adams/Functional</emphasis>. Its error to the solution is althought much smaller than the regular Runge-Kutta 4(5), for a small overhead in time.
         </para>
         <para>
             Variable-size step ODE solvers are not appropriate for deterministic real-time applications because the computational overhead of taking a time step varies over the course of an application.
@@ -234,7 +234,7 @@ Time for DoPri :
     <refsection>
         <title>Bibliography</title>
         <para>
-            Journal of Computational and Applied Mathematics, Volume 15, Issue 2, 2 June 1986, Pages 203-211 <ulink url="http://dl.acm.org/citation.cfm?id=9958.9963&amp;coll=DL&amp;dl=GUIDE">Dormand-Price Method</ulink>
+            Journal of Computational and Applied Mathematics, Volume 15, Issue 2, 2 June 1986, Pages 203-211 <ulink url="http://dl.acm.org/citation.cfm?id=9958.9963&amp;coll=DL&amp;dl=GUIDE">Dormand-Prince Method</ulink>
         </para>
         <para>
             <ulink url="https://computation.llnl.gov/casc/sundials/documentation/documentation.html">Sundials Documentation</ulink>
@@ -245,7 +245,7 @@ Time for DoPri :
         <revhistory>
             <revision>
                 <revnumber>5.4.1</revnumber>
-                <revdescription>Dormand-Price 4(5) solver added</revdescription>
+                <revdescription>Dormand-Prince 4(5) solver added</revdescription>
             </revision>
         </revhistory>
     </refsection>
index 6a1da87..a86b194 100644 (file)
@@ -170,7 +170,7 @@ try xcos_simulate(scs_m, 4); catch disp(lasterror()); end
                 <link linkend="RK">Runge-Kutta 4(5)</link>
             </member>
             <member>
-                <link linkend="DoPri">Dormand-Price 4(5)</link>
+                <link linkend="DoPri">Dormand-Prince 4(5)</link>
             </member>
             <member>
                 <link linkend="ImpRK">Implicit Runge-Kutta 4(5)</link>