FieldOrekitFixedStepHandler.java
- /* Copyright 2002-2024 CS GROUP
- * Licensed to CS GROUP (CS) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * CS licenses this file to You under the Apache License, Version 2.0
- * (the "License"); you may not use this file except in compliance with
- * the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
- package org.orekit.propagation.sampling;
- import org.hipparchus.CalculusFieldElement;
- import org.orekit.propagation.FieldSpacecraftState;
- import org.orekit.time.FieldAbsoluteDate;
- /** This interface is a space-dynamics aware fixed size step handler.
- *
- * <p>It mirrors the <code>FixedStepHandler</code> interface from <a
- * href="http://commons.apache.org/math/">commons-math</a> but provides
- * a space-dynamics interface to the methods.</p>
- * @author Luc Maisonobe
- * @param <T> type of the field elements
- */
- public interface FieldOrekitFixedStepHandler<T extends CalculusFieldElement<T>> {
- /** Initialize step handler at the start of a propagation.
- * <p>
- * This method is called once at the start of the propagation. It
- * may be used by the step handler to initialize some internal data
- * if needed.
- * </p>
- * @param s0 initial state
- * @param t target time for the integration
- * @param step the duration in seconds of the fixed step. This value is
- * positive even if propagation is backwards.
- */
- default void init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t, T step) {
- // do nothing by default
- }
- /** Handle the current step.
- * @param currentState current state at step time
- */
- void handleStep(FieldSpacecraftState<T> currentState);
- /**
- * Finalize propagation.
- * @param finalState state at propagation end
- * @since 11.0
- */
- default void finish(FieldSpacecraftState<T> finalState) {
- // nothing by default
- }
- }