fr.cnes.sirius.patrius.propagation

Interface MassProvider

All Superinterfaces:

Cloneable, Serializable

All Known Subinterfaces:

IInertiaModel

All Known Implementing Classes:

InertiaComputedModel, InertiaSimpleModel, MassModel, SimpleMassModel

public interface MassProvider
extends Cloneable, Serializable

Interface for spacecraft models that provide the mass.

Since:

2.1

Version:

$Id: MassProvider.java 18092 2017-10-02 17:12:58Z bignon $

Author:

Rami Houdroge

Field Summary

Fields

Modifier and Type	Field and Description
static String	MASS Default prefix for additional equation from MassProvider.

Method Summary

Modifier and Type	Method and Description
void	addMassDerivative(String partName, double flowRate) Add the mass derivate of the given part.
AdditionalEquations	getAdditionalEquation(String name) Get the mass equation related to the part.
List<String>	getAllPartsNames() Get the list of the name of the parts.
double	getMass(String partName) Return the mass of the given part.
double	getTotalMass() Return the mass of the spacecraft.
double	getTotalMass(SpacecraftState state) Return the mass of the spacecraft following the order.
void	setMassDerivativeZero(String partName) Set mass derivative to zero.
void	updateMass(String partName, double mass) Update the mass of the given part.

Field Detail

MASS

static final String MASS

Default prefix for additional equation from MassProvider.

See Also:

Constant Field Values

Method Detail

getTotalMass

double getTotalMass()

Return the mass of the spacecraft.

Returns:

spacecraft mass

getTotalMass

double getTotalMass(SpacecraftState state)

Return the mass of the spacecraft following the order.

• If mass is in spacecraft state, mass from spacecraft state will be returned
• Otherwise mass from mass provider is returned (same as getTotalMass())

Parameters:

state - spacecraft state

Returns:

spacecraft mass

getMass

double getMass(String partName)

Return the mass of the given part.

Parameters:

partName - given part

Returns:

mass of part

updateMass

void updateMass(String partName,
                double mass)
         throws PatriusException

Update the mass of the given part.

Parameters:

partName - given part

mass - mass of the given part

Throws:

PatriusException - thrown if the mass becomes negative (PatriusMessages.SPACECRAFT_MASS_BECOMES_NEGATIVE)

setMassDerivativeZero

void setMassDerivativeZero(String partName)

Set mass derivative to zero.

Parameters:

partName - name of part whose mass derivative is set to zero

addMassDerivative

void addMassDerivative(String partName,
                       double flowRate)

Add the mass derivate of the given part.

Parameters:

partName - name of part subject to mass variation

flowRate - flow rate of specified part

getAdditionalEquation

AdditionalEquations getAdditionalEquation(String name)

Get the mass equation related to the part.

Parameters:

name - part name

Returns:

the associated mass equation

getAllPartsNames

List<String> getAllPartsNames()

Get the list of the name of the parts.

Returns:

the list of the spacecraft parts name.