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

Interface IStelaSolarActivity

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractStelaSolarActivity, Stela3StepsSolarActivity, StelaConstantSolarActivity, StelaLOSConstantSolarActivity, StelaPastCyclesSolarActivity, StelaVariableDispersedSolarActivity, StelaVariableSolarActivity

public interface IStelaSolarActivity
extends Serializable

Interface for Stela solar activity models.

Since:

4.16

Author:

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

Method Summary

Modifier and Type	Method and Description
IStelaSolarActivity	copy() Copy the solar activity model.
double	getAp(AbsoluteDate date) Get Geomagnetic activity at a specified date.
double	getInstantFluxValue(AbsoluteDate date) Get Solar activity flux at a specified date.
StelaSolarActivityType	getSolActType() Get solar activity type.
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.
default void	setConstantAP(double inputAP) Set geomagnetic activity coefficient to the input value.
default void	setConstantF107(double inputF107) Set solar flux value to the input parameter's value.
String	toString() Get information of Solar Activity.

Method Detail

getInstantFluxValue

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

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

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

setConstantAP

default void setConstantAP(double inputAP)
                    throws PatriusException

Set geomagnetic activity coefficient to the input value. It should be used only if instantiated solar activity is a constant one.

Parameters:

inputAP - geomagnetic activity coefficient

Throws:

PatriusException - thrown if solar activity is variable

setConstantF107

default void setConstantF107(double inputF107)
                      throws PatriusException

Set solar flux value to the input parameter's value. It should be used only if instantiated solar activity is a constant one.

Parameters:

inputF107 - constant solar flux value

Throws:

PatriusException - Exceptions thrown if solar activity is variable.

getSolActType

StelaSolarActivityType getSolActType()

Get solar activity type. It can be either constant or variable.

Returns:

solar activity type

toString

String toString()

Get information of Solar Activity.

Overrides:

toString in class Object

Returns:

a string with all solar activity

copy

IStelaSolarActivity copy()
                  throws PatriusException,
                         IOException,
                         ParseException

Copy the solar activity model.

Returns:

copied solar activity model

Throws:

PatriusException

IOException

ParseException