fr.cnes.sirius.patrius.forces.atmospheres

Interface JB2006InputParameters

All Superinterfaces:

Serializable

public interface JB2006InputParameters
extends Serializable

Interface for solar activity and magnetic activity data.

Author:

Fabien Maussion

Method Summary

Modifier and Type	Method and Description
void	checkSolarActivityData(AbsoluteDate start, AbsoluteDate end) This methods throws an exception if the user did not provide solar activity on the provided interval [start, end].
double	getAp(AbsoluteDate date) Get the Geomagnetic planetary 3-hour index Ap.
double	getF10(AbsoluteDate date) Get the value of the instantaneous solar flux index (1e-22*Watt/(m2*Hertz)).
double	getF10B(AbsoluteDate date) Get the value of the mean solar flux.
AbsoluteDate	getMaxDate() Gets the available data range maximum date.
AbsoluteDate	getMinDate() Gets the available data range minimum date.
double	getS10(AbsoluteDate date) Get the EUV index (26-34 nm) scaled to F10.
double	getS10B(AbsoluteDate date) Get the EUV 81-day averaged centered index.
double	getXM10(AbsoluteDate date) Get the MG2 index scaled to F10.
double	getXM10B(AbsoluteDate date) Get the MG2 81-day average centered index.

Method Detail

getMinDate

AbsoluteDate getMinDate()

Gets the available data range minimum date.

Returns:

the minimum date.

getMaxDate

AbsoluteDate getMaxDate()

Gets the available data range maximum date.

Returns:

the maximum date.

getF10

double getF10(AbsoluteDate date)
       throws PatriusException

Get the value of the instantaneous solar flux index (1e^-22*Watt/(m²*Hertz)). Tabular time 1.0 day earlier.

Parameters:

date - the current date

Returns:

the instantaneous F10.7 index

Throws:

PatriusException - if the date is out of range of available data

getF10B

double getF10B(AbsoluteDate date)
        throws PatriusException

Get the value of the mean solar flux. Averaged 81-day centered F10.7 B index on the input time.

Parameters:

date - the current date

Returns:

the mean solar flux F10.7B index

Throws:

PatriusException - if the date is out of range of available data

getS10

double getS10(AbsoluteDate date)
       throws PatriusException

Get the EUV index (26-34 nm) scaled to F10. Tabular time 1 day earlier.

Parameters:

date - the current date

Returns:

the the EUV S10 index

Throws:

PatriusException - if the date is out of range of available data

getS10B

double getS10B(AbsoluteDate date)
        throws PatriusException

Get the EUV 81-day averaged centered index.

Parameters:

date - the current date

Returns:

the the mean EUV S10B index

Throws:

PatriusException - if the date is out of range of available data

getXM10

double getXM10(AbsoluteDate date)
        throws PatriusException

Get the MG2 index scaled to F10.

Parameters:

date - the current date

Returns:

the the EUV S10 index

Throws:

PatriusException - if the date is out of range of available data

getXM10B

double getXM10B(AbsoluteDate date)
         throws PatriusException

Get the MG2 81-day average centered index. Tabular time 5.0 days earlier.

Parameters:

date - the current date

Returns:

the the mean EUV S10B index

Throws:

PatriusException - if the date is out of range of available data

getAp

double getAp(AbsoluteDate date)
      throws PatriusException

Get the Geomagnetic planetary 3-hour index A_p. Tabular time 6.7 hours earlier.

Parameters:

date - the current date

Returns:

the A_p index

Throws:

PatriusException - if the date is out of range of available data

checkSolarActivityData

void checkSolarActivityData(AbsoluteDate start,
                            AbsoluteDate end)
                     throws PatriusException

This methods throws an exception if the user did not provide solar activity on the provided interval [start, end]. All models should implement their own method since the required data interval depends on the model.

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some solar activity data is missing