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

Class SolarActivityToolbox

java.lang.Object

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

public final class SolarActivityToolbox
extends Object

Solar activity toolbox. Has methods to compute mean flux values, to convert from ap to kp.

Since:

1.2

Version:

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

Author:

Rami Houdroge

Concurrency :

immutable

Method Summary

Modifier and Type	Method and Description
static double	apToKp(double ap) Convert a single ap coefficient to a kp coefficient
static double[]	apToKp(double[] ap) Convert an array
static void	checkApSanity(double ap) Check that the specified ap coefficient is within bounds
static void	checkKpSanity(double kp) Check that the specified kp coefficient is within bounds
static double	getAverageFlux(AbsoluteDate date1, AbsoluteDate date2, SolarActivityDataProvider data) Compute mean flux between given dates.
static double	getMeanAp(AbsoluteDate minDate, AbsoluteDate maxDate, SolarActivityDataProvider data) Compute mean flux between given dates (rectangular rule)
static double	getMeanFlux(AbsoluteDate date1, AbsoluteDate date2, SolarActivityDataProvider data) Compute mean flux between given dates using trapezoidal rule
static double	kpToAp(double kp) Convert a single kp coefficient to a ap coefficient
static double[]	kpToAp(double[] kp) Convert an array

Methods inherited from class java.lang.Object

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

Method Detail

apToKp

public static double apToKp(double ap)

Convert a single ap coefficient to a kp coefficient

Parameters:

ap - coefficient to convert

Returns:

corresponding kp coefficient, linear interpolation

kpToAp

public static double kpToAp(double kp)

Convert a single kp coefficient to a ap coefficient

Parameters:

kp - coefficient to convert

Returns:

corresponding ap coefficient, linear interpolation

apToKp

public static double[] apToKp(double[] ap)

Convert an array

Parameters:

ap - array to convert

Returns:

corresponding kp array

kpToAp

public static double[] kpToAp(double[] kp)

Convert an array

Parameters:

kp - array to convert

Returns:

corresponding ap array

getMeanAp

public static double getMeanAp(AbsoluteDate minDate,
                               AbsoluteDate maxDate,
                               SolarActivityDataProvider data)
                        throws PatriusException

Compute mean flux between given dates (rectangular rule)

Parameters:

minDate - first date for mean flux computation

maxDate - last date for mean flux computation

data - solar data

Returns:

the averaged solar flux over interval [date1, date2]

Throws:

PatriusException - if not enough data to cover timespan or if date2 is set before date1

getMeanFlux

public static double getMeanFlux(AbsoluteDate date1,
                                 AbsoluteDate date2,
                                 SolarActivityDataProvider data)
                          throws PatriusException

Compute mean flux between given dates using trapezoidal rule

Parameters:

date1 - first date for mean flux computation

date2 - last date for mean flux computation

data - solar data

Returns:

the averaged (trapezoidal rule) solar flux over interval [date1, date2]

Throws:

PatriusException - if not enough data to cover timespan or if date2 is set before date1

getAverageFlux

public static double getAverageFlux(AbsoluteDate date1,
                                    AbsoluteDate date2,
                                    SolarActivityDataProvider data)
                             throws PatriusException

Compute mean flux between given dates.

Parameters:

date1 - first date for mean flux computation

date2 - last date for mean flux computation

data - solar data

Returns:

the averaged (arithmetic mean) solar flux over interval [date1, date2]

Throws:

PatriusException - if not enough data to cover timespan or if date2 is set before date1

checkApSanity

public static void checkApSanity(double ap)

Check that the specified ap coefficient is within bounds

Parameters:

ap - ap coefficient

checkKpSanity

public static void checkKpSanity(double kp)

Check that the specified kp coefficient is within bounds

Parameters:

kp - kp coefficient