Package org.orekit.models.earth.atmosphere.data

Class JB2008SpaceEnvironmentData

java.lang.Object
org.orekit.models.earth.atmosphere.data.JB2008SpaceEnvironmentData
All Implemented Interfaces:
Serializable, JB2008InputParameters
public class JB2008SpaceEnvironmentData extends Object implements JB2008InputParameters
This class provides a container for the solar indices data required by the JB2008 atmospheric model. This container only stores information provided in the SOLFSMY and DTCFILE text file provided by Space Environment Technologies. Therefore it doesn't provide the geomagnetic storm indices available in the SOLRESAP file. The DataLoader implementations and the parsing are handled by the SOLFSMYDataLoader DtcDataLoader classes.

Data are available on Space Environment Technologies' website. The work done for this class is based on the CssiSpaceWeatherData class by Clément Jonglez, the JB2008 interface by Pascal Parraud, and corrections for the CssiSpaceWeatherData implementation by Bryan Cazabonne and Evan Ward.

Since:
11.2
Author:
Louis Aucouturier
See Also:

  • Field Details

    • DEFAULT_SUPPORTED_NAMES_SOLFSMY

      public static final String DEFAULT_SUPPORTED_NAMES_SOLFSMY
      Default regular expression for supported names that works with test and published files for the SOLFSMY file.
      See Also:

    • DEFAULT_SUPPORTED_NAMES_DTC

      public static final String DEFAULT_SUPPORTED_NAMES_DTC
      Default regular expression for supported names that works with test and published files for the DTCFILE file.
      See Also:

  • Constructor Details

    • JB2008SpaceEnvironmentData

      @DefaultDataContext public JB2008SpaceEnvironmentData(String supportedNamesSOL, String supportedNamesDTC)
      Simple constructor. This constructor uses the default data context.
      Parameters:
      supportedNamesSOL - regular expression for SOLFSMY space weather files names with variations allowed between SOLFSMY and the file extension.
      supportedNamesDTC - regular expression for DTCFILE files names with variations allowed between DTCFILE and the file extension.

    • JB2008SpaceEnvironmentData

      public JB2008SpaceEnvironmentData(String supportedNamesSOL, String supportedNamesDTC, DataProvidersManager dataProvidersManager, TimeScale utc)
      Constructor that allows specifying the source of the SOLFSMY space weather file. This constructor takes a supplementary argument, the supported names for DTCFILE, in order to setup the second loader.
      Parameters:
      supportedNamesSOL - regular expression for SOLFSMY space weather files names with variations allowed between SOLFSMY and the file extension.
      supportedNamesDTC - regular expression for DTCFILE files names with variations allowed between DTCFILE and the file extension.
      dataProvidersManager - provides access to auxiliary data files.
      utc - UTC time scale.

    • JB2008SpaceEnvironmentData

      @DefaultDataContext public JB2008SpaceEnvironmentData(DataSource sourceSolfsmy, DataSource sourceDtc)
      Simple constructor. This constructor uses the default data context.
      Parameters:
      sourceSolfsmy - source for the SOLFSMY data
      sourceDtc - source for the DTC data
      Since:
      12.0

    • JB2008SpaceEnvironmentData

      public JB2008SpaceEnvironmentData(DataSource sourceSolfsmy, DataSource sourceDtc, TimeScale utc)
      Constructor that allows specifying the source of the SOLFSMY space weather file. This constructor takes a supplementary argument, the source for DTCFILE, in order to setup the second loader.
      Parameters:
      sourceSolfsmy - source for the SOLFSMY data
      sourceDtc - source for the DTC data
      utc - UTC time scale
      Since:
      12.0

  • Method Details

    • getMinDate

      public AbsoluteDate getMinDate()
      Gets the available data range minimum date.
      Specified by:
      getMinDate in interface JB2008InputParameters
      Returns:
      the minimum date.

    • getMaxDate

      public AbsoluteDate getMaxDate()
      Gets the available data range maximum date.
      Specified by:
      getMaxDate in interface JB2008InputParameters
      Returns:
      the maximum date.

    • getF10

      public double getF10(AbsoluteDate date)
      Get the value of the instantaneous solar flux index (1e-22*Watt/(m²*Hertz)).

      Tabular time 1.0 day earlier.

      Specified by:
      getF10 in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the instantaneous F10.7 index

    • getF10B

      public double getF10B(AbsoluteDate date)
      Get the value of the mean solar flux. Averaged 81-day centered F10.7 B index on the input time.

      Tabular time 1.0 day earlier.

      Specified by:
      getF10B in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the mean solar flux F10.7B index

    • getS10

      public double getS10(AbsoluteDate date)
      Get the EUV index (26-34 nm) scaled to F10.

      Tabular time 1.0 day earlier.

      Specified by:
      getS10 in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the the EUV S10 index

    • getS10B

      public double getS10B(AbsoluteDate date)
      Get the EUV 81-day averaged centered index.

      Tabular time 1.0 day earlier.

      Specified by:
      getS10B in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the the mean EUV S10B index

    • getXM10

      public double getXM10(AbsoluteDate date)
      Get the MG2 index scaled to F10.

      Tabular time 2.0 days earlier.

      Specified by:
      getXM10 in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the the MG2 index

    • getXM10B

      public double getXM10B(AbsoluteDate date)
      Get the MG2 81-day average centered index.

      Tabular time 2.0 days earlier.

      Specified by:
      getXM10B in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the the mean MG2 index

    • getY10

      public double getY10(AbsoluteDate date)
      Get the Solar X-Ray & Lya index scaled to F10.

      Tabular time 5.0 days earlier.

      Specified by:
      getY10 in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the Solar X-Ray & Lya index scaled to F10

    • getY10B

      public double getY10B(AbsoluteDate date)
      Get the Solar X-Ray & Lya 81-day ave. centered index.

      Tabular time 5.0 days earlier.

      Specified by:
      getY10B in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the Solar X-Ray & Lya 81-day ave. centered index

    • getDSTDTC

      public double getDSTDTC(AbsoluteDate date)
      Get the temperature change computed from Dst index.
      Specified by:
      getDSTDTC in interface JB2008InputParameters
      Parameters:
      date - the current date
      Returns:
      the temperature change computed from Dst index