Mercurial > hg > de.mpg.mpiwg.itgroup.digilib.plugin

comparison libs/commons-math-2.1/docs/apidocs/src-html/org/apache/commons/math/ode/SecondOrderIntegrator.html @ 13:cbf34dd4d7e6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
commons-math-2.1 added
author dwinter
date Tue, 04 Jan 2011 10:02:07 +0100
parents
children
comparison
equal deleted inserted replaced
12:970d26a94fb7 13:cbf34dd4d7e6
1 <HTML>
2 <BODY BGCOLOR="white">
3 <PRE>
4 <FONT color="green">001</FONT> /*<a name="line.1"></a>
5 <FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
6 <FONT color="green">003</FONT> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
7 <FONT color="green">004</FONT> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
8 <FONT color="green">005</FONT> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
9 <FONT color="green">006</FONT> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
10 <FONT color="green">007</FONT> * the License. You may obtain a copy of the License at<a name="line.7"></a>
11 <FONT color="green">008</FONT> *<a name="line.8"></a>
12 <FONT color="green">009</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
13 <FONT color="green">010</FONT> *<a name="line.10"></a>
14 <FONT color="green">011</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
15 <FONT color="green">012</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
16 <FONT color="green">013</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
17 <FONT color="green">014</FONT> * See the License for the specific language governing permissions and<a name="line.14"></a>
18 <FONT color="green">015</FONT> * limitations under the License.<a name="line.15"></a>
19 <FONT color="green">016</FONT> */<a name="line.16"></a>
20 <FONT color="green">017</FONT> <a name="line.17"></a>
21 <FONT color="green">018</FONT> package org.apache.commons.math.ode;<a name="line.18"></a>
22 <FONT color="green">019</FONT> <a name="line.19"></a>
23 <FONT color="green">020</FONT> <a name="line.20"></a>
24 <FONT color="green">021</FONT> /** This interface represents a second order integrator for<a name="line.21"></a>
25 <FONT color="green">022</FONT> * differential equations.<a name="line.22"></a>
26 <FONT color="green">023</FONT> *<a name="line.23"></a>
27 <FONT color="green">024</FONT> * &lt;p&gt;The classes which are devoted to solve second order differential<a name="line.24"></a>
28 <FONT color="green">025</FONT> * equations should implement this interface. The problems which can<a name="line.25"></a>
29 <FONT color="green">026</FONT> * be handled should implement the {@link<a name="line.26"></a>
30 <FONT color="green">027</FONT> * SecondOrderDifferentialEquations} interface.&lt;/p&gt;<a name="line.27"></a>
31 <FONT color="green">028</FONT> *<a name="line.28"></a>
32 <FONT color="green">029</FONT> * @see SecondOrderDifferentialEquations<a name="line.29"></a>
33 <FONT color="green">030</FONT> * @version $Revision: 811786 $ $Date: 2009-09-06 05:36:08 -0400 (Sun, 06 Sep 2009) $<a name="line.30"></a>
34 <FONT color="green">031</FONT> * @since 1.2<a name="line.31"></a>
35 <FONT color="green">032</FONT> */<a name="line.32"></a>
36 <FONT color="green">033</FONT> <a name="line.33"></a>
37 <FONT color="green">034</FONT> public interface SecondOrderIntegrator extends ODEIntegrator {<a name="line.34"></a>
38 <FONT color="green">035</FONT> <a name="line.35"></a>
39 <FONT color="green">036</FONT> /** Integrate the differential equations up to the given time<a name="line.36"></a>
40 <FONT color="green">037</FONT> * @param equations differential equations to integrate<a name="line.37"></a>
41 <FONT color="green">038</FONT> * @param t0 initial time<a name="line.38"></a>
42 <FONT color="green">039</FONT> * @param y0 initial value of the state vector at t0<a name="line.39"></a>
43 <FONT color="green">040</FONT> * @param yDot0 initial value of the first derivative of the state<a name="line.40"></a>
44 <FONT color="green">041</FONT> * vector at t0<a name="line.41"></a>
45 <FONT color="green">042</FONT> * @param t target time for the integration<a name="line.42"></a>
46 <FONT color="green">043</FONT> * (can be set to a value smaller thant &lt;code&gt;t0&lt;/code&gt; for backward integration)<a name="line.43"></a>
47 <FONT color="green">044</FONT> * @param y placeholder where to put the state vector at each<a name="line.44"></a>
48 <FONT color="green">045</FONT> * successful step (and hence at the end of integration), can be the<a name="line.45"></a>
49 <FONT color="green">046</FONT> * same object as y0<a name="line.46"></a>
50 <FONT color="green">047</FONT> * @param yDot placeholder where to put the first derivative of<a name="line.47"></a>
51 <FONT color="green">048</FONT> * the state vector at time t, can be the same object as yDot0<a name="line.48"></a>
52 <FONT color="green">049</FONT> * @throws IntegratorException if the integrator cannot perform integration<a name="line.49"></a>
53 <FONT color="green">050</FONT> * @throws DerivativeException this exception is propagated to the caller if the<a name="line.50"></a>
54 <FONT color="green">051</FONT> * underlying user function triggers one<a name="line.51"></a>
55 <FONT color="green">052</FONT> */<a name="line.52"></a>
56 <FONT color="green">053</FONT> void integrate(SecondOrderDifferentialEquations equations,<a name="line.53"></a>
57 <FONT color="green">054</FONT> double t0, double[] y0, double[] yDot0,<a name="line.54"></a>
58 <FONT color="green">055</FONT> double t, double[] y, double[] yDot)<a name="line.55"></a>
59 <FONT color="green">056</FONT> throws DerivativeException, IntegratorException;<a name="line.56"></a>
60 <FONT color="green">057</FONT> <a name="line.57"></a>
61 <FONT color="green">058</FONT> }<a name="line.58"></a>
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122 </PRE>
123 </BODY>
124 </HTML>