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.boundary;
18  
19  import org.hipparchus.util.FastMath;
20  import org.orekit.control.indirect.shooting.AbstractFixedBoundaryCartesianSingleShooting;
21  import org.orekit.utils.PVCoordinates;
22  
23  /**
24   * Class defining convergence criterion on the norm of relative position and velocity vectors, with absolute tolerances.
25   *
26   * @author Romain Serra
27   * @since 12.2
28   * @see AbstractFixedBoundaryCartesianSingleShooting
29   */
30  public class NormBasedCartesianConditionChecker implements CartesianBoundaryConditionChecker {
31  
32      /** Maximum iteration count. */
33      private final int maximumIterationCount;
34  
35      /** Absolute tolerance when checking relative position norm. */
36      private final double absoluteToleranceDistance;
37  
38      /** Absolute tolerance when checking relative velocity norm. */
39      private final double absoluteToleranceSpeed;
40  
41      /**
42       * Constructor.
43       * @param maximumIterationCount maximum iteration count
44       * @param absoluteToleranceDistance absolute tolerance on distance
45       * @param absoluteToleranceSpeed absolute tolerance on speed
46       */
47      public NormBasedCartesianConditionChecker(final int maximumIterationCount,
48                                                final double absoluteToleranceDistance,
49                                                final double absoluteToleranceSpeed) {
50          this.maximumIterationCount = maximumIterationCount;
51          this.absoluteToleranceDistance = FastMath.abs(absoluteToleranceDistance);
52          this.absoluteToleranceSpeed = FastMath.abs(absoluteToleranceSpeed);
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      public int getMaximumIterationCount() {
58          return maximumIterationCount;
59      }
60  
61      /** {@inheritDoc} */
62      @Override
63      public boolean isConverged(final PVCoordinates targetPV, final PVCoordinates actualPV) {
64          return targetPV.getPosition().subtract(actualPV.getPosition()).getNorm() < absoluteToleranceDistance &&
65                  targetPV.getVelocity().subtract(actualPV.getVelocity()).getNorm() < absoluteToleranceSpeed;
66      }
67  
68  }