1   /* Copyright 2022-2025 Romain Serra
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.atmosphere;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
21  import org.hipparchus.geometry.euclidean.threed.Vector3D;
22  import org.orekit.frames.Frame;
23  import org.orekit.time.AbsoluteDate;
24  import org.orekit.time.FieldAbsoluteDate;
25  import org.orekit.utils.ExtendedPositionProvider;
26  
27  /**
28   * Abstract class for atmospheric models using the Sun's position.
29   * @author Romain Serra
30   * @since 13.0
31   */
32  public abstract class AbstractSunInfluencedAtmosphere implements Atmosphere {
33  
34      /** Sun's position provider. */
35      private final ExtendedPositionProvider sun;
36  
37      /**
38       * Constructor.
39       * @param sun position provider.
40       */
41      protected AbstractSunInfluencedAtmosphere(final ExtendedPositionProvider sun) {
42          this.sun = sun;
43      }
44  
45      /**
46       * Getter for Sun's position provider.
47       * @return position provider
48       */
49      protected ExtendedPositionProvider getSun() {
50          return sun;
51      }
52  
53      /**
54       * Method returning the Sun's position vector.
55       * @param date date of output position
56       * @param frame frame of output position
57       * @return Sun's position
58       */
59      protected Vector3D getSunPosition(final AbsoluteDate date, final Frame frame) {
60          return sun.getPosition(date, frame);
61      }
62  
63      /**
64       * Method returning the Sun's position vector (Field version).
65       * @param date date of output position
66       * @param frame frame of output position
67       * @param <T> field type
68       * @return Sun's position
69       */
70      protected <T extends CalculusFieldElement<T>> FieldVector3D<T> getSunPosition(final FieldAbsoluteDate<T> date,
71                                                                                    final Frame frame) {
72          return sun.getPosition(date, frame);
73      }
74  }