fr.cnes.dynvol.gentleman.calc.propagation

Class AbstractGtmPropagator

java.lang.Object

fr.cnes.dynvol.gentleman.calc.propagation.AbstractGtmPropagator

Direct Known Subclasses:

GtmGeoPropagator, GtmLeoPropagator

public abstract class AbstractGtmPropagator
extends Object

Astract class including common attributes and methods allowing to numerically propagate an orbit with maneuver sequence then to get corresponding TLEs.

Author:

goesterjf

Field Summary

Fields

Modifier and Type	Field and Description
protected fr.cnes.sirius.patrius.assembly.Assembly	assembly Assembly (from the vehicle)
protected fr.cnes.sirius.patrius.attitudes.AttitudeProvider	attitudeLaw Attitude law
protected fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid	ellips Earth ellipsoid
protected fr.cnes.sirius.patrius.forces.ForceModelsData	forces Forces
protected fr.cnes.sirius.patrius.orbits.Orbit	iniOrbit Initial orbit
protected fr.cnes.dynvol.psimu.calc.integrator.AbstractNumericalIntegratorData	integData Integrator data
protected List<fr.cnes.genopus.nonWidget.events.CustomEventDetector>	listOfevents List of events
protected fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence	maneuverSequence Maneuvers sequence
protected fr.cnes.sirius.patrius.propagation.MassProvider	massModel Mass model (from the Assembly)
protected fr.cnes.dynvol.psimu.calc.output.OutputConfig	output Output configuration
protected fr.cnes.dynvol.psimu.calc.main.Psimu	psimu PSIMU object
protected fr.cnes.sirius.patrius.bodies.CelestialBody	sun Sun ephemeris
protected fr.cnes.sirius.patrius.assembly.Vehicle	vehicle Vehicle characteristics

Constructor Summary

Constructors

Constructor and Description
AbstractGtmPropagator() Constructor.

Method Summary

Modifier and Type	Method and Description
int	getAmountOfPoints() Method to get the amount of points in the list of S/C states
fr.cnes.sirius.patrius.assembly.Assembly	getAssembly() Method to get the assembly.
fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid	getEllipsoid() Method to get the ellipsoid.
fr.cnes.sirius.patrius.orbits.Orbit	getIniOrbit() Method to get the initial orbit.
Map<String,Object>	getIniVariables() Method to get the list of variables of the first point of the ephemeris
Map<String,Object>	getLastVariables() Method to get the list of variables of the last point of the ephemeris
List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty>	getListOfEngines() Method to get the list of engine characteristics.
List<fr.cnes.sirius.patrius.assembly.properties.TankProperty>	getListOfTanks() Method to get the list of tank characteristics.
fr.cnes.sirius.patrius.propagation.MassProvider	getMassModel() Method to get the mass model.
fr.cnes.dynvol.psimu.calc.main.Psimu	getPsimu() Method to get the PSIMU object (needed fo other getters)
List<fr.cnes.sirius.patrius.propagation.SpacecraftState>	getSpacecraftStateList() Method to get the list of S/C states
Map<String,Object>	getVariables(int index) Method to get the list of variables with a given index in the ephemeris
void	propagate() Method to propagate the trajectory using PSIMU
void	setAttitude(fr.cnes.sirius.patrius.attitudes.AttitudeLaw law) Method to initialize attitude laws
protected abstract void	setDefaultAttitude() Method to initialize default attitude law
void	setEllipsoid(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid ellipsoid) Method to initialize the WGS 84 Earth ellipsoid
void	setEvents(List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsList) Method to initialize the list of events.
void	setForces(fr.cnes.sirius.patrius.forces.ForceModelsData forceModels) Method to initialize the forces models
void	setFramesConfiguration(fr.cnes.sirius.patrius.frames.configuration.FramesConfiguration config) Method to set the frames configuration
void	setIniOrbit(fr.cnes.sirius.patrius.orbits.Orbit orbit) Initial orbit initialization with a complete Orbit object
void	setManeuvers(fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence manSeq) Method to initialize the sequence of maneuvers (up to now, empty).
void	setOutputDir(String nameDir) Method to set the output directory.
abstract void	setPropagationData(double duration, double outputStep) Method to initialize the numerical integration data only with duration and output step.
void	setPropagationData(GtmPropagationData data) Method to initialize the numerical integration data with full data.
void	setVehicle(fr.cnes.sirius.patrius.assembly.Vehicle veh) Vehicle initialization with a complete Vehicle object

Methods inherited from class java.lang.Object

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

Field Detail

iniOrbit

protected fr.cnes.sirius.patrius.orbits.Orbit iniOrbit

Initial orbit

ellips

protected fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid ellips

Earth ellipsoid

vehicle

protected fr.cnes.sirius.patrius.assembly.Vehicle vehicle

Vehicle characteristics

assembly

protected fr.cnes.sirius.patrius.assembly.Assembly assembly

Assembly (from the vehicle)

massModel

protected fr.cnes.sirius.patrius.propagation.MassProvider massModel

Mass model (from the Assembly)

maneuverSequence

protected fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence maneuverSequence

Maneuvers sequence

attitudeLaw

protected fr.cnes.sirius.patrius.attitudes.AttitudeProvider attitudeLaw

Attitude law

integData

protected fr.cnes.dynvol.psimu.calc.integrator.AbstractNumericalIntegratorData integData

Integrator data

output

protected fr.cnes.dynvol.psimu.calc.output.OutputConfig output

Output configuration

forces

protected fr.cnes.sirius.patrius.forces.ForceModelsData forces

Forces

sun

protected fr.cnes.sirius.patrius.bodies.CelestialBody sun

Sun ephemeris

listOfevents

protected List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> listOfevents

List of events

psimu

protected fr.cnes.dynvol.psimu.calc.main.Psimu psimu

PSIMU object

Constructor Detail

AbstractGtmPropagator

public AbstractGtmPropagator()
                      throws GtmInitException

Constructor.

Throws:

GtmInitException - occured when initializing the Earth ellipsoid

Method Detail

setFramesConfiguration

public void setFramesConfiguration(fr.cnes.sirius.patrius.frames.configuration.FramesConfiguration config)

Method to set the frames configuration

Parameters:

config - frames configuration

setEllipsoid

public void setEllipsoid(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid ellipsoid)

Method to initialize the WGS 84 Earth ellipsoid

Parameters:

ellipsoid - Earth ellipsoid

getEllipsoid

public fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid getEllipsoid()

Method to get the ellipsoid.

Returns:

ellipsoid

setIniOrbit

public void setIniOrbit(fr.cnes.sirius.patrius.orbits.Orbit orbit)

Initial orbit initialization with a complete Orbit object

Parameters:

orbit - initial orbit

getIniOrbit

public fr.cnes.sirius.patrius.orbits.Orbit getIniOrbit()

Method to get the initial orbit.

Returns:

initial orbit

setVehicle

public void setVehicle(fr.cnes.sirius.patrius.assembly.Vehicle veh)
                throws GtmInitException

Vehicle initialization with a complete Vehicle object

Parameters:

veh - Vehicle object

Throws:

GtmInitException - occured when initializing the assembly and mass model

getAssembly

public fr.cnes.sirius.patrius.assembly.Assembly getAssembly()

Method to get the assembly.

Returns:

assembly

getMassModel

public fr.cnes.sirius.patrius.propagation.MassProvider getMassModel()

Method to get the mass model.

Returns:

mass model

getListOfTanks

public List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> getListOfTanks()

Method to get the list of tank characteristics.

Returns:

tank characteristics

getListOfEngines

public List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> getListOfEngines()

Method to get the list of engine characteristics.

Returns:

engine characteristics

setForces

public void setForces(fr.cnes.sirius.patrius.forces.ForceModelsData forceModels)

Method to initialize the forces models

Parameters:

forceModels - forces models

setManeuvers

public void setManeuvers(fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence manSeq)

Method to initialize the sequence of maneuvers (up to now, empty).

Parameters:

manSeq - sequence of maneuvers

setDefaultAttitude

protected abstract void setDefaultAttitude()
                                    throws GtmInitException

Method to initialize default attitude law

Throws:

GtmInitException - exception occured when initialization of the default attitude

setAttitude

public void setAttitude(fr.cnes.sirius.patrius.attitudes.AttitudeLaw law)
                 throws GtmInitException

Method to initialize attitude laws

Parameters:

law - attitude law

Throws:

GtmInitException - exception occured when initialization of the sequence

setPropagationData

public abstract void setPropagationData(double duration,
                                        double outputStep)
                                 throws GtmInitException

Method to initialize the numerical integration data only with duration and output step.

Parameters:

duration - duration of the simulation (s)

outputStep - output step (s)

Throws:

GtmInitException - occured when initializing integrator data

setPropagationData

public void setPropagationData(GtmPropagationData data)
                        throws GtmInitException

Method to initialize the numerical integration data with full data.

Parameters:

data - integration data

Throws:

GtmInitException - occured when initializing integrator data

setEvents

public void setEvents(List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsList)

Method to initialize the list of events.

Parameters:

eventsList - list of PSIMU events

propagate

public void propagate()
               throws GtmInitException,
                      GtmPropException

Method to propagate the trajectory using PSIMU

Throws:

GtmInitException - occured when initializing PSIMU

GtmPropException - occured when propagating with PSIMU

setOutputDir

public void setOutputDir(String nameDir)

Method to set the output directory.

Parameters:

nameDir - output directory name

getAmountOfPoints

public int getAmountOfPoints()
                      throws GtmPropException

Method to get the amount of points in the list of S/C states

Returns:

amount of points in the list of S/C states

Throws:

GtmPropException - occured when getting S/C states

getSpacecraftStateList

public List<fr.cnes.sirius.patrius.propagation.SpacecraftState> getSpacecraftStateList()
                                                                                throws GtmPropException

Method to get the list of S/C states

Returns:

list of S/C states

Throws:

GtmPropException - occured when getting S/C states

getVariables

public Map<String,Object> getVariables(int index)
                                throws GtmPropException

Method to get the list of variables with a given index in the ephemeris

Parameters:

index - index in the ephemeris table

Returns:

list of PSIMU variables

Throws:

GtmPropException - occured when getting the list of PSIMU variables for a given index

getIniVariables

public Map<String,Object> getIniVariables()
                                   throws GtmPropException

Method to get the list of variables of the first point of the ephemeris

Returns:

list of PSIMU variables

Throws:

GtmPropException - occured when getting the list of PSIMU variables for the first point

getLastVariables

public Map<String,Object> getLastVariables()
                                    throws GtmPropException

Method to get the list of variables of the last point of the ephemeris

Returns:

list of PSIMU variables

Throws:

GtmPropException - occured when getting the list of PSIMU variables for the last point

getPsimu

public fr.cnes.dynvol.psimu.calc.main.Psimu getPsimu()

Method to get the PSIMU object (needed fo other getters)

Returns:

the psimu