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

pack-priv Class ParameterizedWrapper

extends Object
implements ParameterizedODE
Class Inheritance
All Implemented Interfaces
org.apache.commons.math3.ode.ParameterizedODE, org.apache.commons.math3.ode.Parameterizable
Imports
java.util.ArrayList, .Collection, org.apache.commons.math3.exception.DimensionMismatchException, .MaxCountExceededException
Wrapper class enabling basic simple ODE instances to be used when processing JacobianMatrices.
Since
3.0

Field Summary

Modifier and TypeField and Description
private final FirstOrderDifferentialEquations
fode

Basic FODE without parameter.

Constructor Summary

AccessConstructor and Description
pack-priv
ParameterizedWrapper(final FirstOrderDifferentialEquations
original first order differential equations
ode)

Simple constructor.

Method Summary

Modifier and TypeMethod and Description
public void
computeDerivatives(double
current value of the independent time variable
t, double[]
array containing the current value of the state vector
y, double[]
placeholder array where to put the time derivative of the state vector
yDot)

Get the current time derivative of the state vector of the underlying FODE.

public int

Returns:

dimension of the underlying FODE
getDimension()

Get the dimension of the underlying FODE.

public double
getParameter(String
parameter name
name)

Implements org.apache.commons.math3.ode.ParameterizedODE.getParameter.

Get parameter value from its name.

public Collection<String>
getParametersNames()

Implements org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Get the names of the supported parameters.

public boolean
isSupported(String
parameter name to check
name)

Implements org.apache.commons.math3.ode.Parameterizable.isSupported.

Check if a parameter is supported.

public void
setParameter(String
parameter name
name, double
parameter value
value)

Implements org.apache.commons.math3.ode.ParameterizedODE.setParameter.

Set the value for a given parameter.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fodeback to summary
private final FirstOrderDifferentialEquations fode

Basic FODE without parameter.

Constructor Detail

ParameterizedWrapperback to summary
pack-priv ParameterizedWrapper(final FirstOrderDifferentialEquations ode)

Simple constructor.

Parameters
ode:FirstOrderDifferentialEquations

original first order differential equations

Method Detail

computeDerivativesback to summary
public void computeDerivatives(double t, double[] y, double[] yDot) throws MaxCountExceededException, DimensionMismatchException

Get the current time derivative of the state vector of the underlying FODE.

Parameters
t:double

current value of the independent time variable

y:double[]

array containing the current value of the state vector

yDot:double[]

placeholder array where to put the time derivative of the state vector

Exceptions
MaxCountExceededException:
if the number of functions evaluations is exceeded
DimensionMismatchException:
if arrays dimensions do not match equations settings
getDimensionback to summary
public int getDimension()

Get the dimension of the underlying FODE.

Returns:int

dimension of the underlying FODE

getParameterback to summary
public double getParameter(String name) throws UnknownParameterException

Implements org.apache.commons.math3.ode.ParameterizedODE.getParameter.

Doc from org.apache.commons.math3.ode.ParameterizedODE.getParameter.

Get parameter value from its name.

Parameters
name:String

parameter name

Returns:double

parameter value

Exceptions
UnknownParameterException:
if parameter is not supported
getParametersNamesback to summary
public Collection<String> getParametersNames()

Implements org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Doc from org.apache.commons.math3.ode.Parameterizable.getParametersNames.

Get the names of the supported parameters.

Returns:Collection<String>

parameters names

isSupportedback to summary
public boolean isSupported(String name)

Implements org.apache.commons.math3.ode.Parameterizable.isSupported.

Doc from org.apache.commons.math3.ode.Parameterizable.isSupported.

Check if a parameter is supported.

Supported parameters are those listed by getParametersNames().

Parameters
name:String

parameter name to check

Returns:boolean

true if the parameter is supported

setParameterback to summary
public void setParameter(String name, double value)

Implements org.apache.commons.math3.ode.ParameterizedODE.setParameter.

Doc from org.apache.commons.math3.ode.ParameterizedODE.setParameter.

Set the value for a given parameter.

Parameters
name:String

parameter name

value:double

parameter value