Click or drag to resize

RungeKuttaCashKarp45Integrator Methods

The RungeKuttaCashKarp45Integrator type exposes the following members.

Methods
  NameDescription
Public methodAdaptStep
This method updates the CurrentStepSize to account for error in the state and its derivatives. It returns true if the integrator should reintegrate with the updated step size or false if the integrator should continue to the next integration step (potentially with a different step size).
(Overrides AdaptiveNumericalIntegratorAdaptStep.)
Protected methodAdjustStep
Adjusts a given step by increasing it or decreasing it based on the given error. If the error is greater than one, the step will increase. Otherwise, it will decrease. After adjusting the step, BoundAndTruncateStepSize(Double) is called.
(Inherited from AdaptiveNumericalIntegrator.)
Protected methodBoundAndTruncateStepSize
A method which should be called before updating the CurrentStepSize which will bound the size based on the MinimumStepSize and MaximumStepSize, and will truncate it based on the StepTruncationOrder.
(Inherited from AdaptiveNumericalIntegrator.)
Public methodClone
Create a copy of this integrator.
(Overrides NumericalIntegratorClone(CopyContext).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
Initialize the integrator's initial independent and dependent variables and reset the integration parameters. This should be called by the user prior to performing the first integration step.
(Overrides RungeKuttaAdaptiveStepIntegratorInitialize(Double, Double).)
Public methodIntegrate

Perform an integration step moving the independent and dependent variables from their initial (the final values of the previous step) to their new final values, using the CurrentStepSize.

When overriding this method, StartNextStep should be called prior to integration.

(Inherited from AdaptiveNumericalIntegrator.)
Public methodIntegrate(Double)
Integrate the current integration step with the given step size.
(Inherited from AdaptiveNumericalIntegrator.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReintegrate

Repeats the last integration of the differential equations.

When overriding this method, note that the CurrentStepSize property should be unaffected by the stepSize parameter.

(Inherited from RungeKuttaAdaptiveStepIntegrator.)
Protected methodSetCurrentStepSize
Sets the value of the CurrentStepSize which the integrator will use for the next integration step.
(Inherited from AdaptiveNumericalIntegrator.)
Protected methodStartNextStep
This performs the task of setting the Initial values to the previous Final values prior to taking the next step. This method is called prior to integrating the step but not called during reintegration.
(Inherited from NumericalIntegrator.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also