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.integration;
18  
19  import org.hipparchus.CalculusFieldElement;
20  
21  /** Container for additional derivatives.
22   * @see FieldAdditionalDerivativesProvider
23   * @author Luc Maisonobe
24   * @since 11.2
25   * @param <T> type of the field elements
26   */
27  public class FieldCombinedDerivatives<T extends CalculusFieldElement<T>> {
28  
29      /** Additional state derivatives. */
30      private T[] additionalDerivatives;
31  
32      /** Primary state derivatives increments (may be null). */
33      private final T[] mainStateDerivativesIncrements;
34  
35      /** Simple constructor.
36       * @param additionalDerivatives additional state derivatives
37       * @param mainStateDerivativesIncrements increments related to the main state parameters
38       * (may be null if main state should not be incremented)
39       */
40      public FieldCombinedDerivatives(final T[] additionalDerivatives,
41                                      final T[] mainStateDerivativesIncrements) {
42          this.mainStateDerivativesIncrements = mainStateDerivativesIncrements == null ?
43                                                null : mainStateDerivativesIncrements.clone();
44          this.additionalDerivatives          = additionalDerivatives.clone();
45      }
46  
47      /** Get the derivatives increments related to the main state.
48       * @return primary state derivatives increments, or null if
49       * main state should not be incremented
50       */
51      public T[] getMainStateDerivativesIncrements() {
52          return mainStateDerivativesIncrements == null ?
53                 null : mainStateDerivativesIncrements.clone();
54      }
55  
56      /** Get the derivatives related to the additional state.
57       * @return additional state derivatives
58       */
59      public T[] getAdditionalDerivatives() {
60          return additionalDerivatives.clone();
61      }
62  
63  }