org.vizzini.math.ode
Interface IODE

All Known Implementing Classes:

AbstractODE, DynamicStateODE

public interface IODE

Defines methods required by ordinary differential equations in the game framework.

Since:

v0.3

Version:

v0.3

Author:

Jeffrey M. Thompson

Method Summary

double[]	getAllQ() Return the values of all the dependent variables.
int	getEquationCount() Return the equation count.
double	getQ(int index) Return the value of the dependent variable at the given index.
double[]	getRightHandSide(double s, double[] q, double ds, double[] deltaQ, double qScale) Returns the right-hand side of the ODEs.
double	getS() Return the value of the independent variable.
void	setQ(double value, int index) Set the value of the dependent variable at the given index.
void	setS(double value) Set the value of the independent variable.
void	updatePostProcess() Perform update post-processing.

Method Detail

getAllQ

double[] getAllQ()

Return the values of all the dependent variables.

Since:

v0.3

getEquationCount

int getEquationCount()

Return the equation count.

Since:

v0.3

getQ

double getQ(int index)

Return the value of the dependent variable at the given index.

Parameters:

index - Index of the dependent variable.

Since:

v0.3

getRightHandSide

double[] getRightHandSide(double s,
                          double[] q,
                          double ds,
                          double[] deltaQ,
                          double qScale)

Returns the right-hand side of the ODEs.

Parameters:

s - Independent variable value.

q - Dependent variables values.

ds - Delta value of the independent variable.

deltaQ - Delta values of the dependent variables.

qScale - Scale value for the dependent variables.

Since:

v0.3

getS

double getS()

Return the value of the independent variable.

Since:

v0.3

setQ

void setQ(double value,
          int index)

Set the value of the dependent variable at the given index.

Parameters:

value - Dependent variable value.

index - Index of the dependent variable.

Since:

v0.3

setS

void setS(double value)

Set the value of the independent variable.

Since:

v0.3

updatePostProcess

void updatePostProcess()

Perform update post-processing.

Since:

v0.3