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 circular orbital elements (Field version).
24   * @param <T> type of the field elements
25   * @param a semi-major axis
26   * @param ex first component of the eccentricity vector
27   * @param ey second component of the eccentricity vector
28   * @param i inclination
29   * @param raan right ascension of ascending node
30   * @param latitudeArgument argument of latitude corresponding to angle type
31   * @param positionAngleType angle type
32   * @author Romain Serra
33   * @see PositionAngleType
34   * @see CircularParameters
35   * @since 14.0
36   */
37  public record FieldCircularParameters<T extends CalculusFieldElement<T>>(T a, T ex, T ey, T i, T raan, T latitudeArgument,
38                                                                           PositionAngleType positionAngleType) {
39  
40      /**
41       * Constructor from non-Field.
42       * @param field field
43       * @param elements circular elements
44       */
45      public FieldCircularParameters(final Field<T> field, final CircularParameters elements) {
46          this(field.getZero().newInstance(elements.a()), field.getZero().newInstance(elements.ex()),
47                  field.getZero().newInstance(elements.ey()), field.getZero().newInstance(elements.i()),
48                  field.getZero().newInstance(elements.raan()), field.getZero().newInstance(elements.latitudeArgument()),
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 circular elements with the specified position angle type
56       */
57      public FieldCircularParameters<T> withPositionAngleType(final PositionAngleType angleType) {
58          final T convertedAnomaly = FieldCircularLatitudeArgumentUtility.convertAlpha(positionAngleType, latitudeArgument,
59                  ex, ey, angleType);
60          return new FieldCircularParameters<>(a, ex, ey, i, raan, convertedAnomaly, angleType);
61      }
62  
63      /**
64       * Convert Field elements to non-Field ones.
65       * @return circular elements
66       */
67      public CircularParameters toCircularElements() {
68          return new CircularParameters(a.getReal(), ex.getReal(), ey.getReal(), i.getReal(), raan.getReal(),
69                  latitudeArgument.getReal(), positionAngleType);
70      }
71  }