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

Class AbstractMSISE2000SolarData

java.lang.Object

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

All Implemented Interfaces:

MSISE2000InputParameters, Serializable

Direct Known Subclasses:

ClassicalMSISE2000SolarData, ContinuousMSISE2000SolarData

public abstract class AbstractMSISE2000SolarData
extends Object
implements MSISE2000InputParameters

This abstract class represents a solar data container adapted for the MSISE2000 atmosphere model. It implements the methods and constants common to the MSISE2000 data providers.

Since:

2.2

Version:

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

Author:

Rami Houdroge

See Also:

ContinuousMSISE2000SolarData, ClassicalMSISE2000SolarData, Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if SolarActivityDataProvider and class implementation are thread-safe

Field Summary

Fields

Modifier and Type	Field and Description
protected SolarActivityDataProvider	data Solar data container
protected static int	EO 81 days
protected static double	FOUR_POINT_FIVE Constant 4.5
protected static double	HOUR Seconds in an hour
protected static double	ONE_POINT_FIVE Constant 1.5
protected static double	SEVEN_POINT_FIVE Constant 7.5
protected static double	SIXTY Constant 60
protected static double	TEN_POINT_FIVE Constant 10.5
protected static double	THIRTY_SIX Constant 36
protected static double	TWELVE Constant 12

Constructor Summary

Constructors

Constructor and Description
AbstractMSISE2000SolarData(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].
abstract 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.

Methods inherited from class java.lang.Object

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

Field Detail

EO

protected static final int EO

81 days

See Also:

Constant Field Values

HOUR

protected static final double HOUR

Seconds in an hour

See Also:

Constant Field Values

TWELVE

protected static final double TWELVE

Constant 12

See Also:

Constant Field Values

THIRTY_SIX

protected static final double THIRTY_SIX

Constant 36

See Also:

Constant Field Values

SIXTY

protected static final double SIXTY

Constant 60

See Also:

Constant Field Values

ONE_POINT_FIVE

protected static final double ONE_POINT_FIVE

Constant 1.5

See Also:

Constant Field Values

FOUR_POINT_FIVE

protected static final double FOUR_POINT_FIVE

Constant 4.5

See Also:

Constant Field Values

SEVEN_POINT_FIVE

protected static final double SEVEN_POINT_FIVE

Constant 7.5

See Also:

Constant Field Values

TEN_POINT_FIVE

protected static final double TEN_POINT_FIVE

Constant 10.5

See Also:

Constant Field Values

data

protected SolarActivityDataProvider data

Solar data container

Constructor Detail

AbstractMSISE2000SolarData

public AbstractMSISE2000SolarData(SolarActivityDataProvider solarData)

Constructor. Builds an instance of a solar data provider adapted for the MSISE2000 atmosphere model

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 MSISE2000InputParameters

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

Specified by:

getMeanFlux in interface MSISE2000InputParameters

Parameters:

date - the current date

Returns:

the mean solar flux

Throws:

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

getApValues

public abstract double[] getApValues(AbsoluteDate date)
                              throws PatriusException

Get the array containing the 7 ap values

Specified by:

getApValues in interface MSISE2000InputParameters

Parameters:

date - the current date

Returns:

the Ap values

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 MSISE2000InputParameters

Returns:

the minimum date.

getMaxDate

public AbsoluteDate getMaxDate()

Gets the available data range maximum date.

Specified by:

getMaxDate in interface MSISE2000InputParameters

Returns:

the maximum date.

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 MSISE2000InputParameters

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some solar activity data is missing