FieldForceModelContext.java

  1. /* Copyright 2002-2022 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.semianalytical.dsst.forces;

  18. import org.hipparchus.CalculusFieldElement;
  19. import org.orekit.propagation.semianalytical.dsst.utilities.FieldAuxiliaryElements;

  20. /** Base class for dsst force models parameter containers.
  21.  * @author Bryan Cazabonne
  22.  * @since 10.0
  23.  */
  24. public abstract class FieldForceModelContext<T extends CalculusFieldElement<T>> {

  25.     /** Common parameters used by all DSST forces. */
  26.     private final FieldAuxiliaryElements<T> auxiliaryElements;

  27.     /** Simple constructor.
  28.      * @param auxiliaryElements auxiliary elements related to the current orbit
  29.      */
  30.     protected FieldForceModelContext(final FieldAuxiliaryElements<T> auxiliaryElements) {
  31.         this.auxiliaryElements = auxiliaryElements;
  32.     }

  33.     /** Method to get the auxiliary elementsrelated to the {@link ForceModelContext}.
  34.      * @return field auxiliary elements
  35.      */
  36.     public FieldAuxiliaryElements<T> getFieldAuxiliaryElements() {
  37.         return auxiliaryElements;
  38.     }

  39. }