FieldPropagator.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;

  19. import java.util.Collection;
  20. import java.util.List;

  22. import org.hipparchus.RealFieldElement;
  23. import org.orekit.annotation.DefaultDataContext;
  24. import org.orekit.attitudes.AttitudeProvider;
  25. import org.orekit.attitudes.InertialProvider;
  26. import org.orekit.data.DataContext;
  27. import org.orekit.frames.Frame;
  28. import org.orekit.frames.Frames;
  29. import org.orekit.propagation.events.FieldEventDetector;
  30. import org.orekit.propagation.sampling.FieldOrekitFixedStepHandler;
  31. import org.orekit.propagation.sampling.FieldOrekitStepHandler;
  32. import org.orekit.time.FieldAbsoluteDate;
  33. import org.orekit.utils.FieldPVCoordinatesProvider;

  35. /** This interface provides a way to propagate an orbit at any time.
  36.  *
  37.  * <p>This interface is the top-level abstraction for orbit propagation.
  38.  * It only allows propagation to a predefined date.
  39.  * It is implemented by analytical models which have no time limit,
  40.  * by orbit readers based on external data files, by numerical integrators
  41.  * using rich force models and by continuous models built after numerical
  42.  * integration has been completed and dense output data as been
  43.  * gathered.</p>

  45.  * @author Luc Maisonobe
  46.  * @author V&eacute;ronique Pommier-Maurussane
  47.  *
  48.  */

  50. public interface FieldPropagator<T extends RealFieldElement<T>> extends FieldPVCoordinatesProvider<T> {

  52.     /** Default mass. */
  53.     double DEFAULT_MASS = 1000.0;

  55.     /**
  56.      * Default attitude provider.
  57.      *
  58.      * <p>This field uses the {@link DataContext#getDefault() default data context}.
  59.      *
  60.      * @see Propagator#getDefaultLaw(Frames)
  61.      * @see InertialProvider#InertialProvider(Frame)
  62.      */
  63.     @DefaultDataContext
  64.     AttitudeProvider DEFAULT_LAW = InertialProvider.EME2000_ALIGNED;

  66.     /** Indicator for slave mode. */
  67.     int SLAVE_MODE = 0;

  69.     /** Indicator for master mode. */
  70.     int MASTER_MODE = 1;

  72.     /** Indicator for ephemeris generation mode. */
  73.     int EPHEMERIS_GENERATION_MODE = 2;

  75.     /** Get the current operating mode of the propagator.
  76.      * @return one of {@link #SLAVE_MODE}, {@link #MASTER_MODE},
  77.      * {@link #EPHEMERIS_GENERATION_MODE}
  78.      * @see #setSlaveMode()
  79.      * @see #setMasterMode(RealFieldElement, FieldOrekitFixedStepHandler)
  80.      * @see #setMasterMode(FieldOrekitStepHandler)
  81.      * @see #setEphemerisMode()
  82.      */
  83.     int getMode();

  85.     /** Set the propagator to slave mode.
  86.      * <p>This mode is used when the user needs only the final orbit at the target time.
  87.      * The (slave) propagator computes this result and return it to the calling
  88.      * (master) application, without any intermediate feedback.
  89.      * <p>This is the default mode.
  90.      * @see #setMasterMode(RealFieldElement, FieldOrekitFixedStepHandler)
  91.      * @see #setMasterMode(FieldOrekitStepHandler)
  92.      * @see #setEphemerisMode()
  93.      * @see #getMode()
  94.      * @see #SLAVE_MODE
  95.      */
  96.     void setSlaveMode();

  98.     /** Set the propagator to master mode with fixed steps.
  99.      * <p>This mode is used when the user needs to have some custom function called at the
  100.      * end of each finalized step during integration. The (master) propagator integration
  101.      * loop calls the (slave) application callback methods at each finalized step.</p>
  102.      * @param h fixed stepsize (s)
  103.      * @param handler handler called at the end of each finalized step
  104.      * @see #setSlaveMode()
  105.      * @see #setMasterMode(FieldOrekitStepHandler)
  106.      * @see #setEphemerisMode()
  107.      * @see #getMode()
  108.      * @see #MASTER_MODE
  109.      */
  110.     void setMasterMode(T h, FieldOrekitFixedStepHandler<T> handler);

  112.     /** Set the propagator to master mode with variable steps.
  113.      * <p>This mode is used when the user needs to have some custom function called at the
  114.      * end of each finalized step during integration. The (master) propagator integration
  115.      * loop calls the (slave) application callback methods at each finalized step.</p>
  116.      * @param handler handler called at the end of each finalized step
  117.      * @see #setSlaveMode()
  118.      * @see #setMasterMode(RealFieldElement, FieldOrekitFixedStepHandler)
  119.      * @see #setEphemerisMode()
  120.      * @see #getMode()
  121.      * @see #MASTER_MODE
  122.      */
  123.     void setMasterMode(FieldOrekitStepHandler<T> handler);

  125.     /** Set the propagator to ephemeris generation mode.
  126.      *  <p>This mode is used when the user needs random access to the orbit state at any time
  127.      *  between the initial and target times, and in no sequential order. A typical example is
  128.      *  the implementation of search and iterative algorithms that may navigate forward and
  129.      *  backward inside the propagation range before finding their result.</p>
  130.      *  <p>Beware that since this mode stores <strong>all</strong> intermediate results,
  131.      *  it may be memory intensive for long integration ranges and high precision/short
  132.      *  time steps.</p>
  133.      * @see #getGeneratedEphemeris()
  134.      * @see #setSlaveMode()
  135.      * @see #setMasterMode(RealFieldElement, FieldOrekitFixedStepHandler)
  136.      * @see #setMasterMode(FieldOrekitStepHandler)
  137.      * @see #getMode()
  138.      * @see #EPHEMERIS_GENERATION_MODE
  139.      */
  140.     void setEphemerisMode();

  142.     /** Get the ephemeris generated during propagation.
  143.      * @return generated ephemeris
  144.      * @exception IllegalStateException if the propagator was not set in ephemeris
  145.      * generation mode before propagation
  146.      * @see #setEphemerisMode()
  147.      */
  148.     FieldBoundedPropagator<T> getGeneratedEphemeris() throws IllegalStateException;

  150.     /** Get the propagator initial state.
  151.      * @return initial state
  152.      */
  153.     FieldSpacecraftState<T> getInitialState();

  155.     /** Reset the propagator initial state.
  156.      * @param state new initial state to consider
  157.      */
  158.     void resetInitialState(FieldSpacecraftState<T> state);

  160.     /** Add a set of user-specified state parameters to be computed along with the orbit propagation.
  161.      * @param additionalStateProvider provider for additional state
  162.      */
  163.     void addAdditionalStateProvider(FieldAdditionalStateProvider<T> additionalStateProvider);

  165.     /** Get an unmodifiable list of providers for additional state.
  166.      * @return providers for the additional states
  167.      */
  168.     List<FieldAdditionalStateProvider<T>> getAdditionalStateProviders();

  170.     /** Check if an additional state is managed.
  171.      * <p>
  172.      * Managed states are states for which the propagators know how to compute
  173.      * its evolution. They correspond to additional states for which an
  174.      * {@link FieldAdditionalStateProvider additional state provider} has been registered
  175.      * by calling the {@link #addAdditionalStateProvider(FieldAdditionalStateProvider)
  176.      * addAdditionalStateProvider} method. If the propagator is an {@link
  177.      * org.orekit.propagation.integration.FieldAbstractIntegratedPropagator integrator-based
  178.      * propagator}, the states for which a set of {@link
  179.      * org.orekit.propagation.integration.FieldAdditionalEquations additional equations} has
  180.      * been registered by calling the {@link
  181.      * org.orekit.propagation.integration.FieldAbstractIntegratedPropagator#addAdditionalEquations(
  182.      * org.orekit.propagation.integration.FieldAdditionalEquations) addAdditionalEquations}
  183.      * method are also counted as managed additional states.
  184.      * </p>
  185.      * <p>
  186.      * Additional states that are present in the {@link #getInitialState() initial state}
  187.      * but have no evolution method registered are <em>not</em> considered as managed states.
  188.      * These unmanaged additional states are not lost during propagation, though. Their
  189.      * value are piecewise constant between state resets that may change them if some
  190.      * event handler {@link
  191.      * org.orekit.propagation.events.handlers.FieldEventHandler#resetState(FieldEventDetector,
  192.      * FieldSpacecraftState) resetState} method is called at an event occurrence and happens
  193.      * to change the unmanaged additional state.
  194.      * </p>
  195.      * @param name name of the additional state
  196.      * @return true if the additional state is managed
  197.      */
  198.     boolean isAdditionalStateManaged(String name);

  200.     /** Get all the names of all managed states.
  201.      * @return names of all managed states
  202.      */
  203.     String[] getManagedAdditionalStates();

  205.     /** Add an event detector.
  206.      * @param detector event detector to add
  207.      * @see #clearEventsDetectors()
  208.      * @see #getEventsDetectors()
  209.      * @param <D> class type for the generic version
  210.      */
  211.     <D extends FieldEventDetector<T>> void addEventDetector(D detector);

  213.     /** Get all the events detectors that have been added.
  214.      * @return an unmodifiable collection of the added detectors
  215.      * @see #addEventDetector(FieldEventDetector)
  216.      * @see #clearEventsDetectors()
  217.      */
  218.     Collection<FieldEventDetector<T>> getEventsDetectors();

  220.     /** Remove all events detectors.
  221.      * @see #addEventDetector(FieldEventDetector)
  222.      * @see #getEventsDetectors()
  223.      */
  224.     void clearEventsDetectors();

  226.     /** Get attitude provider.
  227.      * @return attitude provider
  228.      */
  229.     AttitudeProvider getAttitudeProvider();

  231.     /** Set attitude provider.
  232.      * @param attitudeProvider attitude provider
  233.      */
  234.     void setAttitudeProvider(AttitudeProvider attitudeProvider);

  236.     /** Get the frame in which the orbit is propagated.
  237.      * <p>
  238.      * The propagation frame is the definition frame of the initial
  239.      * state, so this method should be called after this state has
  240.      * been set, otherwise it may return null.
  241.      * </p>
  242.      * @return frame in which the orbit is propagated
  243.      * @see #resetInitialState(FieldSpacecraftState)
  244.      */
  245.     Frame getFrame();

  247.     /** Propagate towards a target date.
  248.      * <p>Simple propagators use only the target date as the specification for
  249.      * computing the propagated state. More feature rich propagators can consider
  250.      * other information and provide different operating modes or G-stop
  251.      * facilities to stop at pinpointed events occurrences. In these cases, the
  252.      * target date is only a hint, not a mandatory objective.</p>
  253.      * @param target target date towards which orbit state should be propagated
  254.      * @return propagated state
  255.      */
  256.     FieldSpacecraftState<T> propagate(FieldAbsoluteDate<T> target);

  258.     /** Propagate from a start date towards a target date.
  259.      * <p>Those propagators use a start date and a target date to
  260.      * compute the propagated state. For propagators using event detection mechanism,
  261.      * if the provided start date is different from the initial state date, a first,
  262.      * simple propagation is performed, without processing any event computation.
  263.      * Then complete propagation is performed from start date to target date.</p>
  264.      * @param start start date from which orbit state should be propagated
  265.      * @param target target date to which orbit state should be propagated
  266.      * @return propagated state
  267.      */
  268.     FieldSpacecraftState<T> propagate(FieldAbsoluteDate<T> start, FieldAbsoluteDate<T> target);

  270. }
Created with JaCoCo 0.8.6.202009150832