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.control.indirect.adjoint.CartesianAdjointDerivativesProvider;
22  import org.orekit.control.indirect.adjoint.FieldCartesianAdjointDerivativesProvider;
23  
24  /**
25   * Abstract class for Cartesian adjoint derivatives provider.
26   *
27   * @author Romain Serra
28   * @see AdjointDynamicsProvider
29   * @since 12.2
30   */
31  public abstract class CartesianAdjointDynamicsProvider implements AdjointDynamicsProvider {
32  
33      /** Adjoint name. */
34      private final String adjointName;
35  
36      /** Adjoint dimension. */
37      private final int dimension;
38  
39      /**
40       * Constructor.
41       * @param adjointName adjoint name
42       * @param dimension adjoint dimension
43       */
44      protected CartesianAdjointDynamicsProvider(final String adjointName, final int dimension) {
45          this.adjointName = adjointName;
46          this.dimension = dimension;
47      }
48  
49      /** {@inheritDoc} */
50      @Override
51      public int getDimension() {
52          return dimension;
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      public String getAdjointName() {
58          return adjointName;
59      }
60  
61      /** {@inheritDoc} */
62      @Override
63      public abstract CartesianAdjointDerivativesProvider buildAdditionalDerivativesProvider();
64  
65      /** {@inheritDoc} */
66      @Override
67      public abstract <T extends CalculusFieldElement<T>> FieldCartesianAdjointDerivativesProvider<T> buildFieldAdditionalDerivativesProvider(Field<T> field);
68  }