org.apache.commons.math.ode.sampling
Class DummyStepInterpolator

java.lang.Object
  extended by org.apache.commons.math.ode.sampling.AbstractStepInterpolator
      extended by org.apache.commons.math.ode.sampling.DummyStepInterpolator
All Implemented Interfaces:
Externalizable, Serializable, StepInterpolator

public class DummyStepInterpolator
extends AbstractStepInterpolator

This class is a step interpolator that does nothing.

This class is used when the "step handler" set up by the user does not need step interpolation. It does not recompute the state when setInterpolatedTime is called. This implies the interpolated state is always the state at the end of the current step.

Since:
1.2
See Also:
StepHandler, Serialized Form

Constructor Summary
DummyStepInterpolator()
          Simple constructor.
DummyStepInterpolator(double[] y, double[] yDot, boolean forward)
          Simple constructor.
DummyStepInterpolator(DummyStepInterpolator interpolator)
          Copy constructor.
 
Method Summary
 void readExternal(ObjectInput in)
          Read the instance from an input channel.
 void writeExternal(ObjectOutput out)
          Write the instance to an output channel.
 
Methods inherited from class org.apache.commons.math.ode.sampling.AbstractStepInterpolator
copy, finalizeStep, getCurrentTime, getGlobalCurrentTime, getGlobalPreviousTime, getInterpolatedDerivatives, getInterpolatedState, getInterpolatedTime, getPreviousTime, isForward, setInterpolatedTime, setSoftCurrentTime, setSoftPreviousTime, shift, storeTime
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DummyStepInterpolator

public DummyStepInterpolator()
Simple constructor. This constructor builds an instance that is not usable yet, the AbstractStepInterpolator.reinitialize protected method should be called before using the instance in order to initialize the internal arrays. This constructor is used only in order to delay the initialization in some cases. As an example, the EmbeddedRungeKuttaIntegrator uses the prototyping design pattern to create the step interpolators by cloning an uninitialized model and latter initializing the copy.


DummyStepInterpolator

public DummyStepInterpolator(double[] y,
                             double[] yDot,
                             boolean forward)
Simple constructor.

Parameters:
y - reference to the integrator array holding the state at the end of the step
yDot - reference to the integrator array holding the state derivative at some arbitrary point within the step
forward - integration direction indicator

DummyStepInterpolator

public DummyStepInterpolator(DummyStepInterpolator interpolator)
Copy constructor.

Parameters:
interpolator - interpolator to copy from. The copy is a deep copy: its arrays are separated from the original arrays of the instance
Method Detail

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Write the instance to an output channel.

Specified by:
writeExternal in interface Externalizable
Specified by:
writeExternal in class AbstractStepInterpolator
Parameters:
out - output channel
Throws:
IOException - if the instance cannot be written

readExternal

public void readExternal(ObjectInput in)
                  throws IOException
Read the instance from an input channel.

Specified by:
readExternal in interface Externalizable
Specified by:
readExternal in class AbstractStepInterpolator
Parameters:
in - input channel
Throws:
IOException - if the instance cannot be read


jHepWork 3.0 ©