fr.cnes.sirius.patrius.forces.radiation

Class SolarRadiationPressureEllipsoid

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

fr.cnes.sirius.patrius.forces.radiation.SolarRadiationPressureEllipsoid

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public class SolarRadiationPressureEllipsoid
extends JacobiansParameterizable
implements ForceModel, GradientModel

Solar radiation pressure force model with spheroids (taking ellipsoid shape of occulting body into account). Based on the other implementation SolarRadiationPressureCircular for a spherical occulting body.

The implementation of this class enables the computation of partial derivatives with respect to absorption, specular reflection or diffusion reflection coefficients.

Eclipses computation can be deactivated by using setEclipsesComputation(boolean). By default, eclipses are taken into account.

This class allows to consider any occulting body (Earth, Moon, etc.). In case of multiple occulting bodies, the assumption is made that only one body occults the spacecraft at a time.

Since:

1.2

Version:

$Id: PatriusSolarRadiationPressure.java 18114 2017-10-04 09:32:13Z bignon $

Author:

Rami Houdroge

See Also:

Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

fields use Frames

Field Summary

Fields

Modifier and Type	Field and Description
static String	REFERENCE_FLUX Normalized reference flux.

Constructor Summary

Constructors

Constructor and Description
SolarRadiationPressureEllipsoid(double dRef, double pRef, PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, Assembly assembly, double multiplicativeFactorIn) Creates a new instance.
SolarRadiationPressureEllipsoid(double dRef, double pRef, PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel) Complete constructor.
SolarRadiationPressureEllipsoid(double dRef, double pRef, PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel, boolean computePD) Complete constructor.
SolarRadiationPressureEllipsoid(Parameter referenceFlux, PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel) Complete constructor using Parameter.
SolarRadiationPressureEllipsoid(Parameter referenceFlux, PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel, boolean computePD) Complete constructor using Parameter.
SolarRadiationPressureEllipsoid(PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel) Simple constructor with default reference values.
SolarRadiationPressureEllipsoid(PVCoordinatesProvider sunBody, GeometricBodyShape occultingBody, RadiationSensitive spacecraftModel, boolean computePD) Simple constructor with default reference values.
SolarRadiationPressureEllipsoid(SolarRadiationPressureEllipsoid otherInstance, Assembly assembly) Creates a new instance from the data in another one but with a different assembly.

Method Summary

Modifier and Type	Method and Description
void	addContribution(SpacecraftState s, TimeDerivativesEquations adder) Compute the contribution of the force model to the perturbing acceleration.
void	addDAccDParam(SpacecraftState s, Parameter param, double[] dAccdParam) Compute acceleration derivatives with respect to additional parameters.
void	addDAccDState(SpacecraftState s, double[][] dAccdPos, double[][] dAccdVel) Compute acceleration derivatives with respect to state parameters.
void	addOccultingBody(GeometricBodyShape body) Add an occulting body.
void	checkData(AbsoluteDate start, AbsoluteDate end) This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end].
Vector3D	computeAcceleration(SpacecraftState s) Compute the acceleration due to the force.
boolean	computeGradientPosition() This method returns true if the acceleration partial derivatives with respect to position have to be computed.
boolean	computeGradientVelocity() This method returns true if the acceleration partial derivatives with respect to velocity have to be computed.
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
double	getLightningRatio(Vector3D satSunVector, GeometricBodyShape occultingBody, Vector3D position, Frame frame, AbsoluteDate date) Get the lightning ratio ([0-1]) for provided occulting body.
double	getMultiplicativeFactor()
List<GeometricBodyShape>	getOccultingBodies() Getter for the occulting bodies.
Parameter	getReferenceFlux() Get the normalized reference flux parameter
Vector3D	getSolarFlux(SpacecraftState s) Compute solar flux.
PVCoordinatesProvider	getSunBody() Getter for the Sun model used at construction.
boolean	isEclipseComputation() Returns flag indicating if eclipses should be taken into account.
void	setEclipsesComputation(boolean eclipsesComputationFlagIn) Setter for enabling/disabling eclipses computation.

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.JacobiansParameterizable

addJacobiansParameter, addJacobiansParameter, addJacobiansParameter, supportsJacobianParameter

Methods inherited from class fr.cnes.sirius.patrius.math.parameter.Parameterizable

addAllParameters, addAllParameters, addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.cnes.sirius.patrius.forces.ForceModel

enrichParameterDescriptors

Methods inherited from interface fr.cnes.sirius.patrius.math.parameter.IParameterizable

getParameters, supportsParameter

Field Detail

REFERENCE_FLUX

public static final String REFERENCE_FLUX

Normalized reference flux.

See Also:

Constant Field Values

Constructor Detail

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel)

Simple constructor with default reference values.

When this constructor is used, the reference values are:

• d_ref = 149597870000.0 m
• p_ref = 4.56 10^-6 N/m²

Parameters:

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel,
                                       boolean computePD)

Simple constructor with default reference values.

When this constructor is used, the reference values are:

• d_ref = 149597870000.0 m
• p_ref = 4.56 10^-6 N/m²

Parameters:

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

computePD - true if partial derivatives wrt position have to be computed

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(double dRef,
                                       double pRef,
                                       PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel)

Complete constructor.

Note that reference solar radiation pressure pRef in N/m² is linked to solar flux SF in W/m² using formula pRef = SF/c where c is the speed of light (299792458 m/s). So at 1UA a 1367 W/m² solar flux is a 4.56 10^-6 N/m² solar radiation pressure.

Parameters:

dRef - reference distance for the solar radiation pressure (m)

pRef - reference solar radiation pressure at dRef (N/m²)

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(double dRef,
                                       double pRef,
                                       PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel,
                                       boolean computePD)

Complete constructor.

Note that reference solar radiation pressure pRef in N/m² is linked to solar flux SF in W/m² using formula pRef = SF/c where c is the speed of light (299792458 m/s). So at 1UA a 1367 W/m² solar flux is a 4.56 10^-6 N/m² solar radiation pressure.

Parameters:

dRef - reference distance for the solar radiation pressure (m)

pRef - reference solar radiation pressure at dRef (N/m²)

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

computePD - true if partial derivatives wrt position have to be computed

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(Parameter referenceFlux,
                                       PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel)

Complete constructor using Parameter.

Parameters:

referenceFlux - the parameter representing the normalized reference flux

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(Parameter referenceFlux,
                                       PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       RadiationSensitive spacecraftModel,
                                       boolean computePD)

Complete constructor using Parameter.

Parameters:

referenceFlux - the parameter representing the normalized reference flux

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

spacecraftModel - the object physical and geometrical information

computePD - true if partial derivatives wrt position have to be computed

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(double dRef,
                                       double pRef,
                                       PVCoordinatesProvider sunBody,
                                       GeometricBodyShape occultingBody,
                                       Assembly assembly,
                                       double multiplicativeFactorIn)

Creates a new instance.

Parameters:

dRef - reference distance for the solar radiation pressure (m)

pRef - reference solar radiation pressure at dRef (N/m²)

sunBody - Sun model

occultingBody - occulting body model (for umbra/penumbra computation)

assembly - assembly with aerodynamic properties

multiplicativeFactorIn - multiplicative factor.

SolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid(SolarRadiationPressureEllipsoid otherInstance,
                                       Assembly assembly)

Creates a new instance from the data in another one but with a different assembly.

Parameters:

otherInstance - the other instance

assembly - the new assembly

Method Detail

getSolarFlux

public Vector3D getSolarFlux(SpacecraftState s)
                      throws PatriusException

Compute solar flux.

Parameters:

s - spacecraft state

Returns:

coefficient for acceleration computation

Throws:

PatriusException - thrown if Sun position cannot be retrieved

computeAcceleration

public Vector3D computeAcceleration(SpacecraftState s)
                             throws PatriusException

Compute the acceleration due to the force.

Specified by:

computeAcceleration in interface ForceModel

Parameters:

s - current state information: date, kinematics, attitude

Returns:

acceleration in the SpacecraftState frame

Throws:

PatriusException - if some specific error occurs

addContribution

public void addContribution(SpacecraftState s,
                            TimeDerivativesEquations adder)
                     throws PatriusException

Compute the contribution of the force model to the perturbing acceleration.

Specified by:

addContribution in interface ForceModel

Parameters:

s - current state information: date, kinematics, attitude

adder - object where the contribution should be added

Throws:

PatriusException - if some specific error occurs

getLightningRatio

public double getLightningRatio(Vector3D satSunVector,
                                GeometricBodyShape occultingBody,
                                Vector3D position,
                                Frame frame,
                                AbsoluteDate date)
                         throws PatriusException

Get the lightning ratio ([0-1]) for provided occulting body.

Parameters:

satSunVector - Satellite-Sun vector

occultingBody - occulting body

position - the satellite's position in the selected frame.

frame - in which is defined the position

date - the date

Returns:

lightning ratio

Throws:

PatriusException - if an error occurs

getEventsDetectors

public EventDetector[] getEventsDetectors()

Get the discrete events related to the model.

Specified by:

getEventsDetectors in interface ForceModel

Returns:

array of events detectors or null if the model is not related to any discrete events

addDAccDState

public void addDAccDState(SpacecraftState s,
                          double[][] dAccdPos,
                          double[][] dAccdVel)
                   throws PatriusException

Compute acceleration derivatives with respect to state parameters.

Specified by:

addDAccDState in interface IJacobiansParameterizable

Parameters:

s - spacecraft state

dAccdPos - acceleration derivatives with respect to position

dAccdVel - acceleration derivatives with respect to velocity

Throws:

PatriusException - if derivatives cannot be computed

addDAccDParam

public void addDAccDParam(SpacecraftState s,
                          Parameter param,
                          double[] dAccdParam)
                   throws PatriusException

Compute acceleration derivatives with respect to additional parameters.

Specified by:

addDAccDParam in interface IJacobiansParameterizable

Parameters:

s - spacecraft state

param - the parameter with respect to which derivatives are required

dAccdParam - acceleration derivatives with respect to specified parameters

Throws:

PatriusException - if derivatives cannot be computed

computeGradientPosition

public boolean computeGradientPosition()

This method returns true if the acceleration partial derivatives with respect to position have to be computed.

Specified by:

computeGradientPosition in interface GradientModel

Returns:

true if the derivatives have to be computed, false otherwise

computeGradientVelocity

public boolean computeGradientVelocity()

This method returns true if the acceleration partial derivatives with respect to velocity have to be computed.

Specified by:

computeGradientVelocity in interface GradientModel

Returns:

true if the derivatives have to be computed, false otherwise

getSunBody

public PVCoordinatesProvider getSunBody()

Getter for the Sun model used at construction.

Returns:

the Sun model.

getOccultingBodies

public List<GeometricBodyShape> getOccultingBodies()

Getter for the occulting bodies.

Returns:

the occulting bodies.

getMultiplicativeFactor

public double getMultiplicativeFactor()

Returns:

the multiplicativeFactor

getReferenceFlux

public Parameter getReferenceFlux()

Get the normalized reference flux parameter

Returns:

flux parameter

checkData

public void checkData(AbsoluteDate start,
                      AbsoluteDate end)
               throws PatriusException

This methods throws an exception if the user did not provide all the required data to perform model call on provided range [start; end]. It is the responsibility of the model implementation to properly throw exceptions (for example DragForce will throw an exception if solar activity data is missing in the range [start, end]).

Specified by:

checkData in interface ForceModel

Parameters:

start - range start date

end - range end date

Throws:

PatriusException - thrown if some data is missing

setEclipsesComputation

public void setEclipsesComputation(boolean eclipsesComputationFlagIn)

Setter for enabling/disabling eclipses computation.

Parameters:

eclipsesComputationFlagIn - true if eclipses should be taken into account, false otherwise

isEclipseComputation

public boolean isEclipseComputation()

Returns flag indicating if eclipses should be taken into account.

Returns:

flag indicating if eclipses should be taken into account

addOccultingBody

public final void addOccultingBody(GeometricBodyShape body)

Add an occulting body.

Parameters:

body - occulting body to add