1   /* Copyright 2002-2025 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.conversion;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.Field;
21  import org.hipparchus.ode.FieldODEIntegrator;
22  import org.orekit.orbits.FieldOrbit;
23  import org.orekit.orbits.Orbit;
24  import org.orekit.orbits.OrbitType;
25  import org.orekit.orbits.PositionAngleType;
26  import org.orekit.utils.FieldAbsolutePVCoordinates;
27  
28  /**
29   * This interface is the top-level abstraction to build first order integrators for propagators conversion.
30   *
31   * @author Pascal Parraud
32   * @author Vincent Cucchietti
33   * @since 12.0
34   * @param <T> type of the field elements
35   */
36  public interface FieldODEIntegratorBuilder<T extends CalculusFieldElement<T>> {
37  
38      /**
39       * Build a first order integrator.
40       *
41       * @param field field to which the elements belong
42       * @param orbit reference orbit
43       * @param orbitType orbit type to use
44       *
45       * @return a first order integrator ready to use
46       */
47      FieldODEIntegrator<T> buildIntegrator(Field<T> field, Orbit orbit, OrbitType orbitType);
48  
49      /**
50       * Build a first order integrator.
51       *
52       * @param field field
53       * @param orbit reference orbit
54       * @param orbitType orbit type to use
55       * @param angleType position angle type to use
56       *
57       * @return a first order integrator ready to use
58       * @since 13.0
59       */
60      FieldODEIntegrator<T> buildIntegrator(Field<T> field, Orbit orbit, OrbitType orbitType,
61                                            PositionAngleType angleType);
62  
63      /**
64       * Build a first order integrator.
65       *
66       * @param orbit reference orbit
67       * @param orbitType orbit type to use
68       *
69       * @return a first order integrator ready to use
70       */
71      FieldODEIntegrator<T> buildIntegrator(FieldOrbit<T> orbit, OrbitType orbitType);
72  
73      /**
74       * Build a first order integrator. Non-orbit version.
75       *
76       * @param fieldAbsolutePVCoordinates absolute position-velocity
77       *
78       * @return a first order integrator ready to use
79       * @since 12.2
80       */
81      FieldODEIntegrator<T> buildIntegrator(FieldAbsolutePVCoordinates<T> fieldAbsolutePVCoordinates);
82  
83      /**
84       * Form a non-Field equivalent.
85       * @return ODE integrator builder
86       * @since 13.0
87       */
88      ODEIntegratorBuilder toODEIntegratorBuilder();
89  }