NumericalIntegrator Class |
Inheritance HierarchyAGI.Foundation.NumericalMethodsNumericalIntegrator
AGI.Foundation.NumericalMethods.AdvancedAdaptiveNumericalIntegrator
AGI.Foundation.NumericalMethods.AdvancedMultipleStepIntegrator
AGI.Foundation.NumericalMethods.AdvancedRungeKuttaFixedStepIntegrator
Namespace: AGI.Foundation.NumericalMethods
Assembly: AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 24.3.420.0 (24.3.420.0)
SyntaxThe NumericalIntegrator type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | NumericalIntegrator | Initializes a new instance. |
| NumericalIntegrator(NumericalIntegrator, CopyContext) | Initializes a new instance as a copy of an existing instance. |
Properties| Name | Description | |
|---|---|---|
 | CurrentStepSize |
Gets the current (positive) size of the step which the integrator will use for the next integration step.
|
| Dimension |
Gets the number of dependent variables based on the
Dimension of the SystemOfEquations.
|
| Direction |
Gets or sets whether to integrate forward, increasing the independent variable, or backward,
decreasing the independent variable.
|
| FinalDependentVariableValues |
Gets or sets the values of the dependent variables resulting from the last integration step.
|
| FinalIndependentVariableValue |
Gets or sets the value of the independent variable after an integration step.
|
| 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.
|
| InitialIndependentVariableValue |
Gets or sets the value of the independent variable prior to an integration step.
|
| 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.
|
| IsThreadSafe |
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
| PreviousStepSize |
Gets the size of the last step taken by the integrator. This returns the difference between the
FinalIndependentVariableValue and the InitialIndependentVariableValue.
|
| 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.
|
| SystemOfEquations |
Gets or sets the system of differential equations corresponding to the derivatives of the
dependent variables.
|
Methods| Name | Description | |
|---|---|---|
 | Clone |
Create a copy of this integrator.
|
| 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.
|
| 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. |
| 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. |
| 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. |
| 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.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also