fr.cnes.sirius.patrius.forces.atmospheres.solarActivity.specialized

Class DTMSolarData

java.lang.Object

fr.cnes.sirius.patrius.forces.atmospheres.solarActivity.specialized.DTMSolarData

All Implemented Interfaces:

DTMInputParameters, Serializable

public class DTMSolarData
extends Object
implements DTMInputParameters

This class represents a solar data container adapted for the DTM2000 and DTM2012 atmosphere models

Since:

1.2

Author:

Rami Houdroge

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if SolarActivityDataProvider is thread-safe

Constructor Summary

Constructors

Constructor and Description
DTMSolarData(SolarActivityDataProvider solarData) Constructor.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DTMSolarData

public DTMSolarData(SolarActivityDataProvider solarData)

Constructor. Builds an instance of a solar data provider adapted for the DTM2000 and DTM2012 atmosphere models

Parameters:

solarData - input solar data

Method Detail

getInstantFlux

public double getInstantFlux(AbsoluteDate date)
                      throws PatriusException

Get the value of the instantaneous solar flux.

Specified by:

getInstantFlux in interface DTMInputParameters

Parameters:

date - the current date

Returns:

the instantaneous solar flux

Throws:

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

getMeanFlux

public double getMeanFlux(AbsoluteDate date)
                   throws PatriusException

Get the value of the mean solar flux.

Specified by:

getMeanFlux in interface DTMInputParameters

Parameters:

date - the current date

Returns:

the mean solar flux

Throws:

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

getMinDate

public AbsoluteDate getMinDate()

Gets the available data range minimum date.

Specified by:

getMinDate in interface DTMInputParameters

Returns:

the minimum date.

getMaxDate

public AbsoluteDate getMaxDate()

Gets the available data range maximum date.

Specified by:

getMaxDate in interface DTMInputParameters

Returns:

the maximum date.

getThreeHourlyKP

public 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.)

Specified by:

getThreeHourlyKP in interface DTMInputParameters

Parameters:

date - the current date

Returns:

the 3H geomagnetic index

Throws:

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

get24HoursKp

public double get24HoursKp(AbsoluteDate date)
                    throws PatriusException

Get the last 24H mean geomagnetic index.

Specified by:

get24HoursKp in interface DTMInputParameters

Parameters:

date - the current date

Returns:

the 24H geomagnetic index

Throws:

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

checkSolarActivityData

public 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.

Specified by:

checkSolarActivityData in interface DTMInputParameters

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some solar activity data is missing