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

Class StelaPastCyclesSolarActivity

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

All Implemented Interfaces:

IStelaSolarActivity, Serializable

public class StelaPastCyclesSolarActivity
extends StelaVariableSolarActivity

Class for variable solar activity using past cycles. Past solar activity cycles are stored in the configuration folder. Each cycle is of length of about 11 years. This solar activity builds a solar activity file from the sequence of chosen cycles (given by their number). Then the start of first cycle (in days) is also chosen (so that solar activity does not always start with low values).

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
StelaPastCyclesSolarActivity(int solarActivityFirstDay, List<Integer> solarActivityCycles) Constructor.
StelaPastCyclesSolarActivity(StelaPastCyclesData pastCyclesData) Constructor.

Method Summary

Modifier and Type	Method and Description
void	buildSolarActivity(AbsoluteDate startDate) Build solar activity using past cycles.
StelaPastCyclesSolarActivity	copy() Copy the solar activity model.
void	emptyMaps() Empty maps.
TreeMap<AbsoluteDate,Double>	getEntireAPMap() Get Geomagnetic activity (AP map).
List<Integer>	getSolarActivityCycles() Getter for the solar activity cycles list
int	getSolarActivityFirstDay() Getter for the solar activity first day.
boolean	isAdditionalCycle() Getter for the additional cycle flag.
protected void	retrieveCurrentMaps() Read AP and F10.7 maps in the solar activity file
String	toString() Get information of Solar Activity.

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

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

StelaPastCyclesSolarActivity

public StelaPastCyclesSolarActivity(int solarActivityFirstDay,
                                    List<Integer> solarActivityCycles)
                             throws PatriusException,
                                    IOException,
                                    ParseException

Constructor.

Parameters:

solarActivityFirstDay - solar activity first day of first cycle (in number of days). It should then be a number between 1 and the size of the first cycles in days.

solarActivityCycles - solar activity cycles sequence. The sequence must be long enough to contain the whole simulation. As cycles are roughly 11 years long, a 100 years simulation will require 10 cycles (9 might not be enough).

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

StelaPastCyclesSolarActivity

public StelaPastCyclesSolarActivity(StelaPastCyclesData pastCyclesData)
                             throws PatriusException,
                                    IOException,
                                    ParseException

Constructor.

Parameters:

pastCyclesData - past cycles data

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 StelaPastCyclesSolarActivity 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

retrieveCurrentMaps

protected void retrieveCurrentMaps()

Read AP and F10.7 maps in the solar activity file

Overrides:

retrieveCurrentMaps in class StelaVariableSolarActivity

getSolarActivityFirstDay

public int getSolarActivityFirstDay()

Getter for the solar activity first day.

Returns:

the solar activity first day

getSolarActivityCycles

public List<Integer> getSolarActivityCycles()

Getter for the solar activity cycles list

Returns:

the solar activity cycles list

isAdditionalCycle

public boolean isAdditionalCycle()

Getter for the additional cycle flag.

Returns:

the additional cycle flag

emptyMaps

public void emptyMaps()

Empty maps.

buildSolarActivity

public void buildSolarActivity(AbsoluteDate startDate)

Build solar activity using past cycles. The resulting solar activity is stored in solarFluxMap and solarAPMap. The resulting maps is a map following the pattern [date (CNES JD), solar activity] with date starting at simulation date (provided by startDate) and with solar activity starting at solar activity of first date of first cycle of cycles sequence.
For example, if simulation starting date is 15-06-2014 and first date of first cycle is day number 154 and cycles sequence is [2 1 3 4], then the resulting map will be:

• ...(some data is added if additional cycle is required)
• <15-06-2014, solar activity met at day number 154 of cycle number 2>
• <16-06-2014, solar activity met at day number 155 of cycle number 2>
• <17-06-2014, solar activity met at day number 156 of cycle number 2>
• ...(until the end of cycles sequence)

Note: there may be some values before in the map in case of needed additional cycle and first day of first cycle not being 1. But in any case, at startDate, solar activity value is the value met at first day of first cycle.

Parameters:

startDate - simulation starting date

getEntireAPMap

public TreeMap<AbsoluteDate,Double> getEntireAPMap()

Get Geomagnetic activity (AP map).

Overrides:

getEntireAPMap in class StelaVariableSolarActivity

Returns:

AP map