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.Orbit;
23  import org.orekit.orbits.OrbitType;
24  
25  /**
26   * Abstract class for integrator builder using variable step size.
27   *
28   * @param <T> type of the field elements
29   *
30   * @author Vincent Cucchietti
31   */
32  public abstract class AbstractVariableStepFieldIntegratorBuilder<T extends CalculusFieldElement<T>>
33          extends AbstractFieldIntegratorBuilder<T> {
34  
35      // CHECKSTYLE: stop VisibilityModifier check
36      /** Minimum step size (s). */
37      protected final double minStep;
38  
39      /** Maximum step size (s). */
40      protected final double maxStep;
41  
42      /** Position error (m). */
43      protected final double dP;
44      // CHECKSTYLE: resume VisibilityModifier check
45  
46      /**
47       * Constructor.
48       *
49       * @param minStep minimum step size (s)
50       * @param maxStep maximum step size (s)
51       * @param dP position error (m)
52       */
53      AbstractVariableStepFieldIntegratorBuilder(final double minStep, final double maxStep, final double dP) {
54          this.minStep = minStep;
55          this.maxStep = maxStep;
56          this.dP      = dP;
57      }
58  
59      /** {@inheritDoc} */
60      @Override
61      public abstract AbstractFieldIntegrator<T> buildIntegrator(Field<T> field, Orbit orbit, OrbitType orbitType);
62  }