fr.cnes.sirius.patrius.forces.maneuvers

Class ContinuousThrustManeuver

java.lang.Object

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

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

fr.cnes.sirius.patrius.forces.maneuvers.ContinuousThrustManeuver

All Implemented Interfaces:

ForceModel, GradientModel, Maneuver, IJacobiansParameterizable, IParameterizable, PatriusStepHandler, Serializable

public class ContinuousThrustManeuver
extends JacobiansParameterizable
implements ForceModel, GradientModel, Maneuver, PatriusStepHandler

This class implements a thrust (constant or variable).

The maneuver is defined by a direction in satellite frame or in a frame defined by user or in a LOF with type defined by user. In first case, the current attitude of the spacecraft, defined by the current spacecraft state, will be used to convert the thrust inDirection in satellite frame into inertial frame when inDirection is defined in satellite frame. A typical case for tangential maneuvers is to use a LOF aligned attitude provider for state propagation and a velocity increment along the +X satellite axis.

The implementation of this class enables the computation of partial derivatives by finite differences with respect to thrust and flow rate if they have been defined as constant (partial derivatives are not available if parameters are not constant).

The maneuver is associated to two triggering EventDetector (one to start the thrust, the other one to stop the thrust): the maneuver is triggered only if the underlying event generates a STOP event, in which case this class will generate a RESET_STATE event (the stop event from the underlying object is therefore filtered out).

Note: including this force in a numerical propagator with adaptive step-size integrator may require to set up a small lower bound for step-size (such as 1E-8s) since force discontinuity may cause difficulties to the integrator when the maneuver stops.

Warning: if variable ISP and thrust are used (using PropulsiveProperty), ISP and thrust parameters cannot be used (set as NaN) and partial derivatives cannot be computed.

Author:

Fabien Maussion, Véronique Pommier-Maurussane, Luc Maisonobe

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLOW_RATE Parameter name for flow rate.
static String	THRUST Parameter name for thrust.

Constructor Summary

Constructors

Constructor and Description
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank) Constructor for a variable direction in satellite frame.
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank, Frame frameIn) Constructor for a variable direction in provided frame.
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank, LOFType lofTyp) Constructor for a variable direction in provided local orbital frame.
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank) Constructor for a constant direction in satellite frame.
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank, Frame frameIn) Constructor for a constant direction in provided frame.
ContinuousThrustManeuver(AbsoluteDate date, double duration, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank, LOFType lofTyp) Constructor for a constant direction in provided local orbital frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank) Constructor for a variable direction in satellite frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank, Frame frameIn) Constructor for a variable direction in provided frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, IDependentVectorVariable<SpacecraftState> inDirection, MassProvider massProvider, TankProperty tank, LOFType lofTyp) Constructor for a variable direction in local orbital frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank) Constructor for a constant direction in satellite frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank, Frame frameIn) Constructor for a constant direction in provided frame.
ContinuousThrustManeuver(EventDetector startEventDetector, EventDetector stopEventDetector, PropulsiveProperty engine, Vector3D inDirection, MassProvider massProvider, TankProperty tank, LOFType lofTyp) Constructor for a constant direction in local orbital frame.

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.
Vector3D	getDirection(SpacecraftState s) Get the thrust direction.
AbsoluteDate	getEndDate() Return the maneuver stop date (if a date or a DateDetector as been provided).
EventDetector[]	getEventsDetectors() Get the discrete events related to the model.
double	getFlowRate(SpacecraftState s) Get the flow rate.
Frame	getFrame() Get the frame of the acceleration inDirection.
double	getISP() Get the specific impulse.
double	getISP(SpacecraftState s) Get the specific impulse.
LOFType	getLofType()
MassProvider	getMassModel()
PropulsiveProperty	getPropulsiveProperty() Get the propulsive property.
AbsoluteDate	getStartDate() Return the maneuver start date (if a date or a DateDetector as been provided).
TankProperty	getTankProperty() Get the tank property.
double	getThrust(SpacecraftState s) Get the thrust.
Vector3D	getUsedDV() Get the maneuver instantaneous consumption deltaV.
void	handleStep(PatriusStepInterpolator interpolator, boolean isLast) Handle the current step.
void	init(SpacecraftState s0, AbsoluteDate t) Initialize step handler at the start of a propagation.
boolean	isFiring() Returns maneuver status (firing or not).
void	setFiring(boolean isFiring) Set maneuver status.

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

Field Detail

THRUST

public static final String THRUST

Parameter name for thrust.

See Also:

Constant Field Values

FLOW_RATE

public static final String FLOW_RATE

Parameter name for flow rate.

See Also:

Constant Field Values

Constructor Detail

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank)

Constructor for a constant direction in satellite frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in satellite frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank)

Constructor for a variable direction in satellite frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in satellite frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                Frame frameIn)

Constructor for a constant direction in provided frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in provided frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

frameIn - the frame of the acceleration direction.

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                Frame frameIn)

Constructor for a variable direction in provided frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in provided frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

frameIn - the frame of the acceleration direction.

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                LOFType lofTyp)

Constructor for a constant direction in provided local orbital frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in LOF

massProvider - the mass provider

tank - tank property gathering mass and part name information

lofTyp - the LOF type of the acceleration inDirection

ContinuousThrustManeuver

public ContinuousThrustManeuver(AbsoluteDate date,
                                double duration,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                LOFType lofTyp)

Constructor for a variable direction in provided local orbital frame.

Parameters:

date - maneuver date

duration - the duration of the thrust (s) (if negative, the date is considered to be the stop date)

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in LOF

massProvider - the mass provider

tank - tank property gathering mass and part name information

lofTyp - the LOF type of the acceleration inDirection

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank)
                         throws PatriusException

Constructor for a constant direction in satellite frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in satellite frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

Throws:

PatriusException - if mass from mass provider is negative

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank)
                         throws PatriusException

Constructor for a variable direction in satellite frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in satellite frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

Throws:

PatriusException - if mass from mass provider is negative

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                Frame frameIn)
                         throws PatriusException

Constructor for a constant direction in provided frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in provided frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

frameIn - the frame of the acceleration inDirection

Throws:

PatriusException - if mass from mass provider is negative

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                Frame frameIn)
                         throws PatriusException

Constructor for a variable direction in provided frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in provided frame

massProvider - the mass provider

tank - tank property gathering mass and part name information

frameIn - the frame of the acceleration inDirection

Throws:

PatriusException - if mass from mass provider is negative

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                Vector3D inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                LOFType lofTyp)
                         throws PatriusException

Constructor for a constant direction in local orbital frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the constant thrust direction in LOF

massProvider - the mass provider

tank - tank property gathering mass and part name information

lofTyp - the LOF type of the acceleration direction

Throws:

PatriusException - if mass from mass provider is negative

ContinuousThrustManeuver

public ContinuousThrustManeuver(EventDetector startEventDetector,
                                EventDetector stopEventDetector,
                                PropulsiveProperty engine,
                                IDependentVectorVariable<SpacecraftState> inDirection,
                                MassProvider massProvider,
                                TankProperty tank,
                                LOFType lofTyp)
                         throws PatriusException

Constructor for a variable direction in local orbital frame.

Parameters:

startEventDetector - event detector upon which maneuver should starts

stopEventDetector - event detector upon which maneuver should stops

engine - engine property gathering thrust force (N) and isp (s) information

inDirection - the variable thrust direction in LOF

massProvider - the mass provider

tank - tank property gathering mass and part name information

lofTyp - the LOF type of the acceleration direction

Throws:

PatriusException - if mass from mass provider is negative

Method Detail

init

public void init(SpacecraftState s0,
                 AbsoluteDate t)

Initialize step handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the step handler to initialize some internal data if needed.

Specified by:

init in interface PatriusStepHandler

Parameters:

s0 - initial state

t - target time for the integration

handleStep

public void handleStep(PatriusStepInterpolator interpolator,
                       boolean isLast)
                throws PropagationException

Handle the current step.

Specified by:

handleStep in interface PatriusStepHandler

Parameters:

interpolator - interpolator set up for the current step

isLast - if true, this is the last integration step

Throws:

PropagationException - if step cannot be handled

getThrust

public double getThrust(SpacecraftState s)

Get the thrust.

Parameters:

s - the current state information: date, kinematics, attitude. Unused in case of constant maneuver.

Returns:

thrust force (N).

getDirection

public Vector3D getDirection(SpacecraftState s)

Get the thrust direction.

Parameters:

s - the current state information: date, kinematics, attitude. Unused in case of constant maneuver.

Returns:

the thrust direction.

getISP

public double getISP(SpacecraftState s)

Get the specific impulse.

Parameters:

s - the current state information: date, kinematics, attitude. Unused in case of constant maneuver.

Returns:

specific impulse (s).

getFlowRate

public double getFlowRate(SpacecraftState s)

Get the flow rate.

Parameters:

s - the current state information: date, kinematics, attitude

Returns:

flow rate (negative, kg/s).

getISP

public double getISP()

Get the specific impulse.

Warning: if a variable ISP has been used, NaN will be returned.

Returns:

specific impulse (s).

getTankProperty

public TankProperty getTankProperty()

Get the tank property.

Returns:

tank property

getPropulsiveProperty

public PropulsiveProperty getPropulsiveProperty()

Get the propulsive property.

Returns:

propulsive property

getStartDate

public AbsoluteDate getStartDate()

Return the maneuver start date (if a date or a DateDetector as been provided).

Returns:

the maneuver start date if a date or a DateDetector as been provided, null otherwise.

getEndDate

public AbsoluteDate getEndDate()

Return the maneuver stop date (if a date or a DateDetector as been provided).

Returns:

the maneuver stop date if a date or a DateDetector as been provided, null otherwise.

getUsedDV

public Vector3D getUsedDV()

Get the maneuver instantaneous consumption deltaV.

Returns:

maneuver instantaneous consumption deltaV in maneuver frame (inertial, LOF or satellite)

getFrame

public Frame getFrame()

Get the frame of the acceleration inDirection. Null if the thrust is expressed in the satellite frame or in a local orbital frame.

Returns:

the frame of the acceleration

setFiring

public void setFiring(boolean isFiring)

Set maneuver status. This method is meant to be used if the propagation starts during a maneuver. As a result thrust will be firing at the beginning of the propagation and stops when crossing stop event.

Used in conjunction with isFiring(), the user can stop/restart a propagation during a maneuver.

Parameters:

isFiring - true if propagation should start during the maneuver

isFiring

public boolean isFiring()

Returns maneuver status (firing or not).

Used in conjunction with setFiring(boolean), the user can stop/restart a propagation during a maneuver.

Returns:

true if maneuver is thrust firing.

getLofType

public LOFType getLofType()

Returns:

the lofType

getMassModel

public MassProvider getMassModel()

Returns:

the massModel

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

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.. This method can be called only for constant thrust maneuvers (ie. if PropulsiveProperty has been defined with thrust and isp as constants/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

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

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