Fieldifier.java

  1. /* Copyright 2002-2023 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.utils;

  19. import org.hipparchus.CalculusFieldElement;
  20. import org.hipparchus.Field;
  21. import org.hipparchus.linear.FieldMatrix;
  22. import org.hipparchus.linear.MatrixUtils;
  23. import org.hipparchus.linear.RealMatrix;
  24. import org.orekit.errors.OrekitInternalError;
  25. import org.orekit.frames.Frame;
  26. import org.orekit.orbits.CircularOrbit;
  27. import org.orekit.orbits.EquinoctialOrbit;
  28. import org.orekit.orbits.FieldCartesianOrbit;
  29. import org.orekit.orbits.FieldCircularOrbit;
  30. import org.orekit.orbits.FieldEquinoctialOrbit;
  31. import org.orekit.orbits.FieldKeplerianOrbit;
  32. import org.orekit.orbits.FieldOrbit;
  33. import org.orekit.orbits.KeplerianOrbit;
  34. import org.orekit.orbits.Orbit;
  35. import org.orekit.orbits.OrbitType;
  36. import org.orekit.orbits.PositionAngleType;
  37. import org.orekit.propagation.FieldStateCovariance;
  38. import org.orekit.propagation.StateCovariance;
  39. import org.orekit.time.FieldAbsoluteDate;

  41. /**
  42.  * Utility class used to convert class to their Field equivalent.
  43.  *
  44.  * @author Vincent Cucchietti
  45.  */
  46. public class Fieldifier {

  48.     /** Private constructor. */
  49.     private Fieldifier() {
  50.         // Empty constructor
  51.     }

  53.     /**
  54.      * Fieldify given orbit with given field.
  55.      * <p>
  56.      * Conserve derivatives and return orbit in same orbit type as input orbit.
  57.      *
  58.      * @param field field to fieldify with
  59.      * @param orbit orbit to fieldify
  60.      * @param <T> type of the elements
  61.      *
  62.      * @return fielded orbit
  63.      */
  64.     public static <T extends CalculusFieldElement<T>> FieldOrbit<T> fieldify(final Field<T> field, final Orbit orbit) {

  66.         final T                    one       = field.getOne();
  67.         final FieldAbsoluteDate<T> fieldDate = new FieldAbsoluteDate<>(field, orbit.getDate());
  68.         final T                    fieldMu   = one.multiply(orbit.getMu());
  69.         final Frame                frame     = orbit.getFrame();

  71.         switch (orbit.getType()) {
  72.             case CIRCULAR: {
  73.                 final CircularOrbit circOrbit = (CircularOrbit) OrbitType.CIRCULAR.convertType(orbit);

  75.                 // Get orbital elements
  76.                 final T a      = one.multiply(circOrbit.getA());
  77.                 final T ex     = one.multiply(circOrbit.getCircularEx());
  78.                 final T ey     = one.multiply(circOrbit.getCircularEy());
  79.                 final T i      = one.multiply(circOrbit.getI());
  80.                 final T raan   = one.multiply(circOrbit.getRightAscensionOfAscendingNode());
  81.                 final T alphaM = one.multiply(circOrbit.getAlphaM());

  83.                 // Get derivatives
  84.                 final T aDot      = one.multiply(circOrbit.getADot());
  85.                 final T exDot     = one.multiply(circOrbit.getCircularExDot());
  86.                 final T eyDot     = one.multiply(circOrbit.getCircularEyDot());
  87.                 final T iDot      = one.multiply(circOrbit.getIDot());
  88.                 final T raanDot   = one.multiply(circOrbit.getRightAscensionOfAscendingNodeDot());
  89.                 final T alphaMDot = one.multiply(circOrbit.getAlphaMDot());

  91.                 return new FieldCircularOrbit<>(a, ex, ey, i, raan, alphaM, aDot, exDot, eyDot, iDot, raanDot, alphaMDot,
  92.                                                 PositionAngleType.MEAN, frame, fieldDate, fieldMu);
  93.             }

  95.             case CARTESIAN: {
  96.                 final FieldPVCoordinates<T> orbitPV = new FieldPVCoordinates<>(field, orbit.getPVCoordinates());

  98.                 return new FieldCartesianOrbit<>(orbitPV, orbit.getFrame(), fieldDate, fieldMu);
  99.             }

  101.             case KEPLERIAN: {
  102.                 final KeplerianOrbit kepOrbit = (KeplerianOrbit) OrbitType.KEPLERIAN.convertType(orbit);

  104.                 // Get orbital elements
  105.                 final T a           = one.multiply(kepOrbit.getA());
  106.                 final T e           = one.multiply(kepOrbit.getE());
  107.                 final T i           = one.multiply(kepOrbit.getI());
  108.                 final T raan        = one.multiply(kepOrbit.getRightAscensionOfAscendingNode());
  109.                 final T pa          = one.multiply(kepOrbit.getPerigeeArgument());
  110.                 final T meanAnomaly = one.multiply(kepOrbit.getMeanAnomaly());

  112.                 // Get derivatives
  113.                 final T aDot           = one.multiply(kepOrbit.getADot());
  114.                 final T eDot           = one.multiply(kepOrbit.getEDot());
  115.                 final T iDot           = one.multiply(kepOrbit.getIDot());
  116.                 final T raanDot        = one.multiply(kepOrbit.getRightAscensionOfAscendingNodeDot());
  117.                 final T paDot          = one.multiply(kepOrbit.getPerigeeArgumentDot());
  118.                 final T meanAnomalyDot = one.multiply(kepOrbit.getMeanAnomalyDot());

  120.                 return new FieldKeplerianOrbit<>(a, e, i, pa, raan, meanAnomaly, aDot, eDot, iDot, paDot, raanDot,
  121.                                                  meanAnomalyDot, PositionAngleType.MEAN, frame, fieldDate, fieldMu);
  122.             }
  123.             case EQUINOCTIAL: {
  124.                 final EquinoctialOrbit equiOrbit = (EquinoctialOrbit) OrbitType.EQUINOCTIAL.convertType(orbit);

  126.                 // Get orbital elements
  127.                 final T a  = one.multiply(equiOrbit.getA());
  128.                 final T ex = one.multiply(equiOrbit.getEquinoctialEx());
  129.                 final T ey = one.multiply(equiOrbit.getEquinoctialEy());
  130.                 final T hx = one.multiply(equiOrbit.getHx());
  131.                 final T hy = one.multiply(equiOrbit.getHy());
  132.                 final T lm = one.multiply(equiOrbit.getLM());

  134.                 // Get derivatives
  135.                 final T aDot  = one.multiply(equiOrbit.getADot());
  136.                 final T exDot = one.multiply(equiOrbit.getEquinoctialExDot());
  137.                 final T eyDot = one.multiply(equiOrbit.getEquinoctialEyDot());
  138.                 final T hxDot = one.multiply(equiOrbit.getHxDot());
  139.                 final T hyDot = one.multiply(equiOrbit.getHyDot());
  140.                 final T lmDot = one.multiply(equiOrbit.getLMDot());

  142.                 return new FieldEquinoctialOrbit<>(a, ex, ey, hx, hy, lm, aDot, exDot, eyDot, hxDot, hyDot,
  143.                                                    lmDot, PositionAngleType.MEAN, frame, fieldDate, fieldMu);
  144.             }
  145.             default:
  146.                 // Should never happen
  147.                 throw new OrekitInternalError(null);
  148.         }

  150.     }

  152.     /**
  153.      * Fieldify given matrix with given field.
  154.      *
  155.      * @param field field to fieldify with
  156.      * @param matrix matrix to fieldify
  157.      * @param <T> type of the elements
  158.      *
  159.      * @return fielded matrix
  160.      */
  161.     public static <T extends CalculusFieldElement<T>> FieldMatrix<T> fieldify(final Field<T> field,
  162.                                                                               final RealMatrix matrix) {

  164.         final int rowDim    = matrix.getRowDimension();
  165.         final int columnDim = matrix.getColumnDimension();

  167.         final FieldMatrix<T> fieldMatrix = MatrixUtils.createFieldMatrix(field, rowDim, columnDim);

  169.         for (int i = 0; i < rowDim; i++) {
  170.             for (int j = 0; j < columnDim; j++) {
  171.                 fieldMatrix.setEntry(i, j, field.getOne().multiply(matrix.getEntry(i, j)));
  172.             }
  173.         }

  175.         return fieldMatrix;
  176.     }

  178.     /**
  179.      * Fieldify given state covariance with given field.
  180.      *
  181.      * @param field field to which the
  182.      * @param stateCovariance state covariance to fieldify
  183.      * @param <T> type of the elements
  184.      *
  185.      * @return fielded state covariance
  186.      *
  187.      * @since 12.0
  188.      */
  189.     public static <T extends CalculusFieldElement<T>> FieldStateCovariance<T> fieldify(final Field<T> field,
  190.                                                                                        final StateCovariance stateCovariance) {
  191.         final FieldMatrix<T>       fieldMatrix = fieldify(field, stateCovariance.getMatrix());
  192.         final FieldAbsoluteDate<T> fieldEpoch  = new FieldAbsoluteDate<>(field, stateCovariance.getDate());
  193.         if (stateCovariance.getLOF() == null) {
  194.             return new FieldStateCovariance<>(fieldMatrix, fieldEpoch, stateCovariance.getFrame(),
  195.                                               stateCovariance.getOrbitType(), stateCovariance.getPositionAngleType());
  196.         }
  197.         return new FieldStateCovariance<>(fieldMatrix, fieldEpoch, stateCovariance.getLOF());
  198.     }

  200. }
Created with JaCoCo 0.8.11.202310140853