OdeSet (Snifflib API)

java.lang.Object
- com.mockturtlesolutions.snifflib.integration.OdeSet

```
public class OdeSet
extends java.lang.Object
```
Standard options for Ode solvers. The value of YscaleMethod

Field Summary

Fields
Modifier and Type	Field and Description
`DblMatrix`	`absTol`
`int`	`errorScaling`
`DblMatrix`	`initDt`
`DblMatrix`	`initY`
`DblMatrix`	`maxDt`
`DblMatrix`	`minDt`
`DblMatrix`	`relTol`
`static int`	`SCALING_ABS_REL`
`int`	`subSteps`
`DblMatrix`	`timePoints`
`boolean`	`trackingEvents`
`DblMatrix`	`tStart`
`DblMatrix`	`tStop`
`boolean`	`usingJacobianPattern`
`boolean`	`usingNumericalJacobian`
`int`	`YscaleMethod`

Constructor Summary

Constructors
Constructor and Description

OdeSet()

Constructors
Constructor and Description
`OdeSet()`

Method Summary

Methods
Modifier and Type	Method and Description
`DblMatrix`	`getAbsoluteTolerance()`
`boolean`	`getEventTracking()`
`DblMatrix`	`getInitialTimeStep()`
`DblMatrix`	`getInitialValue()`
`DblMatrix`	`getMaxTimeStep()`
`DblMatrix`	`getMinTimeStep()`
`boolean`	`getNumericalJacobian()`
`DblMatrix`	`getRelativeTolerance()`
`int`	`getScalingMethod()`
`DblMatrix`	`getStartTime()`
`DblMatrix`	`getStopTime()`
`int`	`getSubSteps()`
`DblMatrix`	`getTimePoints()`
`boolean`	`getUsingJacobianPattern()`
`void`	`setAbsouteTolerance(DblMatrix abs)`
`void`	`setEventTracking(boolean s)` Toggles behavior of event tracking.
`void`	`setInitialTimeStep(DblMatrix Tstep)` Some solvers may use this while others may not need or use it.
`void`	`setInitialValue(DblMatrix init)`
`void`	`setMaxTimeStep(DblMatrix Tstep)` Some solvers may use this while others may not need or use it.
`void`	`setMinTimeStep(DblMatrix Tstep)`
`void`	`setRelativeTolerance(DblMatrix rel)`
`void`	`setScalingMethod(int k)` Sets the error scaling method.
`void`	`setStartTime(DblMatrix start)`
`void`	`setStopTime(DblMatrix stop)`
`void`	`setSubSteps(int n)`
`void`	`setTimePoints(DblMatrix t)`
`void`	`setUsingJacobianPattern(boolean s)` Sets whether or not a Jacobian pattern is used to reduce computational effort.
`void`	`setUsingNumericalJacobian(boolean use)` If set to true a numerical Jacobian will be calculated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SCALING_ABS_REL
```
public static final int SCALING_ABS_REL
```
See Also:
Constant Field Values

absTol
```
public DblMatrix absTol
```

relTol
```
public DblMatrix relTol
```

maxDt
```
public DblMatrix maxDt
```

minDt
```
public DblMatrix minDt
```

initDt
```
public DblMatrix initDt
```

tStart
```
public DblMatrix tStart
```

timePoints
```
public DblMatrix timePoints
```

tStop
```
public DblMatrix tStop
```

initY
```
public DblMatrix initY
```

usingNumericalJacobian
```
public boolean usingNumericalJacobian
```

usingJacobianPattern
```
public boolean usingJacobianPattern
```

trackingEvents
```
public boolean trackingEvents
```

errorScaling
```
public int errorScaling
```

subSteps
```
public int subSteps
```

YscaleMethod
```
public int YscaleMethod
```

Constructor Detail
- OdeSet
```
public OdeSet()
```

Method Detail
- setTimePoints
```
public void setTimePoints(DblMatrix t)
```
- getTimePoints
```
public DblMatrix getTimePoints()
```
- setStartTime
```
public void setStartTime(DblMatrix start)
```
- getStartTime
```
public DblMatrix getStartTime()
```
- setStopTime
```
public void setStopTime(DblMatrix stop)
```
- getStopTime
```
public DblMatrix getStopTime()
```
- setInitialValue
```
public void setInitialValue(DblMatrix init)
```
- getInitialValue
```
public DblMatrix getInitialValue()
```
- setInitialTimeStep
```
public void setInitialTimeStep(DblMatrix Tstep)
```
  Some solvers may use this while others may not need or use it.
- getInitialTimeStep
```
public DblMatrix getInitialTimeStep()
```
- setMaxTimeStep
```
public void setMaxTimeStep(DblMatrix Tstep)
```
  Some solvers may use this while others may not need or use it.
- getSubSteps
```
public int getSubSteps()
```
- setSubSteps
```
public void setSubSteps(int n)
```
- getMaxTimeStep
```
public DblMatrix getMaxTimeStep()
```
- setMinTimeStep
```
public void setMinTimeStep(DblMatrix Tstep)
```
- getMinTimeStep
```
public DblMatrix getMinTimeStep()
```
- setAbsouteTolerance
```
public void setAbsouteTolerance(DblMatrix abs)
```
- getAbsoluteTolerance
```
public DblMatrix getAbsoluteTolerance()
```
- setRelativeTolerance
```
public void setRelativeTolerance(DblMatrix rel)
```
- getRelativeTolerance
```
public DblMatrix getRelativeTolerance()
```
- setUsingJacobianPattern
```
public void setUsingJacobianPattern(boolean s)
```
  Sets whether or not a Jacobian pattern is used to reduce computational effort. This is especially important for stiff sets of ODE's. The pattern is given by the Ode but this option determines if the Jacobian pattern is actually used.
- getUsingJacobianPattern
```
public boolean getUsingJacobianPattern()
```
- setUsingNumericalJacobian
```
public void setUsingNumericalJacobian(boolean use)
```
  If set to true a numerical Jacobian will be calculated. Even if the ODE has implemented getJacobian so that it returns a non-null value a numerical Jacobian will still be used. If set to false and the result of getJacobian is null then a numerical Jacobian will be used.
- getNumericalJacobian
```
public boolean getNumericalJacobian()
```
- setEventTracking
```
public void setEventTracking(boolean s)
```
  Toggles behavior of event tracking. If set to true then events are tracked.
- getEventTracking
```
public boolean getEventTracking()
```
- setScalingMethod
```
public void setScalingMethod(int k)
```
  Sets the error scaling method.
- getScalingMethod
```
public int getScalingMethod()
```

Class OdeSet

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCALING_ABS_REL

absTol

relTol

maxDt

minDt

initDt

tStart

timePoints

tStop

initY

usingNumericalJacobian

usingJacobianPattern

trackingEvents

errorScaling

subSteps

YscaleMethod

Constructor Detail

OdeSet

Method Detail

setTimePoints

getTimePoints

setStartTime

getStartTime

setStopTime

getStopTime

setInitialValue

getInitialValue

setInitialTimeStep

getInitialTimeStep

setMaxTimeStep

getSubSteps

setSubSteps

getMaxTimeStep

setMinTimeStep

getMinTimeStep

setAbsouteTolerance

getAbsoluteTolerance

setRelativeTolerance

getRelativeTolerance

setUsingJacobianPattern

getUsingJacobianPattern

setUsingNumericalJacobian

getNumericalJacobian

setEventTracking

getEventTracking

setScalingMethod

getScalingMethod