1   /* Copyright 2022-2026 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.orbits;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.Field;
21  
22  /**
23   * Data container for Keplerian orbital elements (Field version).
24   * @param a semi-major axis
25   * @param e eccentricity
26   * @param i inclination
27   * @param pa position angle
28   * @param raan right ascension of ascending node
29   * @param anomaly anomaly corresponding to angle type
30   * @param positionAngleType angle type
31   * @param <T> type of the field element
32   * @author Romain Serra
33   * @see KeplerianParameters
34   * @see PositionAngleType
35   * @since 14.0
36   */
37  public record FieldKeplerianParameters<T extends CalculusFieldElement<T>>(T a, T e, T i, T pa, T raan, T anomaly,
38                                                                            PositionAngleType positionAngleType) {
39  
40      /**
41       * Constructor from non-Field.
42       * @param field field
43       * @param elements Keplerian elements
44       */
45      public FieldKeplerianParameters(final Field<T> field, final KeplerianParameters elements) {
46          this(field.getZero().newInstance(elements.a()), field.getZero().newInstance(elements.e()),
47                  field.getZero().newInstance(elements.i()), field.getZero().newInstance(elements.pa()),
48                  field.getZero().newInstance(elements.raan()), field.getZero().newInstance(elements.anomaly()),
49                  elements.positionAngleType());
50      }
51  
52      /**
53       * Builds a new instance with the specified position angle type.
54       * @param angleType angle type for the output
55       * @return Keplerian elements with the specified position angle type
56       */
57      public FieldKeplerianParameters<T> withPositionAngleType(final PositionAngleType angleType) {
58          final T convertedAnomaly = FieldKeplerianAnomalyUtility.convertAnomaly(positionAngleType, anomaly, e, angleType);
59          return new FieldKeplerianParameters<>(a, e, i, pa, raan, convertedAnomaly, angleType);
60      }
61  
62      /**
63       * Convert Field elements to non-Field ones.
64       * @return Keplerian elements
65       */
66      public KeplerianParameters toKeplerianElements() {
67          return new KeplerianParameters(a.getReal(), e.getReal(), i.getReal(), pa.getReal(), raan.getReal(),
68                  anomaly.getReal(), positionAngleType);
69      }
70  }