1   /* Copyright 2022-2024 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.forces.radiation;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.hipparchus.Field;
21  import org.hipparchus.geometry.euclidean.threed.FieldVector3D;
22  import org.hipparchus.geometry.euclidean.threed.Vector3D;
23  import org.orekit.propagation.FieldSpacecraftState;
24  import org.orekit.propagation.SpacecraftState;
25  import org.orekit.propagation.events.EventDetector;
26  import org.orekit.propagation.events.FieldEventDetector;
27  
28  import java.util.List;
29  
30  /**
31   * Interface describing flux models from a light source, including shadowing effects from occulting bodies.
32   * Defines the flux vector itself as well as detectors for entry and exit of the different eclipse zones, if any.
33   *
34   * @author Romain Serra
35   * @since 12.1
36   */
37  public interface LightFluxModel {
38  
39      /**
40       * Get the light flux vector in the state's frame.
41       * @param state state
42       * @return light flux
43       */
44      Vector3D getLightFluxVector(SpacecraftState state);
45  
46      /**
47       * Get the light flux vector in the state's frame. Field version.
48       * @param state state
49       * @return light flux
50       * @param <T> field type
51       */
52      <T extends CalculusFieldElement<T>> FieldVector3D<T> getLightFluxVector(FieldSpacecraftState<T> state);
53  
54      /**
55       * Retrieve detectors finding entries and exits in different eclipse zones.
56       * @return list of event detectors
57       */
58      List<EventDetector> getEclipseConditionsDetector();
59  
60      /**
61       * Retrieve Field detectors finding entries and exits in different eclipse zones.
62       * @param field calculus field
63       * @return list of event detectors
64       * @param <T> field type
65       */
66      <T extends CalculusFieldElement<T>> List<FieldEventDetector<T>> getFieldEclipseConditionsDetector(Field<T> field);
67  }