fr.cnes.sirius.patrius.assembly.properties

Class MassEquation

java.lang.Object

fr.cnes.sirius.patrius.assembly.properties.MassEquation

All Implemented Interfaces:

AdditionalEquations, Externalizable, Serializable

public class MassEquation
extends Object
implements AdditionalEquations

This class represents the mass equation with a name in the form "MASS_".

Version:

$Id$

See Also:

MassProvider, Serialized Form

Concurrency :

not thread-safe

Concurrency comment :

internal mutable attributes

Field Summary

Fields

Modifier and Type	Field and Description
static String	PREFIX Default prefix for mass equation

Constructor Summary

Constructors

Constructor and Description
MassEquation() Empty constructor for Externalizable use.
MassEquation(String partName) Create a new mass equation, for a given part.

Method Summary

Modifier and Type	Method and Description
void	addMassDerivative(double flow) Set the flow rate.
double[]	buildAdditionalState(double[] y, double[] yDot) Build full first order additional state from second order y and yDot.
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.
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.
static String	genName(String name) Generate a name in the form "MASS_" for this equation.
int	getFirstOrderDimension() Returns the number of first order additional states.
String	getName() Get the name of the additional equation.
int	getSecondOrderDimension() Returns the number of second order additional states.
void	readExternal(ObjectInput oi)
void	setMassDerivativeZero() Set the flow rate to zero.
void	writeExternal(ObjectOutput oo)

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final String PREFIX

Default prefix for mass equation

See Also:

Constant Field Values

Constructor Detail

MassEquation

public MassEquation()

Empty constructor for Externalizable use.

MassEquation

public MassEquation(String partName)

Create a new mass equation, for a given part. The name of the created equation is set by default in the following form : "MASS_".

Parameters:

partName - name of part subject to this equation

Method Detail

getName

public String getName()

Get the name of the additional equation. The name is in the following form : "MASS_".

Specified by:

getName in interface AdditionalEquations

Returns:

name of the additional equation with the prefix "MASS_"

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

setMassDerivativeZero

public void setMassDerivativeZero()

Set the flow rate to zero.

Since:

2.3.1

addMassDerivative

public void addMassDerivative(double flow)

Set the flow rate.

Parameters:

flow - rate

genName

public static String genName(String name)

Generate a name in the form "MASS_" for this equation.

Parameters:

name - part name

Returns:

full name of the equation

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

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

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

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