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.conversion;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.Field;
21  import org.hipparchus.ode.AbstractFieldIntegrator;
22  import org.orekit.orbits.FieldOrbit;
23  import org.orekit.orbits.Orbit;
24  import org.orekit.orbits.OrbitType;
25  
26  /**
27   * This interface is the top-level abstraction to build first order integrators for propagators conversion.
28   *
29   * @author Pascal Parraud
30   * @author Vincent Cucchietti
31   * @since 12.0
32   * @param <T> type of the field elements
33   */
34  public interface FieldODEIntegratorBuilder<T extends CalculusFieldElement<T>> {
35  
36      /**
37       * Build a first order integrator.
38       *
39       * @param field field to which the elements belong
40       * @param orbit reference orbit
41       * @param orbitType orbit type to use
42       *
43       * @return a first order integrator ready to use
44       */
45      AbstractFieldIntegrator<T> buildIntegrator(Field<T> field,
46                                                 Orbit orbit,
47                                                 OrbitType orbitType);
48  
49      /**
50       * Build a first order integrator.
51       *
52       * @param orbit reference orbit
53       * @param orbitType orbit type to use
54       *
55       * @return a first order integrator ready to use
56       */
57      AbstractFieldIntegrator<T> buildIntegrator(FieldOrbit<T> orbit,
58                                                 OrbitType orbitType);
59  }