1   /* Copyright 2002-2024 CS GROUP
2    * Licensed to CS GROUP (CS) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * CS licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *   http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.orekit.propagation.sampling;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.propagation.FieldSpacecraftState;
21  import org.orekit.time.FieldAbsoluteDate;
22  
23  /** This interface is a space-dynamics aware fixed size step handler.
24   *
25   * <p>It mirrors the <code>FixedStepHandler</code> interface from <a
26   * href="http://commons.apache.org/math/">commons-math</a> but provides
27   * a space-dynamics interface to the methods.</p>
28   * @author Luc Maisonobe
29   * @param <T> type of the field elements
30   */
31  public interface FieldOrekitFixedStepHandler<T extends CalculusFieldElement<T>> {
32  
33      /** Initialize step handler at the start of a propagation.
34       * <p>
35       * This method is called once at the start of the propagation. It
36       * may be used by the step handler to initialize some internal data
37       * if needed.
38       * </p>
39       * @param s0 initial state
40       * @param t target time for the integration
41       * @param step the duration in seconds of the fixed step. This value is
42       *             positive even if propagation is backwards.
43       */
44      default void init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t, T step) {
45          // do nothing by default
46      }
47  
48      /** Handle the current step.
49       * @param currentState current state at step time
50       */
51      void handleStep(FieldSpacecraftState<T> currentState);
52  
53      /**
54       * Finalize propagation.
55       * @param finalState state at propagation end
56       * @since 11.0
57       */
58      default void finish(FieldSpacecraftState<T> finalState) {
59          // nothing by default
60      }
61  
62  }