fr.cnes.sirius.patrius.assembly.properties

Class MassEquation

java.lang.Object

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

All Implemented Interfaces:

AdditionalEquations, 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(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.
void	computeDerivatives(SpacecraftState s, TimeDerivativesEquations adder) Compute the derivatives related to the additional state parameters.
static String	genName(String name) Generate a name in the form "MASS_" for this equation.
String	getName() Get the name of the additional equation.
void	setMassDerivativeZero() Set the flow rate to zero.

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