Click or drag to resize

Core Methods

The GearsBDFWithNordsieckStateCore type exposes the following members.

Methods
 NameDescription
Public methodAdjustStepSizeAndOrder Compares the errors at the current order q, at order (q-1) and at order (q+1), using the proposed step sizes at these orders. The order which maximizes the step size is then chosen, and the step size is adjusted accordingly.
Public methodCalculate_En_Q Calculates the relative error En for the current order q. See eq. 2.41 in [1].
Public methodCalculate_En_QMinus1 Calculates the relative error En(q-1) for the next lower order (q-1).
Public methodCalculate_En_QPlus1 Calculates the relative error En(q+1) for the next higher order (q+1).
Public methodCalculateOnePlusProducts_tn Calculates the product of the differences of previous x (the term in square brackets in eqs. 2.40, 2.41 and 2.44 in Byrne and Hindmarsh [1]).
Public methodChangeStepSize Changes the size to a new value.
Public methodComputeCoefficients_L Computes the coefficients l. l is used to update the Nordsieck vector if the error vector is known: z_n = z_n0 + e_n * l with e_n = y_n - y_n0.
Public methodCorrect Corrects the Nordsieck array using the corrected y values and the l array. See eq. 2.19 in [1].
Public methodDecreaseOrderBy1 Decreases the order by 1. This method scales the Nordsieck array by the polynomial coefficients of eq. 2.49 in Byrne and Hindmarsh [1].
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodEvaluateNextSolutionPoint Evaluates the next solution point.
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetInitialStepSize Gets the initial step size. The absolute and relative tolerances must be set before the call to this function.
Public methodGetInterpolatedY_volatile Gets interpolated y values. The independent variable x must lie inbetween the x of the previous step and the current step.
Public methodGetProposedStepSizeFactorClamped Gets the proposed step size factor (clamped). This clamped version should be used for step size control. For comparison of the errors of order q-1, q, and q+1, use the unclamped version.
Public methodGetProposedStepSizeFactorUnclamped Gets the proposed step size factor (unclamped). This unclamped version should only be used for comparison of the errors of order q-1, q, and q+1. Use the clamped version for step size control.
Public methodGetRelativeError_InfinityNorm Gets the relative error (Infinity norm) from the absolute errors. The absolute errors are given by en - Qn * enm1.
Public methodGetRelativeError_L2Norm Gets the relative error (L2 norm) from the absolute errors. The absolute errors are given by en - Qn * enm1.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIncreaseOrderBy1 Increases the order by 1. It is ensured that the Nordsieck state can accomodate the new derivative. The new derivative itself is set to zero. See the notes below eq. 2.49 in Byrne and Hindmarsh [1].
Public methodIterationUsingFunctionalIteration Does some iteration steps. This iteration method does not use the Jacobian for Newton-Raphson steps, instead a functional iteration is executed. This takes much longer to reach the same degree of accuracy. At the end, the corrected y-values are stored in _aux1.
Public methodIterationUsingJacobian Does some iteration steps. At the end, the corrected y-values are stored in _aux1.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOptimizeStepSizeForNextMandatoryPoint Optimizes the step size, in a way that the next mandatory solution point will be reached without too big or too small step sizes.
Public methodPredict Calculates a first guess of the new Nordsieck state from the old state, and advances the _x array to the new point.
Public methodRestoreNordsieckState Restores the Nordsieck state ( copies back from _nordsieckArray_Saved to _nordsieckArray, restores _nordsieckArray_h, and also restores the history of x values in _x.
Public methodSaveNordsieckState Saves the Nordsieck state (makes a copy from _nordsieckArray to _nordsieckArray_h_Saved), and saves the value of the step size in _nordsieckArray_h_Saved).
Public methodScaleStepSize Scales the step size by a factor.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
See Also