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

Class Stela3StepsSolarActivity

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.Stela3StepsSolarActivity

All Implemented Interfaces:

IStelaSolarActivity, Serializable

public class Stela3StepsSolarActivity
extends StelaVariableSolarActivity

Class for variable solar activity using 3 steps method: keep variable file until date1, disperse file between date1 and date2 (using coefficients f107Coef and apCoef) and use random cycles after date2.

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
Stela3StepsSolarActivity(AbsoluteDate date1, AbsoluteDate date2, double f107Coef, double apCoef, List<Integer> solarActivityCycles, SolarActivityDataProvider reader) Constructor.
Stela3StepsSolarActivity(SolarActivityDataProvider reader) Basis constructor.

Method Summary

Modifier and Type	Method and Description
void	buildSolarActivity(AbsoluteDate startDate) Build solar activity.
Stela3StepsSolarActivity	copy() Copy the solar activity model.
double	getApCoef() Getter for the Ap dispersion coefficient.
AbsoluteDate	getDate1() Getter for the first date.
AbsoluteDate	getDate2() Getter for the second date.
TreeMap<AbsoluteDate,Double>	getEntireAPMap() Get Geomagnetic activity (AP map).
double	getF107Coef() Getter for the F10.7 dispersion coefficient.
List<Integer>	getSolarActivityCycles() Getter for the solar activity cycles list
String	toString() Get information of Solar Activity.
void	writeToFile(String fileName) Write solar activity array into file following STELA solar activity file pattern.

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

getAp, getEndDate, getInstantFluxValue, getLoadedPastCyclesSolarActivityReader, getMeanFlux, getSolarActivity, 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

Stela3StepsSolarActivity

public Stela3StepsSolarActivity(AbsoluteDate date1,
                                AbsoluteDate date2,
                                double f107Coef,
                                double apCoef,
                                List<Integer> solarActivityCycles,
                                SolarActivityDataProvider reader)
                         throws PatriusException,
                                IOException,
                                ParseException

Constructor.

Parameters:

date1 - first model date

date2 - second model date

f107Coef - F10.7 dispersion coefficient

apCoef - Ap dispersion coefficient

solarActivityCycles - solar activity cycles list

reader - solar activity reader

Throws:

PatriusException - if an error occur while reading the solar activity files

IOException - if an error occur while reading the solar activity files

ParseException - if an error occur while reading the solar activity files

Stela3StepsSolarActivity

public Stela3StepsSolarActivity(SolarActivityDataProvider reader)
                         throws PatriusException,
                                IOException,
                                ParseException

Basis constructor. F10.7 coefficient = 1 ; AP coefficient = 1

Parameters:

reader - solar activity reader

Throws:

PatriusException - if an error occur while reading the solar activity files

IOException - if an error occur while reading the solar activity files

ParseException - if an error occur while reading the solar activity files

Method Detail

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 Stela3StepsSolarActivity copy()
                              throws PatriusException,
                                     IOException,
                                     ParseException

Copy the solar activity model.

Specified by:

copy in interface IStelaSolarActivity

Overrides:

copy in class StelaVariableSolarActivity

Returns:

copied solar activity model

Throws:

PatriusException

IOException

ParseException

getSolarActivityCycles

public List<Integer> getSolarActivityCycles()

Getter for the solar activity cycles list

Returns:

the solar activity cycles list

getDate1

public AbsoluteDate getDate1()

Getter for the first date.

Returns:

the first date

getDate2

public AbsoluteDate getDate2()

Getter for the second date.

Returns:

the second date

getF107Coef

public double getF107Coef()

Getter for the F10.7 dispersion coefficient.

Returns:

the F10.7 dispersion coefficient

getApCoef

public double getApCoef()

Getter for the Ap dispersion coefficient.

Returns:

the Ap dispersion coefficient

buildSolarActivity

public void buildSolarActivity(AbsoluteDate startDate)

Build solar activity. The resulting solar activity is stored in solarFluxMap and solarAPMap. The resulting maps is a map following the pattern [date, solar activity] and built similarly as StelaPastCyclesSolarActivity.buildSolarActivity(AbsoluteDate).

Parameters:

startDate - simulation starting date

getEntireAPMap

public TreeMap<AbsoluteDate,Double> getEntireAPMap()

Get Geomagnetic activity (AP map).

Overrides:

getEntireAPMap in class StelaVariableSolarActivity

Returns:

AP map

writeToFile

public void writeToFile(String fileName)

Write solar activity array into file following STELA solar activity file pattern.

Parameters:

fileName - file name