1   /* Copyright 2002-2024 Thales Alenia Space
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.models.earth.troposphere;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.bodies.FieldGeodeticPoint;
21  import org.orekit.bodies.GeodeticPoint;
22  import org.orekit.models.earth.weather.FieldPressureTemperatureHumidity;
23  import org.orekit.models.earth.weather.PressureTemperatureHumidity;
24  import org.orekit.time.AbsoluteDate;
25  import org.orekit.time.FieldAbsoluteDate;
26  import org.orekit.utils.FieldTrackingCoordinates;
27  import org.orekit.utils.TrackingCoordinates;
28  
29  /** Interface for mapping functions used in the tropospheric delay computation.
30   * @author Bryan Cazabonne
31   * @author Luc Maisonobe
32   */
33  public interface TroposphereMappingFunction {
34  
35      /** This method allows the computation of the hydrostatic and
36       * wet mapping functions. The resulting element is an array having the following form:
37       * <ul>
38       * <li>double[0] = m<sub>h</sub>(e) → hydrostatic mapping function
39       * <li>double[1] = m<sub>w</sub>(e) → wet mapping function
40       * </ul>
41       * @param trackingCoordinates tracking coordinates of the satellite
42       * @param point station location
43       * @param weather weather parameters
44       * @param date current date
45       * @return a two components array containing the hydrostatic and wet mapping functions.
46       */
47      double[] mappingFactors(TrackingCoordinates trackingCoordinates, GeodeticPoint point,
48                              PressureTemperatureHumidity weather, AbsoluteDate date);
49  
50      /** This method allows the computation of the hydrostatic and
51       * wet mapping functions. The resulting element is an array having the following form:
52       * <ul>
53       * <li>T[0] = m<sub>h</sub>(e) → hydrostatic mapping function
54       * <li>T[1] = m<sub>w</sub>(e) → wet mapping function
55       * </ul>
56       * @param trackingCoordinates tracking coordinates of the satellite
57       * @param point station location
58       * @param weather weather parameters
59       * @param date current date
60       * @param <T> type of the elements
61       * @return a two components array containing the hydrostatic and wet mapping functions.
62       */
63      <T extends CalculusFieldElement<T>> T[] mappingFactors(FieldTrackingCoordinates<T> trackingCoordinates,
64                                                             FieldGeodeticPoint<T> point,
65                                                             FieldPressureTemperatureHumidity<T> weather,
66                                                             FieldAbsoluteDate<T> date);
67  
68  }