Top Description Methods
org.apache.commons.math3.ode

public Interface MainStateJacobianProvider

extends FirstOrderDifferentialEquations
Known Direct Implementers
org.apache.commons.math3.ode.JacobianMatrices.MainStateJacobianWrapper
Imports
org.apache.commons.math3.exception.DimensionMismatchException, .MaxCountExceededException
Interface expanding first order differential equations in order to compute exactly the main state jacobian matrix for partial derivatives equations.
Since
3.0

Method Summary

Modifier and TypeMethod and Description
public void
computeMainStateJacobian(double
current value of the independent time variable
t, double[]
array containing the current value of the main state vector
y, double[]
array containing the current value of the time derivative of the main state vector
yDot, double[][]
placeholder array where to put the jacobian matrix of the ODE w.r.t. the main state vector
dFdY)

Compute the jacobian matrix of ODE with respect to main state.

Inherited from org.apache.commons.math3.ode.FirstOrderDifferentialEquations:
computeDerivativesgetDimension

Method Detail

computeMainStateJacobianback to summary
public void computeMainStateJacobian(double t, double[] y, double[] yDot, double[][] dFdY) throws MaxCountExceededException, DimensionMismatchException

Compute the jacobian matrix of ODE with respect to main state.

Parameters
t:double

current value of the independent time variable

y:double[]

array containing the current value of the main state vector

yDot:double[]

array containing the current value of the time derivative of the main state vector

dFdY:double[][]

placeholder array where to put the jacobian matrix of the ODE w.r.t. the main state vector

Exceptions
MaxCountExceededException:
if the number of functions evaluations is exceeded
DimensionMismatchException:
if arrays dimensions do not match equations settings