fr.cnes.sirius.patrius.assembly

Class Vehicle

java.lang.Object

fr.cnes.sirius.patrius.assembly.Vehicle

All Implemented Interfaces:

Serializable

public class Vehicle
extends Object
implements Serializable

Vehicle class: it represent a classic satellite: main body + solar panels. This satellite can have tanks, engines and masses. To build a more complex satellite (with sensors, etc.), use Assembly class.

Since:

4.0

Author:

Emmanuel Bignon

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MAIN_SHAPE Main shape.

Constructor Summary

Constructors

Constructor and Description
Vehicle() Constructor.
Vehicle(CrossSectionProvider mainShapeIn, List<Facet> solarPanelsIn, MassProperty dryMassPropertyIn, AerodynamicProperties aerodynamicPropertiesIn, RadiativeProperties radiativePropertiesIn, List<PropulsiveProperty> enginesList, List<TankProperty> fuelTankList) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addEngine(String name, PropulsiveProperty engine) Add an engine to the vehicle.
void	addSolarPanel(Vector3D normalPanel, double areaPanel) Add a solar panel to the vehicle.
void	addTank(String name, TankProperty tank) Add a tank to the vehicle.
Assembly	createAssembly(Frame frame) Create an Assembly.
Assembly	createAssembly(Frame frame, double cMass, double cDrag, double cSRP) Create an Assembly with multiplicative coefficients to take into account the change in surface for drag or SRP during a propagation of the change of dry mass.
AerodynamicProperties	getAerodynamicProperties() Get main shape aerodynamic properties.
IParamDiffFunction[]	getAerodynamicsPropertiesFunction() Returns the aero properties : drag and lift coefficients.
double	getDryMass() Returns dry mass.
PropulsiveProperty	getEngine(String name) Public method to search the engine object corresponding to the specified name.
int	getEngineCount()
List<PropulsiveProperty>	getEnginesList() Returns the engines list.
double	getErgolsMass() Returns the sum of ergols masses.
CrossSectionProvider	getMainShape() Returns the main shape.
MassProperty	getMassProperty() Get mass property.
RadiativeProperties	getRadiativeProperties() Get main shape radiative properties.
double[]	getRadiativePropertiesTab() Returns the radiative properties : absorption, specular and diffusion coefficient (visible and IR), as an array : [0] : absorption coefficient (visible) [1] : specular coefficient (visible) [2] : diffusion coefficient (visible) [3] : absorption coefficient (IR) [4] : specular coefficient (IR) [5] : diffusion coefficient (IR)
List<Facet>	getSolarPanelsList() Returns the solar panels list.
TankProperty	getTank(String name) Public method to search the tank object corresponding to the specified name.
int	getTankCount()
List<TankProperty>	getTanksList() Returns the tanks list.
double	getTotalMass() Returns total mass : sum of dry mass and ergol mass.
void	setAerodynamicsProperties(AerodynamicCoefficient cx, AerodynamicCoefficient cz) Set aerodynamics properties only if possible : main shape must be a sphere or there must be no solar panels.
void	setAerodynamicsProperties(double cx, double cz) Set aerodynamics properties as constants.
void	setDryMass(double mass) Set vehicle dry mass.
void	setMainShape(CrossSectionProvider shape) Set the main vehicle shape.
void	setRadiativeProperties(double ka, double ks, double kd, double kaIr, double ksIr, double kdIr) Set radiative properties.

Methods inherited from class java.lang.Object

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

Field Detail

MAIN_SHAPE

public static final String MAIN_SHAPE

Main shape.

See Also:

Constant Field Values

Constructor Detail

Vehicle

public Vehicle()

Constructor. As this class is developed as a builder, vehicle properties are to be set by available setters.

Vehicle

public Vehicle(CrossSectionProvider mainShapeIn,
               List<Facet> solarPanelsIn,
               MassProperty dryMassPropertyIn,
               AerodynamicProperties aerodynamicPropertiesIn,
               RadiativeProperties radiativePropertiesIn,
               List<PropulsiveProperty> enginesList,
               List<TankProperty> fuelTankList)

Creates a new instance.

Parameters:

mainShapeIn - main shape of vehicle

solarPanelsIn - solar panels of vehicle

dryMassPropertyIn - mass property for dry mass

aerodynamicPropertiesIn - aerodynamic properties; it may be null if no aerodynamic properties are required

radiativePropertiesIn - radiative properties; it may be null if no radiative properties are required

enginesList - list of engines (propulsive properties); it may be null if no engines list is required

fuelTankList - list of tanks; it may be null if no fuel tanks are required

Method Detail

createAssembly

public Assembly createAssembly(Frame frame)
                        throws PatriusException

Create an Assembly. Call to { createAssembly(Frame, double, double, double) with default multiplicative factors set to 1.

Parameters:

frame - frame link between tree of frames and spacecraft frame

Returns:

an assembly

Throws:

PatriusException - thrown if mass is negative

createAssembly

public Assembly createAssembly(Frame frame,
                               double cMass,
                               double cDrag,
                               double cSRP)
                        throws PatriusException

Create an Assembly with multiplicative coefficients to take into account the change in surface for drag or SRP during a propagation of the change of dry mass. Therefore, multiplicative factor for the mass, the drag/SRP area are to be given as input.

Warning: using this method, new tanks are created using cMass coefficients with current tanks. As a result, user-added tanks mass will not vary if using some mass equations.

Parameters:

frame - frame link between tree of frames and spacecraft frame

cMass - multiplicative factor on masses (dry and tanks)

cDrag - multiplicative factor on drag area

cSRP - multiplicative factor on SRP area

Returns:

an assembly

Throws:

PatriusException - thrown if mass is negative

setMainShape

public void setMainShape(CrossSectionProvider shape)

Set the main vehicle shape.

Parameters:

shape - main shape

addSolarPanel

public void addSolarPanel(Vector3D normalPanel,
                          double areaPanel)

Add a solar panel to the vehicle.

Parameters:

normalPanel - vector normal to the panel in satellite frame

areaPanel - panel area

addEngine

public void addEngine(String name,
                      PropulsiveProperty engine)

Add an engine to the vehicle.

Parameters:

name - engine name

engine - an engine

addTank

public void addTank(String name,
                    TankProperty tank)

Add a tank to the vehicle.

Parameters:

name - tank name

tank - a tank

setDryMass

public void setDryMass(double mass)
                throws PatriusException

Set vehicle dry mass.

Parameters:

mass - dry mass

Throws:

PatriusException - problem to the mass property construction

setAerodynamicsProperties

public void setAerodynamicsProperties(AerodynamicCoefficient cx,
                                      AerodynamicCoefficient cz)
                               throws PatriusException

Set aerodynamics properties only if possible : main shape must be a sphere or there must be no solar panels. An exception is thrown otherwise.

Parameters:

cx - drag coefficient function

cz - lift coefficient function

Throws:

PatriusException - problem to the aerodynamics properties construction

IllegalArgumentException - if vehicle is inconsistent for aero properties

setAerodynamicsProperties

public void setAerodynamicsProperties(double cx,
                                      double cz)
                               throws PatriusException

Set aerodynamics properties as constants.

Parameters:

cx - constant drag coefficient

cz - constant lift coefficient

Throws:

PatriusException - error to the aerodynamic properties creation

setRadiativeProperties

public void setRadiativeProperties(double ka,
                                   double ks,
                                   double kd,
                                   double kaIr,
                                   double ksIr,
                                   double kdIr)
                            throws PatriusException

Set radiative properties.

Parameters:

ka - absorption coefficient (visible)

ks - specular coefficient (visible)

kd - diffusion coefficient (visible)

kaIr - absorption coefficient (IR)

ksIr - specular coefficient (IR)

kdIr - diffusion coefficient (IR)

Throws:

PatriusException - error to the radiative properties creation

getMainShape

public CrossSectionProvider getMainShape()

Returns the main shape.

Returns:

main shape

getSolarPanelsList

public List<Facet> getSolarPanelsList()

Returns the solar panels list.

Returns:

solar panels list

getEnginesList

public List<PropulsiveProperty> getEnginesList()

Returns the engines list.

Returns:

engines list

getTanksList

public List<TankProperty> getTanksList()

Returns the tanks list.

Returns:

tanks list

getDryMass

public double getDryMass()

Returns dry mass.

Returns:

dry mass

getErgolsMass

public double getErgolsMass()

Returns the sum of ergols masses.

Returns:

total ergol mass

getTotalMass

public double getTotalMass()

Returns total mass : sum of dry mass and ergol mass.

Returns:

total mass

getAerodynamicsPropertiesFunction

public IParamDiffFunction[] getAerodynamicsPropertiesFunction()

Returns the aero properties : drag and lift coefficients.

Returns:

aero properties

getRadiativePropertiesTab

public double[] getRadiativePropertiesTab()

Returns the radiative properties : absorption, specular and diffusion coefficient (visible and IR), as an array : [0] : absorption coefficient (visible) [1] : specular coefficient (visible) [2] : diffusion coefficient (visible) [3] : absorption coefficient (IR) [4] : specular coefficient (IR) [5] : diffusion coefficient (IR)

Returns:

radiative properties

getEngine

public PropulsiveProperty getEngine(String name)

Public method to search the engine object corresponding to the specified name.

Parameters:

name - name of the engine

Returns:

engine object

getTank

public TankProperty getTank(String name)

Public method to search the tank object corresponding to the specified name.

Parameters:

name - name of the tank

Returns:

tank object

getMassProperty

public MassProperty getMassProperty()

Get mass property.

Returns:

the mass property (null if it was not given)

getAerodynamicProperties

public AerodynamicProperties getAerodynamicProperties()

Get main shape aerodynamic properties.

Returns:

the main shape aerodynamic properties (null if they were not given)

getRadiativeProperties

public RadiativeProperties getRadiativeProperties()

Get main shape radiative properties.

Returns:

the radiative properties (null if they where not given)

getEngineCount

public int getEngineCount()

Returns:

the s_engineCount

getTankCount

public int getTankCount()

Returns:

the s_tankCount