BrouwerLyddaneHarvester.java

  1. /* Copyright 2002-2022 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. import org.hipparchus.linear.RealMatrix;
  19. import org.orekit.utils.DoubleArrayDictionary;

  20. /**
  21.  * Harvester between two-dimensional Jacobian matrices and
  22.  * one-dimensional {@link BrouwerLyddanePropagator}.
  23.  *
  24.  * @author Bryan Cazabonne
  25.  * @since 11.1
  26.  */
  27. class BrouwerLyddaneHarvester extends AbstractAnalyticalMatricesHarvester {

  28.     /** Propagator bound to this harvester. */
  29.     private final BrouwerLyddanePropagator propagator;

  30.     /** Simple constructor.
  31.      * <p>
  32.      * The arguments for initial matrices <em>must</em> be compatible with the
  33.      * {@link org.orekit.orbits.OrbitType orbit type}
  34.      * and {@link org.orekit.orbits.PositionAngle position angle} that will be used by propagator
  35.      * </p>
  36.      * @param propagator propagator bound to this harvester
  37.      * @param stmName State Transition Matrix state name
  38.      * @param initialStm initial State Transition Matrix ∂Y/∂Y₀,
  39.      * if null (which is the most frequent case), assumed to be 6x6 identity
  40.      * @param initialJacobianColumns initial columns of the Jacobians matrix with respect to parameters,
  41.      * if null or if some selected parameters are missing from the dictionary, the corresponding
  42.      * initial column is assumed to be 0
  43.      */
  44.     BrouwerLyddaneHarvester(final BrouwerLyddanePropagator propagator, final String stmName,
  45.                             final RealMatrix initialStm, final DoubleArrayDictionary initialJacobianColumns) {
  46.         super(propagator, stmName, initialStm, initialJacobianColumns);
  47.         this.propagator = propagator;
  48.     }

  49.     /** {@inheritDoc} */
  50.     @Override
  51.     public AbstractAnalyticalGradientConverter getGradientConverter() {
  52.         return new BrouwerLyddaneGradientConverter(propagator);
  53.     }

  54. }