ThreeEighthesFieldIntegratorBuilder.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.propagation.conversion;

  18. import org.hipparchus.CalculusFieldElement;
  19. import org.hipparchus.Field;
  20. import org.hipparchus.ode.AbstractFieldIntegrator;
  21. import org.hipparchus.ode.nonstiff.ThreeEighthesFieldIntegrator;
  22. import org.orekit.orbits.Orbit;
  23. import org.orekit.orbits.OrbitType;

  24. /**
  25.  * Builder for ThreeEighthesFieldIntegrator.
  26.  *
  27.  * @author Pascal Parraud
  28.  * @author Vincent Cucchietti
  29.  * @since 12.0
  30.  * @param <T> type of the field elements
  31.  */
  32. public class ThreeEighthesFieldIntegratorBuilder<T extends CalculusFieldElement<T>>
  33.         extends AbstractFixedStepFieldIntegratorBuilder<T> {

  34.     /**
  35.      * Constructor.
  36.      *
  37.      * @param step step size (s)
  38.      *
  39.      * @see ThreeEighthesFieldIntegrator
  40.      */
  41.     public ThreeEighthesFieldIntegratorBuilder(final double step) {
  42.         super(step);
  43.     }

  44.     /**
  45.      * Constructor using a "fielded" step.
  46.      * <p>
  47.      * <b>WARNING : Given "fielded" step must be using the same field as the one that will be used when calling
  48.      * {@link #buildIntegrator}</b>
  49.      *
  50.      * @param step step size (s)
  51.      *
  52.      * @see ThreeEighthesFieldIntegrator
  53.      */
  54.     public ThreeEighthesFieldIntegratorBuilder(final T step) {
  55.         super(step);
  56.     }

  57.     /** {@inheritDoc} */
  58.     @Override
  59.     public AbstractFieldIntegrator<T> buildIntegrator(final Field<T> field, final Orbit orbit, final OrbitType orbitType) {
  60.         return new ThreeEighthesFieldIntegrator<>(field, getFieldStep(field));
  61.     }
  62. }