FieldOrekitFixedStepHandler.java

  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. import org.hipparchus.CalculusFieldElement;
  19. import org.orekit.propagation.FieldSpacecraftState;
  20. import org.orekit.time.FieldAbsoluteDate;

  21. /** This interface is a space-dynamics aware fixed size step handler.
  22.  *
  23.  * <p>It mirrors the <code>FixedStepHandler</code> interface from <a
  24.  * href="http://commons.apache.org/math/">commons-math</a> but provides
  25.  * a space-dynamics interface to the methods.</p>
  26.  * @author Luc Maisonobe
  27.  * @param <T> type of the field elements
  28.  */
  29. public interface FieldOrekitFixedStepHandler<T extends CalculusFieldElement<T>> {

  30.     /** Initialize step handler at the start of a propagation.
  31.      * <p>
  32.      * This method is called once at the start of the propagation. It
  33.      * may be used by the step handler to initialize some internal data
  34.      * if needed.
  35.      * </p>
  36.      * @param s0 initial state
  37.      * @param t target time for the integration
  38.      * @param step the duration in seconds of the fixed step. This value is
  39.      *             positive even if propagation is backwards.
  40.      */
  41.     default void init(FieldSpacecraftState<T> s0, FieldAbsoluteDate<T> t, T step) {
  42.         // do nothing by default
  43.     }

  44.     /** Handle the current step.
  45.      * @param currentState current state at step time
  46.      */
  47.     void handleStep(FieldSpacecraftState<T> currentState);

  48.     /**
  49.      * Finalize propagation.
  50.      * @param finalState state at propagation end
  51.      * @since 11.0
  52.      */
  53.     default void finish(FieldSpacecraftState<T> finalState) {
  54.         // nothing by default
  55.     }

  56. }