fr.cnes.sirius.patrius.propagation.numerical

Class AbstractPartialDerivativesEquations

java.lang.Object

fr.cnes.sirius.patrius.propagation.numerical.AbstractPartialDerivativesEquations

All Implemented Interfaces:

AdditionalEquations, Externalizable, Serializable

Direct Known Subclasses:

MultiPartialDerivativesEquations, PartialDerivativesEquations

public abstract class AbstractPartialDerivativesEquations
extends Object
implements AdditionalEquations

Abstract class for PartialDerivativesEquations and MultiPartialDerivativesEquations.

Since:

4.8

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractPartialDerivativesEquations() Empty constructor for Externalizable use.
AbstractPartialDerivativesEquations(String nameIn) Simple constructor.

Method Summary

Modifier and Type	Method and Description
double[]	buildAdditionalState(double[] y, double[] yDot) Build full first order additional state from second order y and yDot.
void	clearSelectedParameters() Clear the selected parameters list.
void	computeDerivatives(SpacecraftState s, TimeDerivativesEquations adder) Compute the derivatives related to the additional state parameters.
double[]	computeSecondDerivatives(SpacecraftState s) Compute the second derivatives related to the additional state parameters.
void	concatenate(List<Parameter> parameters) Concatenate a list of parameters with the already existing selectedParameters list Check that the parameter to add is not already on the list (to avoid problems with the step)
boolean	contains(Parameter parameter) Check if the parameter is already in the selectedParameters list
double[]	extractY(double[] additionalState) Retrieve second order additional state y from full first order additional state.
double[]	extractYDot(double[] additionalState) Retrieve second order additional state derivative yDot from full first order additional state.
List<Parameter>	getAvailableParameters() Get the names of the available parameters in the propagator.
int	getFirstOrderDimension() Returns the number of first order additional states.
protected abstract List<ForceModel>	getForceModels() Returns the propagator force models.
protected abstract Frame	getFrame() Returns the propagator frame.
double	gethPos() Returns the step used for finite difference computation with respect to spacecraft position.
List<IJacobiansParameterizable>	getJacobiansProviders() Get the list of jacobians providers.
JacobiansMapper	getMapper() Get a mapper between two-dimensional Jacobians and one-dimensional additional state.
String	getName() Get the name of the additional state.
protected abstract OrbitType	getOrbitType() Returns the propagator orbit type.
int	getParamDim() Returns the parameters dimension.
protected abstract PositionAngle	getPositionAngle() Returns the propagator position angle.
int	getSecondOrderDimension() Returns the number of second order additional states.
List<ParameterConfiguration>	getSelectedParameters() Get a copy of the selected parameters.
boolean	isDirty() Returns a boolean for force models / selected parameters consistency.
boolean	isInitialJacobians() Returns true if the initial Jacobians have not been initialized yet.
void	readExternal(ObjectInput oi)
void	selectParamAndStep(Parameter parameter, double hP) Select the parameters to consider for Jacobian processing.
void	selectParameters(List<Parameter> parameters) Select the parameters to consider for Jacobian processing.
void	selectParameters(Parameter... parameters) Select the parameters to consider for Jacobian processing.
void	setDirty(boolean value) Setter for the boolean for force models / selected parameters consistency.
void	setHPos(double value) Setter for the step used for finite difference computation with respect to spacecraft position
SpacecraftState	setInitialJacobians(SpacecraftState s0) Set the initial value of the Jacobian with respect to state and parameter.
SpacecraftState	setInitialJacobians(SpacecraftState s, double[][] dY1dY0) Set the initial value of the Jacobian with respect to state.
SpacecraftState	setInitialJacobians(SpacecraftState s1, double[][] dY1dY0, double[][] dY1dP) Set the initial value of the Jacobian with respect to state and parameter.
SpacecraftState	setInitialJacobians(SpacecraftState s, Parameter parameter, double[] dY1dP) Set the initial value of the Jacobian with respect to state.
void	setSteps(double hPosition) Set the step for finite differences with respect to spacecraft position.
void	writeExternal(ObjectOutput oo)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPartialDerivativesEquations

public AbstractPartialDerivativesEquations()

Empty constructor for Externalizable use.

AbstractPartialDerivativesEquations

public AbstractPartialDerivativesEquations(String nameIn)

Simple constructor.

Upon construction, this set of equations is automatically added to the propagator by calling its NumericalPropagator.addAdditionalEquations(AdditionalEquations) method. So there is no need to call this method explicitly for these equations.

Parameters:

nameIn - name of the partial derivatives equations

Method Detail

getName

public String getName()

Get the name of the additional state.

Specified by:

getName in interface AdditionalEquations

Returns:

name of the additional state

getSelectedParameters

public List<ParameterConfiguration> getSelectedParameters()

Get a copy of the selected parameters.

Returns:

copy of the list of selected parameters

clearSelectedParameters

public void clearSelectedParameters()

Clear the selected parameters list.

selectParameters

public void selectParameters(Parameter... parameters)

Select the parameters to consider for Jacobian processing.

Parameters names have to be consistent with some ForceModel added elsewhere.

Parameters:

parameters - parameters to consider for Jacobian processing. Parameters will not be added if already added elsewhere

See Also:

NumericalPropagator.addForceModel(ForceModel), setInitialJacobians(SpacecraftState, double[][], double[][]), ForceModel, Parameterizable

selectParameters

public void selectParameters(List<Parameter> parameters)

Select the parameters to consider for Jacobian processing.

Parameters names have to be consistent with some ForceModel added elsewhere.

Parameters:

parameters - list of parameters to consider for Jacobian processing

See Also:

NumericalPropagator.addForceModel(ForceModel), setInitialJacobians(SpacecraftState, double[][], double[][]), ForceModel, Parameterizable

selectParamAndStep

public void selectParamAndStep(Parameter parameter,
                               double hP)

Select the parameters to consider for Jacobian processing.

Parameters names have to be consistent with some ForceModel added elsewhere.

Parameters:

parameter - parameter to consider for Jacobian processing. Parameter will not be added if already added elsewhere

hP - step to use for computing Jacobian column with respect to the specified parameter

See Also:

NumericalPropagator.addForceModel(ForceModel), setInitialJacobians(SpacecraftState, double[][], double[][]), ForceModel, Parameterizable

getAvailableParameters

public List<Parameter> getAvailableParameters()

Get the names of the available parameters in the propagator.

The names returned depend on the force models set up in the propagator, including the Newtonian attraction from the central body.

Returns:

available parameters

getMapper

public JacobiansMapper getMapper()
                          throws PatriusException

Get a mapper between two-dimensional Jacobians and one-dimensional additional state.

Returns:

a mapper between two-dimensional Jacobians and one-dimensional additional state, with the same name as the instance

Throws:

PatriusException - if the initial Jacobians have not been initialized yet

See Also:

setInitialJacobians(SpacecraftState), setInitialJacobians(SpacecraftState, double[][], double[][])

concatenate

public void concatenate(List<Parameter> parameters)

Concatenate a list of parameters with the already existing selectedParameters list Check that the parameter to add is not already on the list (to avoid problems with the step)

Parameters:

parameters - list of parameters to concatenate

contains

public boolean contains(Parameter parameter)

Check if the parameter is already in the selectedParameters list

Parameters:

parameter - to check

Returns:

true if the parameter is in the list false otherwise

setSteps

public void setSteps(double hPosition)

Set the step for finite differences with respect to spacecraft position.

Parameters:

hPosition - step used for finite difference computation with respect to spacecraft position (m)

setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s0)
                                    throws PatriusException

Set the initial value of the Jacobian with respect to state and parameter.

This method is equivalent to call setInitialJacobians(SpacecraftState, double[][], double[][]) with dYdY0 set to the identity matrix and dYdP set to a zero matrix.

Parameters:

s0 - initial state

Returns:

the updated SpacecraftState with the added additional state

Throws:

PatriusException - if the partial equation has not been registered in the propagator or if matrices dimensions are incorrect

See Also:

selectedParameters, selectParamAndStep(Parameter, double)

setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s1,
                                           double[][] dY1dY0,
                                           double[][] dY1dP)
                                    throws PatriusException

Set the initial value of the Jacobian with respect to state and parameter.

Parameters:

s1 - current state

dY1dY0 - Jacobian of current state at time t₁ with respect to state at some previous time t₀ (6x6)

dY1dP - Jacobian of current state at time t₁ with respect to parameters (may be null if no parameters are selected)

Returns:

the updated SpacecraftStatetate

Throws:

PatriusException - if the partial equation has not been registered in the propagator or if matrices dimensions are incorrect

See Also:

selectedParameters, selectParamAndStep(Parameter, double)

setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s,
                                           double[][] dY1dY0)
                                    throws PatriusException

Set the initial value of the Jacobian with respect to state.

If state does not have partial derivatives yet, an exception is thrown. Call setInitialJacobians(SpacecraftState) to initialize Jacobians with default values or setInitialJacobians(SpacecraftState, double[][], double[][]) to initialize Jacobians with own values.

Parameters:

s - current state

dY1dY0 - Jacobian of current state at time t₁ with respect to state at some previous time t₀ (6x6)

Returns:

the updated SpacecraftState

Throws:

PatriusException - if the partial equation has not been registered in the propagator or if matrices dimensions are incorrect

See Also:

selectedParameters, selectParamAndStep(Parameter, double)

setInitialJacobians

public SpacecraftState setInitialJacobians(SpacecraftState s,
                                           Parameter parameter,
                                           double[] dY1dP)
                                    throws PatriusException

Set the initial value of the Jacobian with respect to state.

If state does not have partial derivatives yet, an exception is thrown. Call setInitialJacobians(SpacecraftState) to initialize Jacobians with default values or setInitialJacobians(SpacecraftState, double[][], double[][]) to initialize Jacobians with own values.

Parameters:

s - current state

parameter - parameter

dY1dP - Jacobian of current state at time t₁ with respect to provided parameter

Returns:

the updated SpacecraftState

Throws:

PatriusException - if the partial equation has not been registered in the propagator or if matrices dimensions are incorrect or if state partial derivatives have not been initialized beforehand

See Also:

selectedParameters, selectParamAndStep(Parameter, double)

getFirstOrderDimension

public int getFirstOrderDimension()

Returns the number of first order additional states. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

getFirstOrderDimension in interface AdditionalEquations

Returns:

the number of first order additional states

getSecondOrderDimension

public int getSecondOrderDimension()

Returns the number of second order additional states. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

getSecondOrderDimension in interface AdditionalEquations

Returns:

the number of second order additional states

writeExternal

public void writeExternal(ObjectOutput oo)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readExternal

public void readExternal(ObjectInput oi)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

getJacobiansProviders

public List<IJacobiansParameterizable> getJacobiansProviders()

Get the list of jacobians providers.

Returns:

the list of jacobians providers

isInitialJacobians

public boolean isInitialJacobians()

Returns true if the initial Jacobians have not been initialized yet.

Returns:

the if the initial Jacobians have not been initialized yet

getParamDim

public int getParamDim()

Returns the parameters dimension.

Returns:

the parameters dimension

gethPos

public double gethPos()

Returns the step used for finite difference computation with respect to spacecraft position.

Returns:

the step used for finite difference computation with respect to spacecraft position

setHPos

public void setHPos(double value)

Setter for the step used for finite difference computation with respect to spacecraft position

Parameters:

value - the new step used for finite difference computation with respect to spacecraft position

isDirty

public boolean isDirty()

Returns a boolean for force models / selected parameters consistency.

Returns:

the boolean for force models / selected parameters consistency

setDirty

public void setDirty(boolean value)

Setter for the boolean for force models / selected parameters consistency.

Parameters:

value - the new boolean for force models / selected parameters consistency

computeDerivatives

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

Compute the derivatives related to the additional state parameters.

Specified by:

computeDerivatives in interface AdditionalEquations

Parameters:

s - current state information: date, kinematics, attitude, additional states

adder - object where the contribution of the additional parameters to the orbit evolution (accelerations) should be added

Throws:

PatriusException - if some specific error occurs

computeSecondDerivatives

public double[] computeSecondDerivatives(SpacecraftState s)
                                  throws PatriusException

Compute the second derivatives related to the additional state parameters. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

computeSecondDerivatives in interface AdditionalEquations

Parameters:

s - current state information: date, kinematics, attitude, additional states

Returns:

second derivative

Throws:

PatriusException - if some specific error occurs

buildAdditionalState

public double[] buildAdditionalState(double[] y,
                                     double[] yDot)

Build full first order additional state from second order y and yDot. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

buildAdditionalState in interface AdditionalEquations

Parameters:

y - second order additional state y

yDot - second order additional state derivative yDot

Returns:

full first order additional state

extractY

public double[] extractY(double[] additionalState)

Retrieve second order additional state y from full first order additional state. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

extractY in interface AdditionalEquations

Parameters:

additionalState - full first order additional state

Returns:

second order additional state y

extractYDot

public double[] extractYDot(double[] additionalState)

Retrieve second order additional state derivative yDot from full first order additional state. This method is only used by second order integrator such as CowellIntegrator.

Specified by:

extractYDot in interface AdditionalEquations

Parameters:

additionalState - full first order additional state

Returns:

second order additional state derivative yDot

getForceModels

protected abstract List<ForceModel> getForceModels()

Returns the propagator force models.

Returns:

the propagator force models

getFrame

protected abstract Frame getFrame()

Returns the propagator frame.

Returns:

the propagator frame

getOrbitType

protected abstract OrbitType getOrbitType()

Returns the propagator orbit type.

Returns:

the propagator orbit type

getPositionAngle

protected abstract PositionAngle getPositionAngle()

Returns the propagator position angle.

Returns:

the propagator position angle