Apache
/
commons-math
mirror of https://github.com/apache/commons-math.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update ode.xml

This commit is contained in:
Matty G 2019-09-27 08:10:57 -07:00 committed by GitHub
parent f72172bf66
commit 09f8e50dc8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/site/xdoc/userguide/ode.xml
View File

@ -86,7 +86,7 @@
The user should describe his problem in his own classes which should implement the The user should describe his problem in his own classes which should implement the
<a href="../apidocs/org/apache/commons/math4/ode/FirstOrderDifferentialEquations.html">FirstOrderDifferentialEquations</a> <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderDifferentialEquations.html">FirstOrderDifferentialEquations</a>
interface (or <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderFieldDifferentialEquations.html">FirstOrderFieldDifferentialEquations</a> interface (or <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderFieldDifferentialEquations.html">FirstOrderFieldDifferentialEquations</a>
interface). Then he should pass it to the integrator he prefers among all the classes that implement interface). Then they should pass it to the integrator they prefer among all the classes that implement
the <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderIntegrator.html">FirstOrderIntegrator</a> the <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderIntegrator.html">FirstOrderIntegrator</a>
interface (or the <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderFieldIntegrator.html">FirstOrderFieldIntegrator</a> interface (or the <a href="../apidocs/org/apache/commons/math4/ode/FirstOrderFieldIntegrator.html">FirstOrderFieldIntegrator</a>
interface). The following example shows how to implement the simple two-dimensional problem using double primitives: interface). The following example shows how to implement the simple two-dimensional problem using double primitives:
@ -190,7 +190,7 @@ integrator.addStepHandler(stepHandler);
class can be used to convert the variable stepsize into a fixed stepsize that can be handled by classes class can be used to convert the variable stepsize into a fixed stepsize that can be handled by classes
implementing the <a href="../apidocs/org/apache/commons/math4/ode/sampling/FixedStepHandler.html">FixedStepHandler</a> implementing the <a href="../apidocs/org/apache/commons/math4/ode/sampling/FixedStepHandler.html">FixedStepHandler</a>
interface. Adaptive stepsize integrators can automatically compute the initial stepsize by themselves, interface. Adaptive stepsize integrators can automatically compute the initial stepsize by themselves,
however the user can specify it if he prefers to retain full control over the integration or if the however the user can specify it if they prefers to retain full control over the integration or if the
automatic guess is wrong. automatic guess is wrong.
</p> </p>
</subsection> </subsection>
@ -308,7 +308,7 @@ public int eventOccurred(double t, double[] y, boolean increasing) {
<p> <p>
If in addition to state y(t) the user needs to compute the sensitivity of the final state with respect to If in addition to state y(t) the user needs to compute the sensitivity of the final state with respect to
the initial state (dy/dy<sub>0</sub>) or the sensitivity of the final state with respect to some parameters the initial state (dy/dy<sub>0</sub>) or the sensitivity of the final state with respect to some parameters
of the ODE (dy/dp<sub>k</sub>), he needs to register the variational equations as a set of secondary equations of the ODE (dy/dp<sub>k</sub>), they need to register the variational equations as a set of secondary equations
appended to the main state before the integration starts. Then the integration will propagate the compound appended to the main state before the integration starts. Then the integration will propagate the compound
state composed of both the main state and its partial derivatives. At the end of the integration, the Jacobian state composed of both the main state and its partial derivatives. At the end of the integration, the Jacobian
matrices are extracted from the integrated secondary state. The <a matrices are extracted from the integrated secondary state. The <a
@ -359,7 +359,7 @@ public int eventOccurred(double t, double[] y, boolean increasing) {
The parameters are identified by a name (a simple user defined string), which are also specified at <a The parameters are identified by a name (a simple user defined string), which are also specified at <a
href="../apidocs/org/apache/commons/math4/ode/JacobianMatrices.html">JacobianMatrices</a> class construction. If the ODE href="../apidocs/org/apache/commons/math4/ode/JacobianMatrices.html">JacobianMatrices</a> class construction. If the ODE
is simple enough that the user can implement df(t, y, p)/dp<sub>k</sub> directly for some of the parameters p<sub>k</sub>, is simple enough that the user can implement df(t, y, p)/dp<sub>k</sub> directly for some of the parameters p<sub>k</sub>,
then he can provide one or more classes implementing the <a then they can provide one or more classes implementing the <a
href="../apidocs/org/apache/commons/math4/ode/ParameterJacobianProvider.html">ParameterJacobianProvider</a> interface by href="../apidocs/org/apache/commons/math4/ode/ParameterJacobianProvider.html">ParameterJacobianProvider</a> interface by
calling the JacobianMatrices.addParameterJacobianProvide method. The parameters are handled one at a time, but all the calls to calling the JacobianMatrices.addParameterJacobianProvide method. The parameters are handled one at a time, but all the calls to
ParameterJacobianProvider.computeParameterJacobian will be grouped in one sequence after the call to MainStateJacobianProvider.computeMainStateJacobian ParameterJacobianProvider.computeParameterJacobian will be grouped in one sequence after the call to MainStateJacobianProvider.computeMainStateJacobian