Click or drag to resize

NumericalIntegrator Class

A numerical integrator which can be used to update a set of dependent variables over a given step of an independent variable by using a differential equation defining the derivatives.
Inheritance Hierarchy

Namespace:  AGI.Foundation.NumericalMethods
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.5.402.0 (19.5.402.0)
Syntax
public abstract class NumericalIntegrator : IThreadAware, 
	ICloneWithContext

The NumericalIntegrator type exposes the following members.

Constructors
  NameDescription
Protected methodNumericalIntegrator
Initializes a new instance.
Protected methodNumericalIntegrator(NumericalIntegrator, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyCurrentStepSize
Gets the current (positive) size of the step which the integrator will use for the next integration step.
Public propertyDimension
Gets the number of dependent variables based on the Dimension of the SystemOfEquations.
Public propertyDirection
Gets or sets whether to integrate forward, increasing the independent variable, or backward, decreasing the independent variable.
Public propertyFinalDependentVariableValues
Gets or sets the values of the dependent variables resulting from the last integration step.
Public propertyFinalIndependentVariableValue
Gets or sets the value of the independent variable after an integration step.
Public propertyInitialDependentVariableValues
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.
Public propertyInitialIndependentVariableValue
Gets or sets the value of the independent variable prior to an integration step.
Public propertyInitialStepSize
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.
Public propertyIsThreadSafe
Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
Public propertyPreviousStepSize
Gets the size of the last step taken by the integrator. This returns the difference between the FinalIndependentVariableValue and the InitialIndependentVariableValue.
Public propertyStepSizeInformation
Gets or sets a value indicating whether the CurrentStepSize was changed from the InitialStepSize and, if so, the nature of how it was changed.
Public propertySystemOfEquations
Gets or sets the system of differential equations corresponding to the derivatives of the dependent variables.
Top
Methods
  NameDescription
Public methodClone
Create a copy of this integrator.
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.
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.

Public methodIntegrate(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.

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.

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 re-integration.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also