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

Class StelaVariableDispersedSolarActivity

java.lang.Object

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

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

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

All Implemented Interfaces:

IStelaSolarActivity, Serializable

public class StelaVariableDispersedSolarActivity
extends StelaVariableSolarActivity

Class for variable solar activity with a multiplicative coefficient applied.

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 inherited from class fr.cnes.sirius.patrius.stela.forces.solaractivity.variable.StelaVariableSolarActivity

CONST_ONE_ON_EIGHT, entireApKPMap, entireFluxMap, INTERPOLATION_INTERVAL, reader, timeScale

Constructor Summary

Constructors

Constructor and Description
StelaVariableDispersedSolarActivity(double apCoef, double f107Coef, SolarActivityDataProvider reader) Constructor of a variable solar activity with a multiplicative coefficient.
StelaVariableDispersedSolarActivity(SolarActivityDataProvider reader) Empty constructor.

Method Summary

Modifier and Type	Method and Description
StelaVariableDispersedSolarActivity	copy() Copy the solar activity model.
double	getAp(AbsoluteDate date) Get Geomagnetic activity at a specified date.
double	getApCoef() Get the AP coefficient of the variable solar activity.
TreeMap<AbsoluteDate,Double>	getEntireAPMap() Get Geomagnetic activity (AP map).
double	getFluxCoef() Get the F10.7 coefficient of the variable solar activity.
double	getInstantFluxValue(AbsoluteDate date) Get Solar activity flux at a specified date.
double[]	getSolarActivity(AbsoluteDate dateIn) Get Solar activity coefficients at a specified date, in the following order: daily flux, mean flux, Ap1, Ap2, Ap3, Ap4, Ap5, Ap6, Ap7.
String	toString() Get information of Solar Activity.

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

getEndDate, getLoadedPastCyclesSolarActivityReader, getMeanFlux, getStartDate, retrieveCurrentMaps, setAPMap, setSolarFluxMap

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

Constructor Detail

StelaVariableDispersedSolarActivity

public StelaVariableDispersedSolarActivity(double apCoef,
                                           double f107Coef,
                                           SolarActivityDataProvider reader)
                                    throws PatriusException

Constructor of a variable solar activity with a multiplicative coefficient.

Parameters:

apCoef - multiplicative coefficient for AP

f107Coef - multiplicative coefficient for F10.7

reader - the solar activity reader

Throws:

PatriusException

StelaVariableDispersedSolarActivity

public StelaVariableDispersedSolarActivity(SolarActivityDataProvider reader)
                                    throws PatriusException

Empty constructor.
Default values are set: apCoef = 0 ; f107Coef = 0

Parameters:

reader - the solar activity reader

Throws:

PatriusException - for an initialization error

Method Detail

getInstantFluxValue

public double getInstantFluxValue(AbsoluteDate date)
                           throws PatriusException

Get Solar activity flux at a specified date.

Specified by:

getInstantFluxValue in interface IStelaSolarActivity

Overrides:

getInstantFluxValue in class StelaVariableSolarActivity

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.

Specified by:

getAp in interface IStelaSolarActivity

Overrides:

getAp in class StelaVariableSolarActivity

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

Specified by:

getSolarActivity in interface IStelaSolarActivity

Overrides:

getSolarActivity in class StelaVariableSolarActivity

Parameters:

dateIn - 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 StelaVariableSolarActivity

Returns:

a string with all solar activity

copy

public StelaVariableDispersedSolarActivity copy()
                                         throws PatriusException

Copy the solar activity model.

Specified by:

copy in interface IStelaSolarActivity

Overrides:

copy in class StelaVariableSolarActivity

Returns:

copied solar activity model

Throws:

PatriusException

getApCoef

public double getApCoef()

Get the AP coefficient of the variable solar activity.

Returns:

the AP coefficient of the variable solar activity.

getFluxCoef

public double getFluxCoef()

Get the F10.7 coefficient of the variable solar activity.

Returns:

the F10.7 coefficient of the variable solar activity.

getEntireAPMap

public TreeMap<AbsoluteDate,Double> getEntireAPMap()

Get Geomagnetic activity (AP map).

Overrides:

getEntireAPMap in class StelaVariableSolarActivity

Returns:

AP map