1   /* Copyright 2002-2025 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  
19  import java.util.Map;
20  import java.util.Set;
21  
22  import org.orekit.orbits.Orbit;
23  import org.orekit.time.AbsoluteDate;
24  
25  /** Additive short period terms contributing to the mean to osculating orbit mapping.
26   * <p>
27   * Each instance contains a set of several terms that are computed together.
28   * </p>
29   * @see DSSTForceModel
30   * @author Luc Maisonobe
31   * @since 7.1
32   */
33  public interface ShortPeriodTerms {
34  
35      /** Evaluate the contributions of the short period terms.
36       * @param meanOrbit mean orbit to which the short period contribution applies
37       * @return short period terms contributions
38       */
39      double[] value(Orbit meanOrbit);
40  
41      /** Get the prefix for short period coefficients keys.
42       * <p>
43       * This prefix is used to identify the coefficients of the
44       * current force model from the coefficients pertaining to
45       * other force models. All the keys in the map returned by
46       * {@link #getCoefficients(AbsoluteDate, Set)}
47       * start with this prefix, which must be unique among all
48       * providers.
49       * </p>
50       * @return the prefix for short periodic coefficients keys
51       * @see #getCoefficients(AbsoluteDate, Set)
52       */
53      String getCoefficientsKeyPrefix();
54  
55      /** Computes the coefficients involved in the contributions.
56       * <p>
57       * This method is intended mainly for validation purposes. Its output
58       * is highly dependent on the implementation details in each force model
59       * and may change from version to version. It is <em>not</em> recommended
60       * to use it for any operational purposes.
61       * </p>
62       * @param date current date
63       * @param selected set of coefficients that should be put in the map
64       * (empty set means all coefficients are selected)
65       * @return the selected coefficients of the short periodic variations,
66       * in a map where all keys start with {@link #getCoefficientsKeyPrefix()}
67       */
68      Map<String, double[]> getCoefficients(AbsoluteDate date, Set<String> selected);
69  
70  }