fr.cnes.sirius.patrius.forces.atmospheres

Interface DTMInputParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

DTMSolarData, MarshallSolarActivityFutureEstimation

public interface DTMInputParameters
extends Serializable

Container for solar activity data, compatible with all DTM Atmosphere models. This model needs mean and instantaneous solar flux and geomagnetic incides to compute the local density. Mean solar flux is (for the moment) represented by the F10.7 indices. Instantaneous flux can be set to the mean value if the data is not available. Geomagnetic acivity is represented by the Kp indice, which goes from 1 (very low activity) to 9 (high activity).

All needed solar activity data can be found on the NOAA (National Oceanic and Atmospheric Administration) website.

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	get24HoursKp(AbsoluteDate date) Get the last 24H mean geomagnetic index.
double	getInstantFlux(AbsoluteDate date) Get the value of the instantaneous solar flux.
AbsoluteDate	getMaxDate() Gets the available data range maximum date.
double	getMeanFlux(AbsoluteDate date) Get the value of the mean solar flux.
AbsoluteDate	getMinDate() Gets the available data range minimum date.
double	getThreeHourlyKP(AbsoluteDate date) Get the value of the 3 hours geomagnetic 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.

getInstantFlux

double getInstantFlux(AbsoluteDate date)
               throws PatriusException

Get the value of the instantaneous solar flux.

Parameters:

date - the current date

Returns:

the instantaneous solar flux

Throws:

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

getMeanFlux

double getMeanFlux(AbsoluteDate date)
            throws PatriusException

Get the value of the mean solar flux.

Parameters:

date - the current date

Returns:

the mean solar flux

Throws:

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

getThreeHourlyKP

double getThreeHourlyKP(AbsoluteDate date)
                 throws PatriusException

Get the value of the 3 hours geomagnetic index. With a delay of 3 hours at pole to 6 hours at equator using: delay=6-abs(lat)*0.033 (lat in deg.)

Parameters:

date - the current date

Returns:

the 3H geomagnetic index

Throws:

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

get24HoursKp

double get24HoursKp(AbsoluteDate date)
             throws PatriusException

Get the last 24H mean geomagnetic index.

Parameters:

date - the current date

Returns:

the 24H geomagnetic 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