RungeKuttaFixedStepIntegrator Class

Defines a Runge-Kutta integrator with a fixed step size.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.NumericalMethodsNumericalIntegrator
    AGI.Foundation.NumericalMethods.AdvancedRungeKuttaFixedStepIntegrator
      AGI.Foundation.NumericalMethodsRungeKutta4Integrator

Namespace: AGI.Foundation.NumericalMethods.Advanced
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.2.419.0 (24.2.419.0)

Syntax

C++

Copy

public abstract class RungeKuttaFixedStepIntegrator : NumericalIntegrator

Public MustInherit Class RungeKuttaFixedStepIntegrator
	Inherits NumericalIntegrator

public ref class RungeKuttaFixedStepIntegrator abstract : public NumericalIntegrator

[<AbstractClassAttribute>]
type RungeKuttaFixedStepIntegrator =  
    class
        inherit NumericalIntegrator
    end

The RungeKuttaFixedStepIntegrator type exposes the following members.

Constructors

	Name	Description
	RungeKuttaFixedStepIntegrator(RungeKuttaAlgorithm)	Initializes a new instance based on the given tableau.
	RungeKuttaFixedStepIntegrator(RungeKuttaAlgorithm, DependentVariableDerivatives)	Initializes a new instance based on the given tableau and on the given differential system for the derivatives of the dependent variables.
	RungeKuttaFixedStepIntegrator(RungeKuttaFixedStepIntegrator, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	CurrentStepSize	Gets the current (positive) size of the step which the integrator will use for the next integration step. (Overrides NumericalIntegratorCurrentStepSize.)
	Dimension	Gets the number of dependent variables based on the Dimension of the SystemOfEquations. (Inherited from NumericalIntegrator.)
	Direction	Gets or sets whether to integrate forward, increasing the independent variable, or backward, decreasing the independent variable. (Inherited from NumericalIntegrator.)
	FinalDependentVariableValues	Gets or sets the values of the dependent variables resulting from the last integration step. (Inherited from NumericalIntegrator.)
	FinalIndependentVariableValue	Gets or sets the value of the independent variable after an integration step. (Inherited from NumericalIntegrator.)
	InitialDependentVariableValues	Gets or sets the values of the dependent variables prior to an integration step. These values will be updated to the previous FinalDependentVariableValues at the beginning of each integration step. (Inherited from NumericalIntegrator.)
	InitialIndependentVariableValue	Gets or sets the value of the independent variable prior to an integration step. (Inherited from NumericalIntegrator.)
	InitialStepSize	Gets or sets the initial (positive) size of the step to add to the InitialIndependentVariableValue when performing an integration. By default, the initial value is one. (Inherited from NumericalIntegrator.)
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously. (Inherited from NumericalIntegrator.)
	PreviousStepSize	Gets the size of the last step taken by the integrator. This returns the difference between the FinalIndependentVariableValue and the InitialIndependentVariableValue. (Inherited from NumericalIntegrator.)
	StepSizeInformation	Gets or sets a value indicating whether the CurrentStepSize was changed from the InitialStepSize and, if so, the nature of how it was changed. (Inherited from NumericalIntegrator.)
	SystemOfEquations	Gets or sets the system of differential equations corresponding to the derivatives of the dependent variables. (Inherited from NumericalIntegrator.)
	Tableau	Gets or sets the Butcher Tableau with the coefficients and weights to use to perform the RungeKutta integration.

Top

Methods

	Name	Description
	Clone	Create a copy of this integrator. (Inherited from NumericalIntegrator.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Initialize	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 NumericalIntegratorInitialize(Double, Double).)
	Integrate	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 NumericalIntegrator.)
	Integrate(Double)	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. When overriding this method, StartNextStep should be called prior to integration. Also note that the CurrentStepSize property should be unaffected by the stepSize parameter. (Inherited from NumericalIntegrator.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Reintegrate	Repeats the last integration of the differential equations. When overriding this method, note that the CurrentStepSize property should be unaffected by the stepSize parameter. (Overrides NumericalIntegratorReintegrate(Double).)
	StartNextStep	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.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Reference

AGI.Foundation.NumericalMethods.Advanced Namespace