fr.cnes.sirius.patrius.forces.radiation

Class RediffusedRadiationPressure

java.lang.Object

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

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

fr.cnes.sirius.patrius.forces.radiation.RediffusedRadiationPressure

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public final class RediffusedRadiationPressure
extends JacobiansParameterizable
implements ForceModel, GradientModel

Class that represents a rediffused radiative force.

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

Since:

1.2

Version:

$Id: RediffusedRadiationPressure.java 17582 2017-05-10 12:58:16Z bignon $

Author:

clauded

See Also:

Serialized Form

Concurrency :

conditionally thread-safe

Concurrency comment :

thread-safe if the CelestialBody attribute is.

Constructor Summary

Constructors

Constructor and Description
RediffusedRadiationPressure(CelestialPoint inSun, CelestialBodyFrame inBodyFrame, int inCorona, int inMeridian, IEmissivityModel inEmissivityModel, RediffusedRadiationSensitive inModel) Constructor.
RediffusedRadiationPressure(CelestialPoint inSun, CelestialBodyFrame inBodyFrame, int inCorona, int inMeridian, IEmissivityModel inEmissivityModel, RediffusedRadiationSensitive inModel, boolean computePD) Constructor.
RediffusedRadiationPressure(RediffusedRadiationPressure 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	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.
Assembly	getAssembly() Getter for the assembly used at construction.
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
CelestialBodyFrame	getInBodyFrame() Getter for the boby frame used at construction.
int	getInCorona() Getter for the number of corona used at construction.
IEmissivityModel	getInEmissivityModel() Getter for the emissivity model used at construction.
int	getInMeridian() Getter for the number of meridian used at construction.
CelestialPoint	getInSun() Getter for the coordinate of sun used at construction.
double	getK0Albedo() Getter for the albedo global multiplicative factor used at construction.
double	getK0Ir() Getter for the infrared global multiplicative factor used at construction.
boolean	isAlbedoComputed() Getter for the albedo indicator used at construction.
boolean	isIRComputed() Getter for the infrared indicator used at construction.

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.math.parameter.IParameterizable

getParameters, supportsParameter

Constructor Detail

RediffusedRadiationPressure

public RediffusedRadiationPressure(CelestialPoint inSun,
                                   CelestialBodyFrame inBodyFrame,
                                   int inCorona,
                                   int inMeridian,
                                   IEmissivityModel inEmissivityModel,
                                   RediffusedRadiationSensitive inModel)

Constructor.

Parameters:

inSun - coordinate of sun

inBodyFrame - boby frame

inCorona - number of corona

inMeridian - number of meridian

inEmissivityModel - emissivity model

inModel - redistributed radiative model

RediffusedRadiationPressure

public RediffusedRadiationPressure(CelestialPoint inSun,
                                   CelestialBodyFrame inBodyFrame,
                                   int inCorona,
                                   int inMeridian,
                                   IEmissivityModel inEmissivityModel,
                                   RediffusedRadiationSensitive inModel,
                                   boolean computePD)

Constructor.

Parameters:

inSun - coordinate of sun

inBodyFrame - boby frame

inCorona - number of corona

inMeridian - number of meridian

inEmissivityModel - emissivity model

inModel - redistributed radiative model

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

RediffusedRadiationPressure

public RediffusedRadiationPressure(RediffusedRadiationPressure 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

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

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

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.
K0ALBEDO_COEFFICIENT -->derivatives with respect to the K0 albedo global coefficient
K0IR_COEFFICIENT --> derivatives with respect to the K0 infrared global coefficient
ABSORPTION_COEFFICIENT --> derivatives with respect to the absorption coefficient
SPECULAR_COEFFICIENT --> derivatives with respect to the specular reflection coefficient
DIFFUSION_COEFFICIENT --> derivatives with respect to the diffusion reflection coefficient

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

getInSun

public CelestialPoint getInSun()

Getter for the coordinate of sun used at construction.

Returns:

the coordinate of sun.

getInBodyFrame

public CelestialBodyFrame getInBodyFrame()

Getter for the boby frame used at construction.

Returns:

the boby frame.

getInCorona

public int getInCorona()

Getter for the number of corona used at construction.

Returns:

the number of corona.

getInMeridian

public int getInMeridian()

Getter for the number of meridian used at construction.

Returns:

the number of meridian.

getInEmissivityModel

public IEmissivityModel getInEmissivityModel()

Getter for the emissivity model used at construction.

Returns:

the emissivity model.

isAlbedoComputed

public boolean isAlbedoComputed()

Getter for the albedo indicator used at construction.

Returns:

the albedo indicator.

isIRComputed

public boolean isIRComputed()

Getter for the infrared indicator used at construction.

Returns:

the infrared indicator.

getK0Albedo

public double getK0Albedo()

Getter for the albedo global multiplicative factor used at construction.

Returns:

the albedo global multiplicative factor.

getK0Ir

public double getK0Ir()

Getter for the infrared global multiplicative factor used at construction.

Returns:

the infrared global multiplicative factor.

getAssembly

public Assembly getAssembly()

Getter for the assembly used at construction.

Returns:

the assembly.

checkData

public 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]. 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