EcksteinHechlerPropagatorBuilder.java

  1. /* Copyright 2002-2020 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.conversion;

  18. import org.orekit.annotation.DefaultDataContext;
  19. import org.orekit.attitudes.AttitudeProvider;
  20. import org.orekit.data.DataContext;
  21. import org.orekit.forces.gravity.potential.GravityFieldFactory;
  22. import org.orekit.forces.gravity.potential.TideSystem;
  23. import org.orekit.forces.gravity.potential.UnnormalizedSphericalHarmonicsProvider;
  24. import org.orekit.orbits.Orbit;
  25. import org.orekit.orbits.OrbitType;
  26. import org.orekit.orbits.PositionAngle;
  27. import org.orekit.propagation.Propagator;
  28. import org.orekit.propagation.analytical.EcksteinHechlerPropagator;

  29. /** Builder for Eckstein-Hechler propagator.
  30.  * @author Pascal Parraud
  31.  * @since 6.0
  32.  */
  33. public class EcksteinHechlerPropagatorBuilder extends AbstractPropagatorBuilder {

  34.     /** Provider for un-normalized coefficients. */
  35.     private final UnnormalizedSphericalHarmonicsProvider provider;

  36.     /** Build a new instance.
  37.      * <p>
  38.      * The template orbit is used as a model to {@link
  39.      * #createInitialOrbit() create initial orbit}. It defines the
  40.      * inertial frame, the central attraction coefficient, the orbit type, and is also
  41.      * used together with the {@code positionScale} to convert from the {@link
  42.      * org.orekit.utils.ParameterDriver#setNormalizedValue(double) normalized} parameters used by the
  43.      * callers of this builder to the real orbital parameters.
  44.      * </p>
  45.      *
  46.      * <p>This constructor uses the {@link DataContext#getDefault() default data context}.
  47.      *
  48.      * @param templateOrbit reference orbit from which real orbits will be built
  49.      * (note that the mu from this orbit will be overridden with the mu from the
  50.      * {@code provider})
  51.      * @param provider for un-normalized zonal coefficients
  52.      * @param positionAngle position angle type to use
  53.      * @param positionScale scaling factor used for orbital parameters normalization
  54.      * (typically set to the expected standard deviation of the position)
  55.      * @since 8.0
  56.      * @see #EcksteinHechlerPropagatorBuilder(Orbit,
  57.      * UnnormalizedSphericalHarmonicsProvider, PositionAngle, double, AttitudeProvider)
  58.      */
  59.     @DefaultDataContext
  60.     public EcksteinHechlerPropagatorBuilder(final Orbit templateOrbit,
  61.                                             final UnnormalizedSphericalHarmonicsProvider provider,
  62.                                             final PositionAngle positionAngle,
  63.                                             final double positionScale) {
  64.         this(templateOrbit, provider, positionAngle, positionScale,
  65.                 Propagator.getDefaultLaw(DataContext.getDefault().getFrames()));
  66.     }

  67.     /** Build a new instance.
  68.      * <p>
  69.      * The template orbit is used as a model to {@link
  70.      * #createInitialOrbit() create initial orbit}. It defines the
  71.      * inertial frame, the central attraction coefficient, the orbit type, and is also
  72.      * used together with the {@code positionScale} to convert from the {@link
  73.      * org.orekit.utils.ParameterDriver#setNormalizedValue(double) normalized} parameters used by the
  74.      * callers of this builder to the real orbital parameters.
  75.      * </p>
  76.      * @param templateOrbit reference orbit from which real orbits will be built
  77.      * (note that the mu from this orbit will be overridden with the mu from the
  78.      * {@code provider})
  79.      * @param provider for un-normalized zonal coefficients
  80.      * @param positionAngle position angle type to use
  81.      * @param positionScale scaling factor used for orbital parameters normalization
  82.      * (typically set to the expected standard deviation of the position)
  83.      * @param attitudeProvider attitude law to use.
  84.      * @since 10.1
  85.      */
  86.     public EcksteinHechlerPropagatorBuilder(final Orbit templateOrbit,
  87.                                             final UnnormalizedSphericalHarmonicsProvider provider,
  88.                                             final PositionAngle positionAngle,
  89.                                             final double positionScale,
  90.                                             final AttitudeProvider attitudeProvider) {
  91.         super(overrideMu(templateOrbit, provider, positionAngle), positionAngle,
  92.                 positionScale, true, attitudeProvider);
  93.         this.provider = provider;
  94.     }

  95.     /** Build a new instance.
  96.      * <p>
  97.      * The template orbit is used as a model to {@link
  98.      * #createInitialOrbit() create initial orbit}. It defines the
  99.      * inertial frame, the central attraction coefficient, the orbit type, and is also
  100.      * used together with the {@code positionScale} to convert from the {@link
  101.      * org.orekit.utils.ParameterDriver#setNormalizedValue(double) normalized} parameters used by the
  102.      * callers of this builder to the real orbital parameters.
  103.      * </p>
  104.      *
  105.      * <p>This constructor uses the {@link DataContext#getDefault() default data context}.
  106.      *
  107.      * @param templateOrbit reference orbit from which real orbits will be built
  108.      * (note that the mu from this orbit will be overridden with the mu from the
  109.      * {@code provider})
  110.      * @param referenceRadius reference radius of the Earth for the potential model (m)
  111.      * @param mu central attraction coefficient (m³/s²)
  112.      * @param tideSystem tide system
  113.      * @param c20 un-normalized zonal coefficient (about -1.08e-3 for Earth)
  114.      * @param c30 un-normalized zonal coefficient (about +2.53e-6 for Earth)
  115.      * @param c40 un-normalized zonal coefficient (about +1.62e-6 for Earth)
  116.      * @param c50 un-normalized zonal coefficient (about +2.28e-7 for Earth)
  117.      * @param c60 un-normalized zonal coefficient (about -5.41e-7 for Earth)
  118.      * @param orbitType orbit type to use
  119.      * @param positionAngle position angle type to use
  120.      * @param positionScale scaling factor used for orbital parameters normalization
  121.      * (typically set to the expected standard deviation of the position)
  122.      * @since 8.0
  123.      * @see #EcksteinHechlerPropagatorBuilder(Orbit,
  124.      * UnnormalizedSphericalHarmonicsProvider, PositionAngle, double, AttitudeProvider)
  125.      */
  126.     @DefaultDataContext
  127.     public EcksteinHechlerPropagatorBuilder(final Orbit templateOrbit,
  128.                                             final double referenceRadius,
  129.                                             final double mu,
  130.                                             final TideSystem tideSystem,
  131.                                             final double c20,
  132.                                             final double c30,
  133.                                             final double c40,
  134.                                             final double c50,
  135.                                             final double c60,
  136.                                             final OrbitType orbitType,
  137.                                             final PositionAngle positionAngle,
  138.                                             final double positionScale) {
  139.         this(templateOrbit,
  140.              GravityFieldFactory.getUnnormalizedProvider(referenceRadius, mu, tideSystem,
  141.                                                          new double[][] {
  142.                                                              {
  143.                                                                  0
  144.                                                              }, {
  145.                                                                  0
  146.                                                              }, {
  147.                                                                  c20
  148.                                                              }, {
  149.                                                                  c30
  150.                                                              }, {
  151.                                                                  c40
  152.                                                              }, {
  153.                                                                  c50
  154.                                                              }, {
  155.                                                                  c60
  156.                                                              }
  157.                                                          }, new double[][] {
  158.                                                              {
  159.                                                                  0
  160.                                                              }, {
  161.                                                                  0
  162.                                                              }, {
  163.                                                                  0
  164.                                                              }, {
  165.                                                                  0
  166.                                                              }, {
  167.                                                                  0
  168.                                                              }, {
  169.                                                                  0
  170.                                                              }, {
  171.                                                                  0
  172.                                                              }
  173.                                                          }),
  174.              positionAngle, positionScale);
  175.     }

  176.     /** Override central attraction coefficient.
  177.      * @param templateOrbit template orbit
  178.      * @param provider gravity field provider
  179.      * @param positionAngle position angle type to use
  180.      * @return orbit with overridden central attraction coefficient
  181.      */
  182.     private static Orbit overrideMu(final Orbit templateOrbit,
  183.                                     final UnnormalizedSphericalHarmonicsProvider provider,
  184.                                     final PositionAngle positionAngle) {
  185.         final double[] parameters    = new double[6];
  186.         final double[] parametersDot = templateOrbit.hasDerivatives() ? new double[6] : null;
  187.         templateOrbit.getType().mapOrbitToArray(templateOrbit, positionAngle, parameters, parametersDot);
  188.         return templateOrbit.getType().mapArrayToOrbit(parameters, parametersDot, positionAngle,
  189.                                                        templateOrbit.getDate(),
  190.                                                        provider.getMu(),
  191.                                                        templateOrbit.getFrame());
  192.     }

  193.     /** {@inheritDoc} */
  194.     public Propagator buildPropagator(final double[] normalizedParameters) {
  195.         setParameters(normalizedParameters);
  196.         return new EcksteinHechlerPropagator(createInitialOrbit(), getAttitudeProvider(),
  197.                 provider);
  198.     }

  199. }