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.propagation.integration.AdditionalDerivativesProvider;
22  import org.orekit.propagation.integration.FieldAdditionalDerivativesProvider;
23  
24  /**
25   * Interface for adjoint derivatives provider (both standard and Field).
26   *
27   * @author Romain Serra
28   * @since 12.2
29   */
30  public interface AdjointDynamicsProvider {
31  
32      /**
33       * Getter for adjoint vector name.
34       * @return name
35       */
36      String getAdjointName();
37  
38      /**
39       * Getter for adjoint dimension.
40       * @return dimension
41       */
42      int getDimension();
43  
44      /**
45       * Builds adjoint derivatives provider.
46       * @return derivatives provider
47       */
48      AdditionalDerivativesProvider buildAdditionalDerivativesProvider();
49  
50      /**
51       * Builds Field adjoint derivatives provider.
52       * @param <T> field type
53       * @param field input field
54       * @return derivatives provider
55       */
56      <T extends CalculusFieldElement<T>> FieldAdditionalDerivativesProvider<T> buildFieldAdditionalDerivativesProvider(Field<T> field);
57  }