Multi |
Options for multistep Ode methods.
Inheritance HierarchyNamespace: Altaxo.Calc.Ode
Assembly: AltaxoCore (in AltaxoCore.dll) Version: 4.8.3179.0 (4.8.3179.0)
SyntaxC#
public class MultiStepMethodOptions : OdeMethodOptions
The MultiStepMethodOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | MultiStepMethodOptions | Initializes a new instance of the MultiStepMethodOptions 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.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
| AutomaticStepSizeControl |
Gets or sets a value indicating whether automatic step size control is switched on.
(Inherited from OdeMethodOptions) |
| ErrorNorm |
Gets or sets the error norm that is used for
the evaluation of the relative error, in order to
control the step size.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
| IncludeInitialValueInOutput |
Gets or sets a value indicating whether the inital point should be included in the output.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
| InitialStepSize |
Gets or sets the initial step size. This value is effective only if AutomaticStepSizeControl is true.
(Inherited from OdeMethodOptions) |
| IterationMethod | Gets or sets the iteration method (see values of OdeIterationMethod for explanations). |
| MandatorySolutionPoints |
Gets or sets the mandatory solution points. Mandatory solution points will be evaluated directly (i.e. not interpolated).
(Inherited from OdeMethodOptions) |
| MaxOrder | Gets or sets the maximum order the method can use. |
| MaxStepSize |
Gets or sets the maximum size of the step. This value is effective only if AutomaticStepSizeControl is true.
(Inherited from OdeMethodOptions) |
| MinOrder | Gets or sets the minimum order the method can use (except in the startup phase, in which the method has to start with an order of 1). |
| OptionalSolutionPoints |
Gets or sets optional solution points. Optional solution points will be not evaluated directly, but interpolated between two real solution points.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
| StepSize |
Gets or sets the size of the step. This value is effective only if automatic step size control is not active.
(Inherited from OdeMethodOptions) |
| StepSizeFilter |
Set the step size filter (determines the variation of step sizes), see StepSizeFilter.
(Inherited from OdeMethodOptions) |
| 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.
(Inherited from OdeMethodOptions) |
Methods| Name | Description | |
|---|---|---|
| CheckConsistency |
Checks the consistency of the options. An InvalidOperationException is thrown if
some of the parameters exclude each other.
(Inherited from OdeMethodOptions) |
| 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) |
| 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| Name | Description | |
|---|---|---|
 | _stepSize | (Inherited from OdeMethodOptions) |
See Also