diff options
Diffstat (limited to 'commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html')
| -rw-r--r-- | commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html | 520 |
1 files changed, 520 insertions, 0 deletions
diff --git a/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html new file mode 100644 index 0000000..79eb1c6 --- /dev/null +++ b/commons-math3-3.6.1/docs/apidocs/org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html @@ -0,0 +1,520 @@ +<!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>FirstOrderFieldIntegrator (Apache Commons Math 3.6.1 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="FirstOrderFieldIntegrator (Apache Commons Math 3.6.1 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/FirstOrderFieldIntegrator.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/FirstOrderFieldDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderIntegrator.html" title="interface 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/FirstOrderFieldIntegrator.html" target="_top">Frames</a></li> +<li><a href="FirstOrderFieldIntegrator.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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="Interface FirstOrderFieldIntegrator" class="title">Interface FirstOrderFieldIntegrator<T extends <a href="../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><T>></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of the field elements</dd></dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../../org/apache/commons/math3/ode/AbstractFieldIntegrator.html" title="class in org.apache.commons.math3.ode">AbstractFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/AdamsBashforthFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">AdamsBashforthFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/AdamsFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">AdamsFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/AdamsMoultonFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">AdamsMoultonFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/AdaptiveStepsizeFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">AdaptiveStepsizeFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/ClassicalRungeKuttaFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">ClassicalRungeKuttaFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/DormandPrince54FieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">DormandPrince54FieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/DormandPrince853FieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">DormandPrince853FieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/EmbeddedRungeKuttaFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">EmbeddedRungeKuttaFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/EulerFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">EulerFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/GillFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">GillFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/HighamHall54FieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">HighamHall54FieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/LutherFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">LutherFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/MidpointFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">MidpointFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/MultistepFieldIntegrator.html" title="class in org.apache.commons.math3.ode">MultistepFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/RungeKuttaFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">RungeKuttaFieldIntegrator</a>, <a href="../../../../../org/apache/commons/math3/ode/nonstiff/ThreeEighthesFieldIntegrator.html" title="class in org.apache.commons.math3.ode.nonstiff">ThreeEighthesFieldIntegrator</a></dd> +</dl> +<hr> +<br> +<pre>public interface <span class="strong">FirstOrderFieldIntegrator<T extends <a href="../../../../../org/apache/commons/math3/RealFieldElement.html" title="interface in org.apache.commons.math3">RealFieldElement</a><T>></span></pre> +<div class="block">This interface represents a first order integrator for + differential equations. + + <p>The classes which are devoted to solve first order differential + equations should implement this interface. The problems which can + be handled should implement the <a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderDifferentialEquations</code></a> interface.</p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>3.6</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>FirstOrderFieldDifferentialEquations</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int)">addEventHandler</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler, + double maxCheckInterval, + double convergence, + int maxIterationCount)</code> +<div class="block">Add an event handler to the integrator.</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/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int,%20org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)">addEventHandler</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler, + double maxCheckInterval, + double convergence, + int maxIterationCount, + <a href="../../../../../org/apache/commons/math3/analysis/solvers/BracketedRealFieldUnivariateSolver.html" title="interface in org.apache.commons.math3.analysis.solvers">BracketedRealFieldUnivariateSolver</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> solver)</code> +<div class="block">Add an event handler to the integrator.</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/FirstOrderFieldIntegrator.html#addStepHandler(org.apache.commons.math3.ode.sampling.FieldStepHandler)">addStepHandler</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler)</code> +<div class="block">Add a step handler to this integrator.</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/FirstOrderFieldIntegrator.html#clearEventHandlers()">clearEventHandlers</a></strong>()</code> +<div class="block">Remove all the event handlers that have been added to the integrator.</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/FirstOrderFieldIntegrator.html#clearStepHandlers()">clearStepHandlers</a></strong>()</code> +<div class="block">Remove all the step handlers that have been added to the integrator.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getCurrentSignedStepsize()">getCurrentSignedStepsize</a></strong>()</code> +<div class="block">Get the current signed value of the integration stepsize.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getCurrentStepStart()">getCurrentStepStart</a></strong>()</code> +<div class="block">Get the current value of the step start time t<sub>i</sub>.</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/FirstOrderFieldIntegrator.html#getEvaluations()">getEvaluations</a></strong>()</code> +<div class="block">Get the number of evaluations of the differential equations function.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getEventHandlers()">getEventHandlers</a></strong>()</code> +<div class="block">Get all the event handlers that have been added to the integrator.</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/FirstOrderFieldIntegrator.html#getMaxEvaluations()">getMaxEvaluations</a></strong>()</code> +<div class="block">Get the maximal number of functions evaluations.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getName()">getName</a></strong>()</code> +<div class="block">Get the name of the method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getStepHandlers()">getStepHandlers</a></strong>()</code> +<div class="block">Get all the step handlers that have been added to the integrator.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#integrate(org.apache.commons.math3.ode.FieldExpandableODE,%20org.apache.commons.math3.ode.FieldODEState,%20T)">integrate</a></strong>(<a href="../../../../../org/apache/commons/math3/ode/FieldExpandableODE.html" title="class in org.apache.commons.math3.ode">FieldExpandableODE</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> equations, + <a href="../../../../../org/apache/commons/math3/ode/FieldODEState.html" title="class in org.apache.commons.math3.ode">FieldODEState</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> initialState, + <a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a> finalTime)</code> +<div class="block">Integrate the differential equations up to the given time.</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/FirstOrderFieldIntegrator.html#setMaxEvaluations(int)">setMaxEvaluations</a></strong>(int maxEvaluations)</code> +<div class="block">Set the maximal number of differential equations function evaluations.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getName()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getName</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> +<div class="block">Get the name of the method.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>name of the method</dd></dl> +</li> +</ul> +<a name="addStepHandler(org.apache.commons.math3.ode.sampling.FieldStepHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addStepHandler</h4> +<pre>void addStepHandler(<a href="../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler)</pre> +<div class="block">Add a step handler to this integrator. + <p>The handler will be called by the integrator for each accepted + step.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - handler for the accepted steps</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getStepHandlers()"><code>getStepHandlers()</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#clearStepHandlers()"><code>clearStepHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="getStepHandlers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getStepHandlers</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/commons/math3/ode/sampling/FieldStepHandler.html" title="interface in org.apache.commons.math3.ode.sampling">FieldStepHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>>> getStepHandlers()</pre> +<div class="block">Get all the step handlers that have been added to the integrator.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable collection of the added events handlers</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addStepHandler(org.apache.commons.math3.ode.sampling.FieldStepHandler)"><code>addStepHandler(FieldStepHandler)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#clearStepHandlers()"><code>clearStepHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="clearStepHandlers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearStepHandlers</h4> +<pre>void clearStepHandlers()</pre> +<div class="block">Remove all the step handlers that have been added to the integrator.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addStepHandler(org.apache.commons.math3.ode.sampling.FieldStepHandler)"><code>addStepHandler(FieldStepHandler)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getStepHandlers()"><code>getStepHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler, double, double, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEventHandler</h4> +<pre>void addEventHandler(<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler, + double maxCheckInterval, + double convergence, + int maxIterationCount)</pre> +<div class="block">Add an event handler to the integrator. + <p> + The default solver is a 5<sup>th</sup> order <a href="../../../../../org/apache/commons/math3/analysis/solvers/FieldBracketingNthOrderBrentSolver.html" title="class in org.apache.commons.math3.analysis.solvers"><code>FieldBracketingNthOrderBrentSolver</code></a>. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - event handler</dd><dd><code>maxCheckInterval</code> - maximal time interval between switching + function checks (this interval prevents missing sign changes in + case the integration steps becomes very large)</dd><dd><code>convergence</code> - convergence threshold in the event time search</dd><dd><code>maxIterationCount</code> - upper limit of the iteration count in + the event time search events.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int,%20org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)"><code>addEventHandler(FieldEventHandler, double, double, int, + org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getEventHandlers()"><code>getEventHandlers()</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#clearEventHandlers()"><code>clearEventHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler, double, double, int, org.apache.commons.math3.analysis.solvers.BracketedRealFieldUnivariateSolver)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addEventHandler</h4> +<pre>void addEventHandler(<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> handler, + double maxCheckInterval, + double convergence, + int maxIterationCount, + <a href="../../../../../org/apache/commons/math3/analysis/solvers/BracketedRealFieldUnivariateSolver.html" title="interface in org.apache.commons.math3.analysis.solvers">BracketedRealFieldUnivariateSolver</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> solver)</pre> +<div class="block">Add an event handler to the integrator.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>handler</code> - event handler</dd><dd><code>maxCheckInterval</code> - maximal time interval between switching + function checks (this interval prevents missing sign changes in + case the integration steps becomes very large)</dd><dd><code>convergence</code> - convergence threshold in the event time search</dd><dd><code>maxIterationCount</code> - upper limit of the iteration count in + the event time search events.</dd><dd><code>solver</code> - solver to use to locate the event</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int)"><code>addEventHandler(FieldEventHandler, double, double, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getEventHandlers()"><code>getEventHandlers()</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#clearEventHandlers()"><code>clearEventHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="getEventHandlers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEventHandlers</h4> +<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events">FieldEventHandler</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>>> getEventHandlers()</pre> +<div class="block">Get all the event handlers that have been added to the integrator.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an unmodifiable collection of the added events handlers</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int)"><code>addEventHandler(FieldEventHandler, double, double, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#clearEventHandlers()"><code>clearEventHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="clearEventHandlers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clearEventHandlers</h4> +<pre>void clearEventHandlers()</pre> +<div class="block">Remove all the event handlers that have been added to the integrator.</div> +<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#addEventHandler(org.apache.commons.math3.ode.events.FieldEventHandler,%20double,%20double,%20int)"><code>addEventHandler(FieldEventHandler, double, double, int)</code></a>, +<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getEventHandlers()"><code>getEventHandlers()</code></a></dd></dl> +</li> +</ul> +<a name="getCurrentStepStart()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentStepStart</h4> +<pre><a href="../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> getCurrentStepStart()</pre> +<div class="block">Get the current value of the step start time t<sub>i</sub>. + <p>This method can be called during integration (typically by + the object implementing the <a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>differential equations</code></a> problem) if the value of the current step that + is attempted is needed.</p> + <p>The result is undefined if the method is called outside of + calls to <code>integrate</code>.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>current value of the state at step start time t<sub>i</sub></dd></dl> +</li> +</ul> +<a name="getCurrentSignedStepsize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCurrentSignedStepsize</h4> +<pre><a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a> getCurrentSignedStepsize()</pre> +<div class="block">Get the current signed value of the integration stepsize. + <p>This method can be called during integration (typically by + the object implementing the <a href="../../../../../org/apache/commons/math3/ode/FirstOrderDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><code>differential equations</code></a> problem) if the signed value of the current stepsize + that is tried is needed.</p> + <p>The result is undefined if the method is called outside of + calls to <code>integrate</code>.</p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>current signed value of the stepsize</dd></dl> +</li> +</ul> +<a name="setMaxEvaluations(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxEvaluations</h4> +<pre>void setMaxEvaluations(int maxEvaluations)</pre> +<div class="block">Set the maximal number of differential equations function evaluations. + <p>The purpose of this method is to avoid infinite loops which can occur + for example when stringent error constraints are set or when lots of + discrete events are triggered, thus leading to many rejected steps.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxEvaluations</code> - maximal number of function evaluations (negative + values are silently converted to maximal integer value, thus representing + almost unlimited evaluations)</dd></dl> +</li> +</ul> +<a name="getMaxEvaluations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxEvaluations</h4> +<pre>int getMaxEvaluations()</pre> +<div class="block">Get the maximal number of functions evaluations.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>maximal number of functions evaluations</dd></dl> +</li> +</ul> +<a name="getEvaluations()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEvaluations</h4> +<pre>int getEvaluations()</pre> +<div class="block">Get the number of evaluations of the differential equations function. + <p> + The number of evaluations corresponds to the last call to the + <code>integrate</code> method. It is 0 if the method has not been called yet. + </p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>number of evaluations of the differential equations function</dd></dl> +</li> +</ul> +<a name="integrate(org.apache.commons.math3.ode.FieldExpandableODE,org.apache.commons.math3.ode.FieldODEState,org.apache.commons.math3.RealFieldElement)"> +<!-- --> +</a><a name="integrate(org.apache.commons.math3.ode.FieldExpandableODE, org.apache.commons.math3.ode.FieldODEState, T)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>integrate</h4> +<pre><a href="../../../../../org/apache/commons/math3/ode/FieldODEStateAndDerivative.html" title="class in org.apache.commons.math3.ode">FieldODEStateAndDerivative</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> integrate(<a href="../../../../../org/apache/commons/math3/ode/FieldExpandableODE.html" title="class in org.apache.commons.math3.ode">FieldExpandableODE</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> equations, + <a href="../../../../../org/apache/commons/math3/ode/FieldODEState.html" title="class in org.apache.commons.math3.ode">FieldODEState</a><<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a>> initialState, + <a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html" title="type parameter in FirstOrderFieldIntegrator">T</a> finalTime) + throws <a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a>, + <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/NoBracketingException.html" title="class in org.apache.commons.math3.exception">NoBracketingException</a></pre> +<div class="block">Integrate the differential equations up to the given time. + <p>This method solves an Initial Value Problem (IVP).</p> + <p>Since this method stores some internal state variables made + available in its public interface during integration (<a href="../../../../../org/apache/commons/math3/ode/FirstOrderFieldIntegrator.html#getCurrentSignedStepsize()"><code>getCurrentSignedStepsize()</code></a>), it is <em>not</em> thread-safe.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>equations</code> - differential equations to integrate</dd><dd><code>initialState</code> - initial state (time, primary and secondary state vectors)</dd><dd><code>finalTime</code> - target time for the integration + (can be set to a value smaller than <code>t0</code> for backward integration)</dd> +<dt><span class="strong">Returns:</span></dt><dd>final state, its time will be the same as <code>finalTime</code> if + integration reached its target, but may be different if some <a href="../../../../../org/apache/commons/math3/ode/events/FieldEventHandler.html" title="interface in org.apache.commons.math3.ode.events"><code>FieldEventHandler</code></a> stops it at some point.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../../../org/apache/commons/math3/exception/NumberIsTooSmallException.html" title="class in org.apache.commons.math3.exception">NumberIsTooSmallException</a></code> - if integration step is too small</dd> +<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/NoBracketingException.html" title="class in org.apache.commons.math3.exception">NoBracketingException</a></code> - if the location of an event cannot be bracketed</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/FirstOrderFieldIntegrator.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/FirstOrderFieldDifferentialEquations.html" title="interface in org.apache.commons.math3.ode"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/math3/ode/FirstOrderIntegrator.html" title="interface 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/FirstOrderFieldIntegrator.html" target="_top">Frames</a></li> +<li><a href="FirstOrderFieldIntegrator.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>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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–2016 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> |