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.analytical;
18  
19  import org.hipparchus.linear.RealMatrix;
20  import org.orekit.orbits.PositionAngleType;
21  import org.orekit.utils.DoubleArrayDictionary;
22  
23  /**
24   * Harvester between two-dimensional Jacobian matrices and
25   * one-dimensional {@link EcksteinHechlerPropagator}.
26   *
27   * @author Bryan Cazabonne
28   * @since 11.1
29   */
30  class EcksteinHechlerHarvester extends AbstractAnalyticalMatricesHarvester {
31  
32      /** Propagator bound to this harvester. */
33      private final EcksteinHechlerPropagator propagator;
34  
35      /** Simple constructor.
36       * <p>
37       * The arguments for initial matrices <em>must</em> be compatible with the
38       * {@link org.orekit.orbits.OrbitType orbit type}
39       * and {@link PositionAngleType position angle} that will be used by propagator
40       * </p>
41       * @param propagator propagator bound to this harvester
42       * @param stmName State Transition Matrix state name
43       * @param initialStm initial State Transition Matrix ∂Y/∂Y₀,
44       * if null (which is the most frequent case), assumed to be 6x6 identity
45       * @param initialJacobianColumns initial columns of the Jacobians matrix with respect to parameters,
46       * if null or if some selected parameters are missing from the dictionary, the corresponding
47       * initial column is assumed to be 0
48       */
49      EcksteinHechlerHarvester(final EcksteinHechlerPropagator propagator, final String stmName,
50                               final RealMatrix initialStm, final DoubleArrayDictionary initialJacobianColumns) {
51          super(propagator, stmName, initialStm, initialJacobianColumns);
52          this.propagator = propagator;
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      public AbstractAnalyticalGradientConverter getGradientConverter() {
58          return new EcksteinHechlerGradientConverter(propagator);
59      }
60  
61  }