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

Interface SolarActivityDataProvider

All Superinterfaces:

Serializable

All Known Implementing Classes:

ACSOLFormatReader, ConstantSolarActivity, ExtendedSolarActivityWrapper, NOAAFormatReader, SolarActivityDataReader

public interface SolarActivityDataProvider
extends Serializable

Interface for solar activity data providers, to be used for atmosphere models

Since:

1.1

Version:

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

Author:

Rami Houdroge

Method Summary

Modifier and Type	Method and Description
default void	checkApKpValidity(AbsoluteDate start, AbsoluteDate end) Check that solar data (ap/kp) are available in the user range [start; end].
default void	checkFluxValidity(AbsoluteDate start, AbsoluteDate end) Check that solar data (flux) are available in the user range [start; end].
double	getAp(AbsoluteDate date) Get Ap value at given user date
AbsoluteDate	getApKpMaxDate() Get maximum date of ap / kp values
AbsoluteDate	getApKpMinDate() Get minimum date of ap / kp values
SortedMap<AbsoluteDate,Double[]>	getApKpValues(AbsoluteDate date1, AbsoluteDate date2) Get ap / kp values between the given dates
AbsoluteDate	getFluxMaxDate() Get maximum date of flux values
AbsoluteDate	getFluxMinDate() Get minimum date of flux values
double	getInstantFluxValue(AbsoluteDate date) Get instant flux values at the given dates (possibly interpolated)
SortedMap<AbsoluteDate,Double>	getInstantFluxValues(AbsoluteDate date1, AbsoluteDate date2) Get raw instant flux values between the given dates
double	getKp(AbsoluteDate date) Get Kp value at given user date
AbsoluteDate	getMaxDate() Get maximum date at which both flux and ap values are available
AbsoluteDate	getMinDate() Get minimum date at which both flux and ap values are available
double	getStepApKp() Returns the step for Ap/Kp values.
double	getStepF107() Returns the step for F107 values.

Method Detail

getMinDate

AbsoluteDate getMinDate()

Get minimum date at which both flux and ap values are available

Returns:

a date

getMaxDate

AbsoluteDate getMaxDate()

Get maximum date at which both flux and ap values are available

Returns:

a date

getFluxMinDate

AbsoluteDate getFluxMinDate()

Get minimum date of flux values

Returns:

a date

getFluxMaxDate

AbsoluteDate getFluxMaxDate()

Get maximum date of flux values

Returns:

a date

getApKpMinDate

AbsoluteDate getApKpMinDate()

Get minimum date of ap / kp values

Returns:

a date

getApKpMaxDate

AbsoluteDate getApKpMaxDate()

Get maximum date of ap / kp values

Returns:

a date

getInstantFluxValues

SortedMap<AbsoluteDate,Double> getInstantFluxValues(AbsoluteDate date1,
                                                    AbsoluteDate date2)
                                             throws PatriusException

Get raw instant flux values between the given dates

Parameters:

date1 - first date

date2 - second date

Returns:

submap of instant flux values sorted according to date

Throws:

PatriusException - if no solar activity at date

getInstantFluxValue

double getInstantFluxValue(AbsoluteDate date)
                    throws PatriusException

Get instant flux values at the given dates (possibly interpolated)

Parameters:

date - user date

Returns:

instant flux values

Throws:

PatriusException - if no solar activity at date

getApKpValues

SortedMap<AbsoluteDate,Double[]> getApKpValues(AbsoluteDate date1,
                                               AbsoluteDate date2)
                                        throws PatriusException

Get ap / kp values between the given dates

Parameters:

date1 - first date

date2 - second date

Returns:

submap of instant flux values sorted according to date

Throws:

PatriusException - if no solar activity at date

getAp

double getAp(AbsoluteDate date)
      throws PatriusException

Get Ap value at given user date

Parameters:

date - user date

Returns:

Ap value

Throws:

PatriusException - thrown if computation failed

getKp

double getKp(AbsoluteDate date)
      throws PatriusException

Get Kp value at given user date

Parameters:

date - user date

Returns:

Kp value

Throws:

PatriusException - thrown if computation failed

checkFluxValidity

default void checkFluxValidity(AbsoluteDate start,
                               AbsoluteDate end)

Check that solar data (flux) are available in the user range [start; end].

Parameters:

start - range start date

end - range end date

checkApKpValidity

default void checkApKpValidity(AbsoluteDate start,
                               AbsoluteDate end)

Check that solar data (ap/kp) are available in the user range [start; end].

Parameters:

start - range start date

end - range end date

getStepApKp

double getStepApKp()
            throws PatriusException

Returns the step for Ap/Kp values.

Returns:

the step for Ap/Kp values

Throws:

PatriusException - thrown if computation failed

getStepF107

double getStepF107()
            throws PatriusException

Returns the step for F107 values.

Returns:

the step for F107 values

Throws:

PatriusException - thrown if computation failed