Ode |
Options for explicit Runge-Kutta methods.
Inheritance HierarchyNamespace: Altaxo.Calc.Ode
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class OdeMethodOptions
The OdeMethodOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | OdeMethodOptions | Initializes a new instance of the OdeMethodOptions class |
Properties| Name | Description | |
|---|---|---|
 | AbsoluteTolerance | Gets or sets the absolute tolerance for all y-values. Use AbsoluteTolerances if you want to set the absolute tolerance for each individual y-value. |
| AbsoluteTolerances | Gets or sets the absolute tolerances. The length of the array must either be 1 (equal tolerances for all y-values), or of length N. |
| AutomaticStepSizeControl | Gets or sets a value indicating whether automatic step size control is switched on. |
| ErrorNorm | Gets or sets the error norm that is used for the evaluation of the relative error, in order to control the step size. |
| IncludeAutomaticStepsInOutput | Gets or sets a value indicating whether steps generated by the automatic step size control should be included in the output. This value is true by default. The value is effective only if AutomaticStepSizeControl is set to true. If AutomaticStepSizeControl is true, but this value is false, then MandatorySolutionPoints have to be set. |
| IncludeInitialValueInOutput | Gets or sets a value indicating whether the inital point should be included in the output. |
| IncludeMandatorySolutionPointsInOutput | Default: true. Gets or sets a value indicating whether the mandatory solution points (see MandatorySolutionPoints) should appear in the output sequence. This value is only effective if AutomaticStepSizeControl is true. Without automatic step size control, mandatory solution points always appear in the output sequence. |
| InitialStepSize | Gets or sets the initial step size. This value is effective only if AutomaticStepSizeControl is true. |
| MandatorySolutionPoints | Gets or sets the mandatory solution points. Mandatory solution points will be evaluated directly (i.e. not interpolated). |
| MaxStepSize | Gets or sets the maximum size of the step. This value is effective only if AutomaticStepSizeControl is true. |
| OptionalSolutionPoints | Gets or sets optional solution points. Optional solution points will be not evaluated directly, but interpolated between two real solution points. |
| RelativeTolerance | Gets or sets the relative tolerance for all y-values. Use RelativeTolerances if you want to set the relative tolerance for each individual y-value. |
| RelativeTolerances | Gets or sets the relative tolerances. The length of the array must either be 1 (equal tolerances for all y-values), or of length N. |
| StepSize | Gets or sets the size of the step. This value is effective only if automatic step size control is not active. |
| StepSizeFilter | Set the step size filter (determines the variation of step sizes), see StepSizeFilter. |
| StiffnessDetectionEveryNumberOfSteps | Gets or sets the number of successful steps between test for stiffness. Setting this value to 0 disables stiffness detection. The default value is 0. |
Methods| Name | Description | |
|---|---|---|
| CheckConsistency | Checks the consistency of the options. An InvalidOperationException is thrown if some of the parameters exclude each other. |
| 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) |
 | GetEquidistantSequence | Gets an equidistant sequence, that can be used e.g. for OptionalSolutionPoints or MandatorySolutionPoints. |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Fields
Remarks
Essentially there are two modi for explicit Runge-Kutta methods:
i) With automatic step size control (AutomaticStepSizeControl = true) and
ii) Without automatic step size control (AutomaticStepSizeControl = false)
With automatic step size control, the following parameters are relevant:
- IncludeInitialValueInOutput determines whether the inital values for x and y should appear as first item in the output sequence.
- AbsoluteTolerance and RelativeTolerance and/or AbsoluteTolerances and RelativeTolerances determine the chosen step size.
- MaxStepSize determines the maximum applied step size.
- IncludeAutomaticStepsInOutput if the steps that are chosen automatically should appear in the sequence of solution points.
- InitialStepSize determines the initial step size. If set to null, a reasonable guess of the initial step size will be done.
- StepSizeFilter determines the variations of the step size.
- MandatorySolutionPoints are points where the method is forced to have a solution point. At those points the evaluation of the derivative is forced.
- IncludeMandatorySolutionPointsInOutput determines if the mandatory solution points should appear in the output sequence (default: true).
- OptionalSolutionPoints are points that are evaluated by interpolation between true solution points. Optional solution points always appear in the output sequence.
Without automatic step size control, the following parameters are relevant:
- IncludeInitialValueInOutput determines whether the inital values for x and y should appear as first item in the output sequence.
- StepSize determines the fixed step size. Set this parameter to null if you only want to output MandatorySolutionPoints.
- MandatorySolutionPoints are points where the method is forced to have a solution point. At those points the evaluation of the derivative is forced. In mode without automatic step size control, mandatory solution points always appear in the output sequence.
- OptionalSolutionPoints are points that are evaluated by interpolation between true solution points. Optional solution points always appear in the output sequence.
See Also