fr.cnes.sirius.patrius.forces.relativistic

Class SchwarzschildRelativisticEffect

java.lang.Object

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

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

fr.cnes.sirius.patrius.forces.relativistic.SchwarzschildRelativisticEffect

All Implemented Interfaces:

ForceModel, GradientModel, IJacobiansParameterizable, IParameterizable, Serializable

public class SchwarzschildRelativisticEffect
extends JacobiansParameterizable
implements ForceModel, GradientModel

Computation of the relativistic Schwarzschild effect.

This is the 1st order relativistic effect.

Since:

3.2

Version:

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

Author:

rodriguest

See Also:

Serialized Form

Concurrency :

not thread-safe

Constructor Summary

Constructors

Constructor and Description
SchwarzschildRelativisticEffect(double mu) Constructor with partial derivative computation by default.
SchwarzschildRelativisticEffect(double mu, boolean computePartialDerivativesPos, boolean computePartialDerivativesVel) Constructor.

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.
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.

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

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

SchwarzschildRelativisticEffect

public SchwarzschildRelativisticEffect(double mu,
                                       boolean computePartialDerivativesPos,
                                       boolean computePartialDerivativesVel)

Constructor.

Parameters:

mu - central body attraction coefficient

computePartialDerivativesPos - if partial derivatives wrt position have to be computed

computePartialDerivativesVel - if partial derivatives wrt velocity have to be computed

SchwarzschildRelativisticEffect

public SchwarzschildRelativisticEffect(double mu)

Constructor with partial derivative computation by default.

Parameters:

mu - central body attraction coefficient

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

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

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.. No parameter is supported by this force model.

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

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