fr.cnes.sirius.patrius.stela.forces.solaractivity.variable

Class StelaVariableSolarActivity

java.lang.Object

fr.cnes.sirius.patrius.stela.forces.solaractivity.AbstractStelaSolarActivity

fr.cnes.sirius.patrius.stela.forces.solaractivity.variable.StelaVariableSolarActivity

All Implemented Interfaces:

IStelaSolarActivity, Serializable

Direct Known Subclasses:

Stela3StepsSolarActivity, StelaPastCyclesSolarActivity, StelaVariableDispersedSolarActivity

public class StelaVariableSolarActivity
extends AbstractStelaSolarActivity

Variable model of solar activity. This model uses the solar activity file provided in the configuration folder.

Since:

4.16

Author:

Mathis Guillemette HISTORY VERSION:4.16:OPENFD-389:25/04/2025:[STELA-PATRIUS] Activites solaires additionnelles END-HISTORY

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static double	CONST_ONE_ON_EIGHT Constant.
protected TreeMap<AbsoluteDate,Double[]>	entireApKPMap Entire AP Map
protected TreeMap<AbsoluteDate,Double>	entireFluxMap Entire Flux Map
protected static double	INTERPOLATION_INTERVAL Interpolation interval (in days).
protected SolarActivityDataProvider	reader Solar activity coefficients reader
protected TimeScale	timeScale TimeScale

Constructor Summary

Constructors

Modifier	Constructor and Description
	StelaVariableSolarActivity(SolarActivityDataProvider reader) Constructor of a variable solar activity model.
protected	StelaVariableSolarActivity(SolarActivityDataProvider reader, StelaSolarActivityType solarActivityType) Constructor of a solar activity model.

Method Summary

Modifier and Type	Method and Description
StelaVariableSolarActivity	copy() Copy the solar activity model.
double	getAp(AbsoluteDate date) Get Geomagnetic activity at a specified date.
protected AbsoluteDate	getEndDate() Get end date.
NavigableMap<AbsoluteDate,Double>	getEntireAPMap() Get Geomagnetic activity (AP map).
double	getInstantFluxValue(AbsoluteDate date) Get Solar activity flux at a specified date.
protected static StelaPastCyclesSolarActivityReader	getLoadedPastCyclesSolarActivityReader() Get the loaded past cycles solar activity reader
double	getMeanFlux(AbsoluteDate date, double[] weights) Compute weighted mean flux, given a weights array.
double[]	getSolarActivity(AbsoluteDate date) Get Solar activity coefficients at a specified date, in the following order: daily flux, mean flux, Ap1, Ap2, Ap3, Ap4, Ap5, Ap6, Ap7.
protected AbsoluteDate	getStartDate() Get start date.
protected void	retrieveCurrentMaps() Get AP and F10.7 maps from the solar activity reader with current dates
protected void	setAPMap(NavigableMap<AbsoluteDate,Double> newMap) Set the AP map.
protected void	setSolarFluxMap(NavigableMap<AbsoluteDate,Double> newMap) Set the solar flux map.
String	toString() Get information of Solar Activity.

Methods inherited from class fr.cnes.sirius.patrius.stela.forces.solaractivity.AbstractStelaSolarActivity

getSolActType, getStelaDoubleFormat

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.stela.forces.solaractivity.IStelaSolarActivity

setConstantAP, setConstantF107

Field Detail

INTERPOLATION_INTERVAL

protected static final double INTERPOLATION_INTERVAL

Interpolation interval (in days).

See Also:

Constant Field Values

CONST_ONE_ON_EIGHT

protected static final double CONST_ONE_ON_EIGHT

Constant.

See Also:

Constant Field Values

timeScale

protected final TimeScale timeScale

TimeScale

reader

protected final SolarActivityDataProvider reader

Solar activity coefficients reader

entireFluxMap

protected final TreeMap<AbsoluteDate,Double> entireFluxMap

Entire Flux Map

entireApKPMap

protected final TreeMap<AbsoluteDate,Double[]> entireApKPMap

Entire AP Map

Constructor Detail

StelaVariableSolarActivity

public StelaVariableSolarActivity(SolarActivityDataProvider reader)
                           throws PatriusException

Constructor of a variable solar activity model.

Parameters:

reader - the solar activity reader

Throws:

PatriusException - for an initialization error

StelaVariableSolarActivity

protected StelaVariableSolarActivity(SolarActivityDataProvider reader,
                                     StelaSolarActivityType solarActivityType)
                              throws PatriusException

Constructor of a solar activity model.

Parameters:

reader - the solar activity reader

solarActivityType - the solar activity type

Throws:

PatriusException - for an initialization error

Method Detail

getMeanFlux

public double getMeanFlux(AbsoluteDate date,
                          double[] weights)
                   throws PatriusException

Compute weighted mean flux, given a weights array.

Parameters:

date - date

weights - weights array

Returns:

weighted mean flux

Throws:

PatriusException - throw if computation failed

getInstantFluxValue

public double getInstantFluxValue(AbsoluteDate date)
                           throws PatriusException

Get Solar activity flux at a specified date.

Parameters:

date - a date

Returns:

solar activity daily flux

Throws:

PatriusException - thrown if a problem occurs while reading the solar activity file

getAp

public double getAp(AbsoluteDate date)
             throws PatriusException

Get Geomagnetic activity at a specified date.

Parameters:

date - a date

Returns:

geomagnetic activity

Throws:

PatriusException - thrown if a problem occurs while reading the solar activity file

getSolarActivity

public double[] getSolarActivity(AbsoluteDate date)
                          throws PatriusException

Get Solar activity coefficients at a specified date, in the following order: daily flux, mean flux, Ap1, Ap2, Ap3, Ap4, Ap5, Ap6, Ap7.

Parameters:

date - a date

Returns:

solar activity coefficients (solar flux and geomagnetic activity)

Throws:

PatriusException - thrown if a problem occurs while reading the solar activity file

toString

public String toString()

Get information of Solar Activity.

Specified by:

toString in interface IStelaSolarActivity

Overrides:

toString in class Object

Returns:

a string with all solar activity

copy

public StelaVariableSolarActivity copy()
                                throws PatriusException,
                                       IOException,
                                       ParseException

Copy the solar activity model.

Returns:

copied solar activity model

Throws:

PatriusException

IOException

ParseException

retrieveCurrentMaps

protected void retrieveCurrentMaps()
                            throws PatriusException

Get AP and F10.7 maps from the solar activity reader with current dates

Throws:

PatriusException

setSolarFluxMap

protected void setSolarFluxMap(NavigableMap<AbsoluteDate,Double> newMap)

Set the solar flux map.

Parameters:

newMap - the new solar flux map

setAPMap

protected void setAPMap(NavigableMap<AbsoluteDate,Double> newMap)

Set the AP map.

Parameters:

newMap - the new AP map

getStartDate

protected AbsoluteDate getStartDate()

Get start date.

Returns:

startKey

getEndDate

protected AbsoluteDate getEndDate()

Get end date.

Returns:

endKey

getEntireAPMap

public NavigableMap<AbsoluteDate,Double> getEntireAPMap()

Get Geomagnetic activity (AP map).

Returns:

AP map

getLoadedPastCyclesSolarActivityReader

protected static StelaPastCyclesSolarActivityReader getLoadedPastCyclesSolarActivityReader()
                                                                                    throws IOException,
                                                                                           ParseException,
                                                                                           PatriusException

Get the loaded past cycles solar activity reader

Returns:

the loaded past cycles solar activity reader

Throws:

IOException - if an error occur while the creation of InputStreams

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs