1   /* Copyright 2022-2025 Romain Serra
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.control.indirect.shooting.propagation;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.Field;
21  import org.orekit.propagation.ToleranceProvider;
22  import org.orekit.propagation.conversion.ClassicalRungeKuttaFieldIntegratorBuilder;
23  import org.orekit.propagation.conversion.DormandPrince54FieldIntegratorBuilder;
24  import org.orekit.propagation.conversion.DormandPrince853FieldIntegratorBuilder;
25  import org.orekit.propagation.conversion.FieldExplicitRungeKuttaIntegratorBuilder;
26  import org.orekit.propagation.conversion.LutherFieldIntegratorBuilder;
27  import org.orekit.propagation.conversion.MidpointFieldIntegratorBuilder;
28  
29  /**
30   * Factory for some common schemes.
31   *
32   * @author Romain Serra
33   * @since 13.0
34   * @see ShootingPropagationSettings
35   */
36  public class ShootingIntegrationSettingsFactory {
37  
38      /**
39       * Private constructor.
40       */
41      private ShootingIntegrationSettingsFactory() {
42          // factory class
43      }
44  
45      /**
46       * Returns shooting integration settings according to the midpoint Runge Kutta scheme.
47       * @param step default step-size
48       * @return integration settings
49       */
50      public static ShootingIntegrationSettings getMidpointIntegratorSettings(final double step) {
51          return new ShootingIntegrationSettings() {
52              @Override
53              public <T extends CalculusFieldElement<T>> FieldExplicitRungeKuttaIntegratorBuilder<T> getFieldIntegratorBuilder(final Field<T> field) {
54                  return new MidpointFieldIntegratorBuilder<>(field.getZero().newInstance(step));
55              }
56          };
57      }
58  
59      /**
60       * Returns shooting integration settings according to the classical Runge Kutta scheme.
61       * @param step default step-size
62       * @return integration settings
63       */
64      public static ShootingIntegrationSettings getClassicalRungeKuttaIntegratorSettings(final double step) {
65          return new ShootingIntegrationSettings() {
66              @Override
67              public <T extends CalculusFieldElement<T>> FieldExplicitRungeKuttaIntegratorBuilder<T> getFieldIntegratorBuilder(final Field<T> field) {
68                  return new ClassicalRungeKuttaFieldIntegratorBuilder<>(field.getZero().newInstance(step));
69              }
70          };
71      }
72  
73      /**
74       * Returns shooting integration settings according to the Luther Runge Kutta scheme.
75       * @param step default step-size
76       * @return integration settings
77       */
78      public static ShootingIntegrationSettings getLutherIntegratorSettings(final double step) {
79          return new ShootingIntegrationSettings() {
80              @Override
81              public <T extends CalculusFieldElement<T>> FieldExplicitRungeKuttaIntegratorBuilder<T> getFieldIntegratorBuilder(final Field<T> field) {
82                  return new LutherFieldIntegratorBuilder<>(field.getZero().newInstance(step));
83              }
84          };
85      }
86  
87      /**
88       * Returns shooting integration settings according to the Dormand Prince 5(4) scheme.
89       * @param minStep minimum step-size
90       * @param maxStep maximum step-size
91       * @param toleranceProvider tolerance provider
92       * @return integration settings
93       */
94      public static ShootingIntegrationSettings getDormandPrince54IntegratorSettings(final double minStep,
95                                                                                     final double maxStep,
96                                                                                     final ToleranceProvider toleranceProvider) {
97          return new ShootingIntegrationSettings() {
98              @Override
99              public <T extends CalculusFieldElement<T>> FieldExplicitRungeKuttaIntegratorBuilder<T> getFieldIntegratorBuilder(final Field<T> field) {
100                 return new DormandPrince54FieldIntegratorBuilder<>(minStep, maxStep, toleranceProvider);
101             }
102         };
103     }
104 
105     /**
106      * Returns shooting integration settings according to the Dormand Prince 8(53) scheme.
107      * @param minStep minimum step-size
108      * @param maxStep maximum step-size
109      * @param toleranceProvider tolerance provider
110      * @return integration settings
111      */
112     public static ShootingIntegrationSettings getDormandPrince853IntegratorSettings(final double minStep,
113                                                                                     final double maxStep,
114                                                                                     final ToleranceProvider toleranceProvider) {
115         return new ShootingIntegrationSettings() {
116             @Override
117             public <T extends CalculusFieldElement<T>> FieldExplicitRungeKuttaIntegratorBuilder<T> getFieldIntegratorBuilder(final Field<T> field) {
118                 return new DormandPrince853FieldIntegratorBuilder<>(minStep, maxStep, toleranceProvider);
119             }
120         };
121     }
122 }