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.numerical;
18
19 import java.util.List;
20
21 import org.hipparchus.linear.RealMatrix;
22 import org.orekit.orbits.Orbit;
23 import org.orekit.orbits.OrbitType;
24 import org.orekit.orbits.PositionAngleType;
25 import org.orekit.propagation.AbstractMatricesHarvester;
26 import org.orekit.propagation.SpacecraftState;
27 import org.orekit.utils.DoubleArrayDictionary;
28
29 /** Harvester between two-dimensional Jacobian matrices and one-dimensional {@link
30 * SpacecraftState#getAdditionalState(String) additional state arrays}.
31 * @author Luc Maisonobe
32 * @since 11.1
33 */
34 class NumericalPropagationHarvester extends AbstractMatricesHarvester {
35
36 /** Propagator bound to this harvester. */
37 private final NumericalPropagator propagator;
38
39 /** Columns names for parameters. */
40 private List<String> columnsNames;
41
42 /** Simple constructor.
43 * <p>
44 * The arguments for initial matrices <em>must</em> be compatible with the {@link org.orekit.orbits.OrbitType orbit type}
45 * and {@link PositionAngleType position angle} that will be used by propagator
46 * </p>
47 * @param propagator propagator bound to this harvester
48 * @param stmName State Transition Matrix state name
49 * @param initialStm initial State Transition Matrix ∂Y/∂Y₀,
50 * if null (which is the most frequent case), assumed to be 6x6 identity
51 * @param initialJacobianColumns initial columns of the Jacobians matrix with respect to parameters,
52 * if null or if some selected parameters are missing from the dictionary, the corresponding
53 * initial column is assumed to be 0
54 */
55 NumericalPropagationHarvester(final NumericalPropagator propagator, final String stmName,
56 final RealMatrix initialStm, final DoubleArrayDictionary initialJacobianColumns) {
57 super(stmName, initialStm, initialJacobianColumns);
58 this.propagator = propagator;
59 this.columnsNames = null;
60 }
61
62 /** {@inheritDoc} */
63 @Override
64 protected double[][] getConversionJacobian(final SpacecraftState state) {
65
66 final double[][] dYdC = new double[STATE_DIMENSION][STATE_DIMENSION];
67
68 if (state.isOrbitDefined()) {
69 // make sure the state is in the desired orbit type
70 final Orbit orbit = propagator.getOrbitType().convertType(state.getOrbit());
71
72 // compute the Jacobian, taking the position angle type into account
73 orbit.getJacobianWrtCartesian(propagator.getPositionAngleType(), dYdC);
74 } else {
75 // for absolute PVA, parameters are already Cartesian
76 for (int i = 0; i < STATE_DIMENSION; ++i) {
77 dYdC[i][i] = 1.0;
78 }
79 }
80
81 return dYdC;
82
83 }
84
85 /** {@inheritDoc} */
86 @Override
87 public void freezeColumnsNames() {
88 columnsNames = getJacobiansColumnsNames();
89 }
90
91 /** {@inheritDoc} */
92 @Override
93 public List<String> getJacobiansColumnsNames() {
94 return columnsNames == null ? propagator.getJacobiansColumnsNames() : columnsNames;
95 }
96
97 /** {@inheritDoc} */
98 @Override
99 public OrbitType getOrbitType() {
100 return propagator.getOrbitType();
101 }
102
103 /** {@inheritDoc} */
104 @Override
105 public PositionAngleType getPositionAngleType() {
106 return propagator.getPositionAngleType();
107 }
108
109 }