org.simulator.math.odes

Interface ParameterizedDESystem

All Superinterfaces:

DESystem, org.apache.commons.math.ode.FirstOrderDifferentialEquations, Serializable

public interface ParameterizedDESystem
extends DESystem

This class defines a differential equation system that contains parameters whose values influence its behavior. Parameters can be any double values, but it is expected to have an identical number of String identifiers and double values, i.e., each parameter value being associated with a unique identifier. Implementing classes provide methods to manipulate the current parameter configuration of the system.

Since:

1.2

Version:

$Rev$

Author:

Andreas Dräger

Method Summary

Modifier and Type	Method and Description
int	getParameterCount() Gives the number of parameters in the ParameterizedDESystem.
String[]	getParameterIdentifiers() It is assumed that each parameter value in the system is associated with a unique identifier, which can be used to address it in numerical calculations.
double[]	getParameterValues() This method allows you to access all current values of the parameters within the ParameterizedDESystem in form of a double array.
void	setParameters(double[] values) With this method it is possible to change the values of particular parameters.

Methods inherited from interface org.simulator.math.odes.DESystem

containsEventsOrRules, getIdentifiers, getPositiveValueCount, setDelaysIncluded

Methods inherited from interface org.apache.commons.math.ode.FirstOrderDifferentialEquations

computeDerivatives, getDimension

Method Detail

getParameterCount

int getParameterCount()

Gives the number of parameters in the ParameterizedDESystem. The number returned here must be identical to the length of the arrays returned by the methods getParameterIdentifiers() AND getParameterValues(). Otherwise, the implementation might show unexpected behavior.

Returns:

parameterCount the number of parameters in the system that influence its behavior

See Also:

getParameterIdentifiers(), getParameterValues()

getParameterIdentifiers

String[] getParameterIdentifiers()

It is assumed that each parameter value in the system is associated with a unique identifier, which can be used to address it in numerical calculations. This method returns an array of all parameters in the ParameterizedDESystem.

Returns:

identifiers

See Also:

getParameterCount(), getParameterValues()

getParameterValues

double[] getParameterValues()

This method allows you to access all current values of the parameters within the ParameterizedDESystem in form of a double array. The length of the returned array must be identical with the value returned by DESystem.getPositiveValueCount() and also with the number of identifiers given by getParameterIdentifiers()

Returns:

values the current values of all parameters in the system in form of a double array

See Also:

getParameterCount(), getParameterIdentifiers()

setParameters

void setParameters(double[] values)

With this method it is possible to change the values of particular parameters. The length of the given array must be identical to the number returned by getParameterCount(), but this does not mean that all parameters have to be changed when calling this method. For instance, you can obtain the current values of all parameters by calling getParameterValues(). Within this array you could change some values of interest and subsequently pass the array to this method.

Parameters:

values - the new values for all parameters.

See Also:

getParameterCount()