OdeMethodOptions Type
Options for explicit Runge-Kutta methods.
Essentially there are two modi for explicit Runge-Kutta methods:
i) With automatic step size control (OdeMethodOptions.AutomaticStepSizeControl = true) and
ii) Without automatic step size control (OdeMethodOptions.AutomaticStepSizeControl = false)
With automatic step size control, the following parameters are relevant:
- OdeMethodOptions.IncludeInitialValueInOutput determines whether the inital values for x and y should appear as first item in the output sequence.
- OdeMethodOptions.AbsoluteTolerance and OdeMethodOptions.RelativeTolerance and/or OdeMethodOptions.AbsoluteTolerances and OdeMethodOptions.RelativeTolerances determine the chosen step size.
- OdeMethodOptions.MaxStepSize determines the maximum applied step size.
- OdeMethodOptions.IncludeAutomaticStepsInOutput if the steps that are chosen automatically should appear in the sequence of solution points.
- OdeMethodOptions.InitialStepSize determines the initial step size. If set to null, a reasonable guess of the initial step size will be done.
- OdeMethodOptions.StepSizeFilter determines the variations of the step size.
- OdeMethodOptions.MandatorySolutionPoints are points where the method is forced to have a solution point. At those points the evaluation of the derivative is forced.
- OdeMethodOptions.IncludeMandatorySolutionPointsInOutput determines if the mandatory solution points should appear in the output sequence (default: true).
- OdeMethodOptions.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:
- OdeMethodOptions.IncludeInitialValueInOutput determines whether the inital values for x and y should appear as first item in the output sequence.
- OdeMethodOptions.StepSize determines the fixed step size. Set this parameter to null if you only want to output OdeMethodOptions.MandatorySolutionPoints.
- OdeMethodOptions.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.
- OdeMethodOptions.OptionalSolutionPoints are points that are evaluated by interpolation between true solution points. Optional solution points always appear in the output sequence.
Constructors
| Constructor | Description |
Full Usage:
OdeMethodOptions()
|
|
Instance members
| Instance member | Description | ||
Full Usage:
this.AbsoluteTolerance
|
Gets or sets the absolute tolerance for all y-values. Use OdeMethodOptions.AbsoluteTolerances if you want to set the absolute tolerance for each individual y-value.
|
||
Full Usage:
this.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. |
||
Full Usage:
this.AutomaticStepSizeControl
|
Gets or sets a value indicating whether automatic step size control is switched on. |
||
Full Usage:
this.CheckConsistency
Modifiers: abstract |
Checks the consistency of the options. An InvalidOperationException is thrown if some of the parameters exclude each other. |
||
Full Usage:
this.ErrorNorm
|
Gets or sets the error norm that is used for the evaluation of the relative error, in order to control the step size. |
||
Full Usage:
this.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 OdeMethodOptions.AutomaticStepSizeControl is set to true. If OdeMethodOptions.AutomaticStepSizeControl is true, but this value is false, then OdeMethodOptions.MandatorySolutionPoints have to be set. |
||
Full Usage:
this.IncludeInitialValueInOutput
|
Gets or sets a value indicating whether the inital point should be included in the output. |
||
Full Usage:
this.IncludeMandatorySolutionPointsInOutput
|
Default: true. Gets or sets a value indicating whether the mandatory solution points (see OdeMethodOptions.MandatorySolutionPoints) should appear in the output sequence. This value is only effective if OdeMethodOptions.AutomaticStepSizeControl is true. Without automatic step size control, mandatory solution points always appear in the output sequence. |
||
Full Usage:
this.InitialStepSize
|
Gets or sets the initial step size. This value is effective only if OdeMethodOptions.AutomaticStepSizeControl is true. |
||
Full Usage:
this.MandatorySolutionPoints
|
Gets or sets the mandatory solution points. Mandatory solution points will be evaluated directly (i.e. not interpolated). |
||
Full Usage:
this.MaxStepSize
|
Gets or sets the maximum size of the step. This value is effective only if OdeMethodOptions.AutomaticStepSizeControl is true. |
||
Full Usage:
this.OptionalSolutionPoints
|
Gets or sets optional solution points. Optional solution points will be not evaluated directly, but interpolated between two real solution points. |
||
Full Usage:
this.RelativeTolerance
|
Gets or sets the relative tolerance for all y-values. Use OdeMethodOptions.RelativeTolerances if you want to set the relative tolerance for each individual y-value.
|
||
Full Usage:
this.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. |
||
Full Usage:
this.StepSize
|
Gets or sets the size of the step. This value is effective only if automatic step size control is not active. |
||
Full Usage:
this.StepSizeFilter
|
Set the step size filter (determines the variation of step sizes), see OdeMethodOptions.StepSizeFilter. |
||
Full Usage:
this.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. |