Class FieldStepNormalizer<T extends RealFieldElement<T>>
- java.lang.Object
-
- org.apache.commons.math4.legacy.ode.sampling.FieldStepNormalizer<T>
-
- Type Parameters:
T- the type of the field elements
- All Implemented Interfaces:
FieldStepHandler<T>
public class FieldStepNormalizer<T extends RealFieldElement<T>> extends Object implements FieldStepHandler<T>
This class wraps an object implementingFieldFixedStepHandlerinto aFieldStepHandler.This wrapper allows to use fixed step handlers with general integrators which cannot guaranty their integration steps will remain constant and therefore only accept general step handlers.
The stepsize used is selected at construction time. The
handleStepmethod of the underlyingFieldFixedStepHandlerobject is called at normalized times. The normalized times can be influenced by theStepNormalizerModeandStepNormalizerBounds.There is no constraint on the integrator, it can use any time step it needs (time steps longer or shorter than the fixed time step and non-integer ratios are all allowed).
Examples (step size = 0.5) Examples (step size = 0.5) Start time End time Direction ModeBoundsOutput 0.3 3.1 forward INCREMENTNEITHER0.8, 1.3, 1.8, 2.3, 2.8 0.3 3.1 forward INCREMENTFIRST0.3, 0.8, 1.3, 1.8, 2.3, 2.8 0.3 3.1 forward INCREMENTLAST0.8, 1.3, 1.8, 2.3, 2.8, 3.1 0.3 3.1 forward INCREMENTBOTH0.3, 0.8, 1.3, 1.8, 2.3, 2.8, 3.1 0.3 3.1 forward MULTIPLESNEITHER0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.3 3.1 forward MULTIPLESFIRST0.3, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.3 3.1 forward MULTIPLESLAST0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.1 0.3 3.1 forward MULTIPLESBOTH0.3, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0, 3.1 0.0 3.0 forward INCREMENTNEITHER0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward INCREMENTFIRST0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward INCREMENTLAST0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward INCREMENTBOTH0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward MULTIPLESNEITHER0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward MULTIPLESFIRST0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward MULTIPLESLAST0.5, 1.0, 1.5, 2.0, 2.5, 3.0 0.0 3.0 forward MULTIPLESBOTH0.0, 0.5, 1.0, 1.5, 2.0, 2.5, 3.0 3.1 0.3 backward INCREMENTNEITHER2.6, 2.1, 1.6, 1.1, 0.6 3.1 0.3 backward INCREMENTFIRST3.1, 2.6, 2.1, 1.6, 1.1, 0.6 3.1 0.3 backward INCREMENTLAST2.6, 2.1, 1.6, 1.1, 0.6, 0.3 3.1 0.3 backward INCREMENTBOTH3.1, 2.6, 2.1, 1.6, 1.1, 0.6, 0.3 3.1 0.3 backward MULTIPLESNEITHER3.0, 2.5, 2.0, 1.5, 1.0, 0.5 3.1 0.3 backward MULTIPLESFIRST3.1, 3.0, 2.5, 2.0, 1.5, 1.0, 0.5 3.1 0.3 backward MULTIPLESLAST3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.3 3.1 0.3 backward MULTIPLESBOTH3.1, 3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.3 3.0 0.0 backward INCREMENTNEITHER2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward INCREMENTFIRST3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward INCREMENTLAST2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward INCREMENTBOTH3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward MULTIPLESNEITHER2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward MULTIPLESFIRST3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward MULTIPLESLAST2.5, 2.0, 1.5, 1.0, 0.5, 0.0 3.0 0.0 backward MULTIPLESBOTH3.0, 2.5, 2.0, 1.5, 1.0, 0.5, 0.0 - Since:
- 3.6
- See Also:
FieldStepHandler,FieldFixedStepHandler,StepNormalizerMode,StepNormalizerBounds
-
-
Constructor Summary
Constructors Constructor Description FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler)Simple constructor.FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerBounds bounds)Simple constructor.FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerMode mode)Simple constructor.FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerMode mode, StepNormalizerBounds bounds)Simple constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidhandleStep(FieldStepInterpolator<T> interpolator, boolean isLast)Handle the last accepted step.voidinit(FieldODEStateAndDerivative<T> initialState, T finalTime)Initialize step handler at the start of an ODE integration.
-
-
-
Constructor Detail
-
FieldStepNormalizer
public FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler)
- Parameters:
h- fixed time step (sign is not used)handler- fixed time step handler to wrap
-
FieldStepNormalizer
public FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerMode mode)
Simple constructor. UsesFIRSTbounds setting.- Parameters:
h- fixed time step (sign is not used)handler- fixed time step handler to wrapmode- step normalizer mode to use- Since:
- 3.0
-
FieldStepNormalizer
public FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerBounds bounds)
Simple constructor. UsesINCREMENTmode.- Parameters:
h- fixed time step (sign is not used)handler- fixed time step handler to wrapbounds- step normalizer bounds setting to use- Since:
- 3.0
-
FieldStepNormalizer
public FieldStepNormalizer(double h, FieldFixedStepHandler<T> handler, StepNormalizerMode mode, StepNormalizerBounds bounds)
Simple constructor.- Parameters:
h- fixed time step (sign is not used)handler- fixed time step handler to wrapmode- step normalizer mode to usebounds- step normalizer bounds setting to use- Since:
- 3.0
-
-
Method Detail
-
init
public void init(FieldODEStateAndDerivative<T> initialState, T finalTime)
Initialize step handler at the start of an ODE integration.This method is called once at the start of the integration. It may be used by the step handler to initialize some internal data if needed.
- Specified by:
initin interfaceFieldStepHandler<T extends RealFieldElement<T>>- Parameters:
initialState- initial time, state vector and derivativefinalTime- target time for the integration
-
handleStep
public void handleStep(FieldStepInterpolator<T> interpolator, boolean isLast) throws MaxCountExceededException
Handle the last accepted step.- Specified by:
handleStepin interfaceFieldStepHandler<T extends RealFieldElement<T>>- Parameters:
interpolator- interpolator for the last accepted step. For efficiency purposes, the various integrators reuse the same object on each call, so if the instance wants to keep it across all calls (for example to provide at the end of the integration a continuous model valid throughout the integration range), it should build a local copy using the clone method and store this copy.isLast- true if the step is the last one- Throws:
MaxCountExceededException- if the interpolator throws one because the number of functions evaluations is exceeded
-
-