| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ExpandableStatefulODE (Apache Commons Math 3.3 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="ExpandableStatefulODE (Apache Commons Math 3.3 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExpandableStatefulODE.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderConverter.html" title="class in org.apache.commons.math3.ode"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/ode/ExpandableStatefulODE.html" target="_top">Frames</a></li> |
| <li><a href="ExpandableStatefulODE.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.commons.math3.ode</div> |
| <h2 title="Class ExpandableStatefulODE" class="title">Class ExpandableStatefulODE</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.commons.math3.ode.ExpandableStatefulODE</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="strong">ExpandableStatefulODE</span> |
| extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> |
| <div class="block">This class represents a combined set of first order differential equations, |
| with at least a primary set of equations expandable by some sets of secondary |
| equations. |
| <p> |
| One typical use case is the computation of the Jacobian matrix for some ODE. |
| In this case, the primary set of equations corresponds to the raw ODE, and we |
| add to this set another bunch of secondary equations which represent the Jacobian |
| matrix of the primary set. |
| </p> |
| <p> |
| We want the integrator to use <em>only</em> the primary set to estimate the |
| errors and hence the step sizes. It should <em>not</em> use the secondary |
| equations in this computation. The <a href="../../../../../org/apache/commons/math3/ode/AbstractIntegrator.html" title="class in org.apache.commons.math3.ode"><code>integrator</code></a> will |
| be able to know where the primary set ends and so where the secondary sets begin. |
| </p></div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">Version:</span></dt> |
| <dd>$Id: ExpandableStatefulODE.java 1463680 2013-04-02 19:02:55Z luc $</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderDifferentialEquations</code></a>, |
| <a href="../../../../../org/apache/commons/math3/ode/JacobianMatrices.html" title="class in org.apache.commons.math3.ode"><code>JacobianMatrices</code></a></dd></dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colOne" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colOne"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#ExpandableStatefulODE(org.apache.commons.math3.ode.FirstOrderDifferentialEquations)">ExpandableStatefulODE</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a> primary)</code> |
| <div class="block">Build an expandable set from its primary ODE set.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)">addSecondaryEquations</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/SecondaryEquations.html" title="interface in org.apache.commons.math3.ode">SecondaryEquations</a> secondary)</code> |
| <div class="block">Add a set of secondary equations to be integrated along with the primary set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#computeDerivatives(double, double[], double[])">computeDerivatives</a></strong>(double t, |
| double[] y, |
| double[] yDot)</code> |
| <div class="block">Get the current time derivative of the complete state vector.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getCompleteState()">getCompleteState</a></strong>()</code> |
| <div class="block">Get the complete current state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getPrimary()">getPrimary</a></strong>()</code> |
| <div class="block">Get the primary set of differential equations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode">EquationsMapper</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getPrimaryMapper()">getPrimaryMapper</a></strong>()</code> |
| <div class="block">Get an equations mapper for the primary equations set.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getPrimaryState()">getPrimaryState</a></strong>()</code> |
| <div class="block">Get primary part of the current state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getPrimaryStateDot()">getPrimaryStateDot</a></strong>()</code> |
| <div class="block">Get primary part of the current state derivative.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode">EquationsMapper</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getSecondaryMappers()">getSecondaryMappers</a></strong>()</code> |
| <div class="block">Get the equations mappers for the secondary equations sets.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getSecondaryState(int)">getSecondaryState</a></strong>(int index)</code> |
| <div class="block">Get secondary part of the current state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>double[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getSecondaryStateDot(int)">getSecondaryStateDot</a></strong>(int index)</code> |
| <div class="block">Get secondary part of the current state derivative.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>double</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getTime()">getTime</a></strong>()</code> |
| <div class="block">Get current time.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>int</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getTotalDimension()">getTotalDimension</a></strong>()</code> |
| <div class="block">Return the dimension of the complete set of equations.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#setCompleteState(double[])">setCompleteState</a></strong>(double[] completeState)</code> |
| <div class="block">Set the complete current state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#setPrimaryState(double[])">setPrimaryState</a></strong>(double[] primaryState)</code> |
| <div class="block">Set primary part of the current state.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#setSecondaryState(int, double[])">setSecondaryState</a></strong>(int index, |
| double[] secondaryState)</code> |
| <div class="block">Set secondary part of the current state.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#setTime(double)">setTime</a></strong>(double time)</code> |
| <div class="block">Set current time.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="ExpandableStatefulODE(org.apache.commons.math3.ode.FirstOrderDifferentialEquations)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ExpandableStatefulODE</h4> |
| <pre>public ExpandableStatefulODE(<a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a> primary)</pre> |
| <div class="block">Build an expandable set from its primary ODE set.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>primary</code> - the primary set of differential equations to be integrated.</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getPrimary()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimary</h4> |
| <pre>public <a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode">FirstOrderDifferentialEquations</a> getPrimary()</pre> |
| <div class="block">Get the primary set of differential equations.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>primary set of differential equations</dd></dl> |
| </li> |
| </ul> |
| <a name="getTotalDimension()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTotalDimension</h4> |
| <pre>public int getTotalDimension()</pre> |
| <div class="block">Return the dimension of the complete set of equations. |
| <p> |
| The complete set of equations correspond to the primary set plus all secondary sets. |
| </p></div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>dimension of the complete set of equations</dd></dl> |
| </li> |
| </ul> |
| <a name="computeDerivatives(double, double[], double[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>computeDerivatives</h4> |
| <pre>public void computeDerivatives(double t, |
| double[] y, |
| double[] yDot) |
| throws <a href="../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a>, |
| <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> |
| <div class="block">Get the current time derivative of the complete state vector.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>t</code> - current value of the independent <I>time</I> variable</dd><dd><code>y</code> - array containing the current value of the complete state vector</dd><dd><code>yDot</code> - placeholder array where to put the time derivative of the complete state vector</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/MaxCountExceededException.html" title="class in org.apache.commons.math3.exception">MaxCountExceededException</a></code> - if the number of functions evaluations is exceeded</dd> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if arrays dimensions do not match equations settings</dd></dl> |
| </li> |
| </ul> |
| <a name="addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>addSecondaryEquations</h4> |
| <pre>public int addSecondaryEquations(<a href="../../../../../org/apache/commons/math3/ode/SecondaryEquations.html" title="interface in org.apache.commons.math3.ode">SecondaryEquations</a> secondary)</pre> |
| <div class="block">Add a set of secondary equations to be integrated along with the primary set.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>secondary</code> - secondary equations set</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>index of the secondary equation in the expanded state</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrimaryMapper()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryMapper</h4> |
| <pre>public <a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode">EquationsMapper</a> getPrimaryMapper()</pre> |
| <div class="block">Get an equations mapper for the primary equations set.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>mapper for the primary set</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getSecondaryMappers()"><code>getSecondaryMappers()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getSecondaryMappers()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecondaryMappers</h4> |
| <pre>public <a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode">EquationsMapper</a>[] getSecondaryMappers()</pre> |
| <div class="block">Get the equations mappers for the secondary equations sets.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>equations mappers for the secondary equations sets</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#getPrimaryMapper()"><code>getPrimaryMapper()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="setTime(double)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setTime</h4> |
| <pre>public void setTime(double time)</pre> |
| <div class="block">Set current time.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>time</code> - current time</dd></dl> |
| </li> |
| </ul> |
| <a name="getTime()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTime</h4> |
| <pre>public double getTime()</pre> |
| <div class="block">Get current time.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>current time</dd></dl> |
| </li> |
| </ul> |
| <a name="setPrimaryState(double[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setPrimaryState</h4> |
| <pre>public void setPrimaryState(double[] primaryState) |
| throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> |
| <div class="block">Set primary part of the current state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>primaryState</code> - primary part of the current state</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of the array does not |
| match the primary set</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrimaryState()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryState</h4> |
| <pre>public double[] getPrimaryState()</pre> |
| <div class="block">Get primary part of the current state.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>primary part of the current state</dd></dl> |
| </li> |
| </ul> |
| <a name="getPrimaryStateDot()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getPrimaryStateDot</h4> |
| <pre>public double[] getPrimaryStateDot()</pre> |
| <div class="block">Get primary part of the current state derivative.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>primary part of the current state derivative</dd></dl> |
| </li> |
| </ul> |
| <a name="setSecondaryState(int, double[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setSecondaryState</h4> |
| <pre>public void setSecondaryState(int index, |
| double[] secondaryState) |
| throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> |
| <div class="block">Set secondary part of the current state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the part to set as returned by <a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)"><code>addSecondaryEquations(SecondaryEquations)</code></a></dd><dd><code>secondaryState</code> - secondary part of the current state</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of the partial state does not |
| match the selected equations set dimension</dd></dl> |
| </li> |
| </ul> |
| <a name="getSecondaryState(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecondaryState</h4> |
| <pre>public double[] getSecondaryState(int index)</pre> |
| <div class="block">Get secondary part of the current state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the part to set as returned by <a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)"><code>addSecondaryEquations(SecondaryEquations)</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>secondary part of the current state</dd></dl> |
| </li> |
| </ul> |
| <a name="getSecondaryStateDot(int)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getSecondaryStateDot</h4> |
| <pre>public double[] getSecondaryStateDot(int index)</pre> |
| <div class="block">Get secondary part of the current state derivative.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - index of the part to set as returned by <a href="../../../../../org/apache/commons/math3/ode/ExpandableStatefulODE.html#addSecondaryEquations(org.apache.commons.math3.ode.SecondaryEquations)"><code>addSecondaryEquations(SecondaryEquations)</code></a></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>secondary part of the current state derivative</dd></dl> |
| </li> |
| </ul> |
| <a name="setCompleteState(double[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCompleteState</h4> |
| <pre>public void setCompleteState(double[] completeState) |
| throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> |
| <div class="block">Set the complete current state.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>completeState</code> - complete current state to copy data from</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of the complete state does not |
| match the complete equations sets dimension</dd></dl> |
| </li> |
| </ul> |
| <a name="getCompleteState()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getCompleteState</h4> |
| <pre>public double[] getCompleteState() |
| throws <a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></pre> |
| <div class="block">Get the complete current state.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>complete current state</dd> |
| <dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/commons/math3/exception/DimensionMismatchException.html" title="class in org.apache.commons.math3.exception">DimensionMismatchException</a></code> - if the dimension of the complete state does not |
| match the complete equations sets dimension</dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ExpandableStatefulODE.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><em><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script></em></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/commons/math3/ode/EquationsMapper.html" title="class in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderConverter.html" title="class in org.apache.commons.math3.ode"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/commons/math3/ode/ExpandableStatefulODE.html" target="_top">Frames</a></li> |
| <li><a href="ExpandableStatefulODE.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor_detail">Constr</a> | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2003–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |