fr.cnes.sirius.patrius.forces.atmospheres

Interface MSISE2000InputParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractMSISE2000SolarData, ClassicalMSISE2000SolarData, ContinuousMSISE2000SolarData

public interface MSISE2000InputParameters
extends Serializable

Container for solar activity data, compatible with MSISE2000 Atmosphere model. This model needs mean and instantaneous solar flux and geomagnetic incides to compute the local density.

Since:

2.1

Version:

$Id: MSISE2000InputParameters.java 17582 2017-05-10 12:58:16Z bignon $

Author:

Rami Houdroge

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[]	getApValues(AbsoluteDate date) Get the array containing the 7 ap values
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 81 day average of F10.7 flux.
AbsoluteDate	getMinDate() Gets the available data range minimum date.

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 81 day average of F10.7 flux.

Parameters:

date - the current date

Returns:

the mean solar flux

Throws:

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

getApValues

double[] getApValues(AbsoluteDate date)
              throws PatriusException

Get the array containing the 7 ap values

Parameters:

date - the current date

Returns:

the Ap values

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