AdamsMoultonIntegratorBuilder.java

  1. /* Copyright 2002-2016 CS Systèmes d'Information
  2.  * Licensed to CS Systèmes d'Information (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.apache.commons.math3.ode.AbstractIntegrator;
  19. import org.apache.commons.math3.ode.nonstiff.AdamsMoultonIntegrator;
  20. import org.orekit.errors.PropagationException;
  21. import org.orekit.orbits.Orbit;
  22. import org.orekit.orbits.OrbitType;
  23. import org.orekit.propagation.numerical.NumericalPropagator;

  24. /** Builder for AdamsMoultonIntegrator.
  25.  * @author Pascal Parraud
  26.  * @since 6.0
  27.  */
  28. public class AdamsMoultonIntegratorBuilder implements FirstOrderIntegratorBuilder {

  29.     /** Number of steps. */
  30.     private final int nSteps;

  31.     /** Minimum step size (s). */
  32.     private final double minStep;

  33.     /** Maximum step size (s). */
  34.     private final double maxStep;

  35.     /** Minimum step size (s). */
  36.     private final double dP;

  37.     /** Build a new instance.
  38.      * @param nSteps number of steps
  39.      * @param minStep minimum step size (s)
  40.      * @param maxStep maximum step size (s)
  41.      * @param dP position error (m)
  42.      * @see AdamsMoultonIntegrator
  43.      * @see NumericalPropagator#tolerances(double, Orbit, OrbitType)
  44.      */
  45.     public AdamsMoultonIntegratorBuilder(final int nSteps, final double minStep,
  46.                                            final double maxStep, final double dP) {
  47.         this.nSteps  = nSteps;
  48.         this.minStep = minStep;
  49.         this.maxStep = maxStep;
  50.         this.dP      = dP;
  51.     }

  52.     /** {@inheritDoc} */
  53.     public AbstractIntegrator buildIntegrator(final Orbit orbit, final OrbitType orbitType)
  54.         throws PropagationException {
  55.         final double[][] tol = NumericalPropagator.tolerances(dP, orbit, orbitType);
  56.         return new AdamsMoultonIntegrator(nSteps, minStep, maxStep, tol[0], tol[1]);
  57.     }

  58. }