calc.main

Class Psimu

java.lang.Object

calc.main.Psimu

public class Psimu
extends Object

Psimu subroutine mode. It allows to 1) create a numerical propagator, 2) to propagate and 3) to recover and save the results in terms of spacecraft states and ephemerides/ coded events output files.

Author:

sumelzi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Psimu.StorageType Enumerate to choose the storage type to use for the results when running in master mode.

Constructor Summary

Constructors

Constructor and Description

Psimu(org.orekit.orbits.Orbit initialOrbit, org.orekit.bodies.ExtendedOneAxisEllipsoid earth, UserFramesConfsEnum userFramesConfiguration, AbstractNumericalIntegratorData numericalIntegratorData, fr.cnes.sirius.patrius.assembly.Assembly assembly, org.orekit.propagation.MassProvider massModel, fr.cnes.genopus.nonWidget.forces.CustomForceModels forceModels, fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence maneuversSeq, org.orekit.attitudes.AttitudeProvider attitudesSequence) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addForceModel(org.orekit.forces.ForceModel forceModel) Method to add an external force model to the numerical propagator.
fr.cnes.sirius.patrius.assembly.Assembly	getAssembly() Get assembly.
org.orekit.bodies.ExtendedOneAxisEllipsoid	getEarth() Get Earth shape.
fr.cnes.genopus.nonWidget.forces.CustomForceModels	getfModels() Get force models.
org.orekit.orbits.Orbit	getInitialOrbit() Get initial orbit.
fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence	getManeuversSequence() Get maneuvers data.
org.orekit.propagation.MassProvider	getMassModel() Get the mass model.
org.orekit.propagation.numerical.NumericalPropagator	getNumPropagator() Get the numerical propagator.
double	getPropagationDuration() Get propagation duration.
org.orekit.propagation.SpacecraftState	getSpacecraftState(int index) Get the spacecraft state with the requested index.
List<org.orekit.propagation.SpacecraftState>	getSpacecraftStateList() Get the list of spacecraft state after a propagation in master mode.
void	printSV(String title, org.orekit.orbits.Orbit originalOrbit, org.orekit.frames.Frame outputFrame, org.orekit.propagation.MassProvider massModel) Prints the spacecraft state (epoch, frame, mass, Cartesian and Keplerian parameters).
void	propagateInMasterMode(OutputConfig outputConfig, List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect, Psimu.StorageType storageType) Method to propagate the orbit in IHM mode.
org.orekit.propagation.SpacecraftState	propagateInSlaveMode() Method to propagate the orbit in slave mode.
void	saveVTSFiles(String outputDir, String resultName) Save the VTS files.

Methods inherited from class java.lang.Object

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

Constructor Detail

Psimu

public Psimu(org.orekit.orbits.Orbit initialOrbit,
     org.orekit.bodies.ExtendedOneAxisEllipsoid earth,
     UserFramesConfsEnum userFramesConfiguration,
     AbstractNumericalIntegratorData numericalIntegratorData,
     fr.cnes.sirius.patrius.assembly.Assembly assembly,
     org.orekit.propagation.MassProvider massModel,
     fr.cnes.genopus.nonWidget.forces.CustomForceModels forceModels,
     fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence maneuversSeq,
     org.orekit.attitudes.AttitudeProvider attitudesSequence)
      throws PsimuException

Creates a new instance.

Parameters:

earth - earth shape.

userFramesConfiguration - user frames configuration.

initialOrbit - initial orbit to propagate

numericalIntegratorData - numerical integrator data

assembly - vehicle assembly

massModel - mass model.

forceModels - force models.

maneuversSeq - maneouvres sequence.

attitudesSequence - attitude sequence (it might be null if no attitude laws are expected)

Throws:

PsimuException - in case of problem creating the propagator.

Method Detail

propagateInSlaveMode

public org.orekit.propagation.SpacecraftState propagateInSlaveMode()
                                                            throws PsimuPropagationException

Method to propagate the orbit in slave mode.

Returns:

the final spacecraft state.

Throws:

PsimuPropagationException - in case the propagation fails.

propagateInMasterMode

public void propagateInMasterMode(OutputConfig outputConfig,
                         List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect,
                         Psimu.StorageType storageType)
                           throws PsimuPropagationException

Method to propagate the orbit in IHM mode. It propagates the orbit in master mode defined by the output frequency demanded by the user. After propagation results are possible to retrieve by calling calc.main.Psimu.getListOfSpacecraftStates().

Parameters:

eventsToDetect - list of events to detect (it might be null if no single events have to be detected)

outputConfig - output configuration (it might be null for slave mode propagation)

storageType - storage type to save the results.

Throws:

org.orekit.errors.OrekitException - if some internal error occurs

IllegalArgumentException - illegal argument exception

PsimuPropagationException - psimu exception

getSpacecraftStateList

public List<org.orekit.propagation.SpacecraftState> getSpacecraftStateList()
                                                                    throws PsimuException

Get the list of spacecraft state after a propagation in master mode.

Returns:

the list of spacecraft state after a propagation in master mode.

Throws:

PsimuException - if the list does not exist because the propagation has not been performed or because it was done un FILE storage mode.

getSpacecraftState

public org.orekit.propagation.SpacecraftState getSpacecraftState(int index)
                                                          throws PsimuException

Get the spacecraft state with the requested index.

Parameters:

index - index of the spacecraft state to get.

Returns:

the spacecraft state with the requested index.

Throws:

PsimuException - if the list does not exist because the propagation has not been performed or because it was done un FILE storage mode.

getManeuversSequence

public fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence getManeuversSequence()

Get maneuvers data.

Returns:

the maneuvers data

getNumPropagator

public org.orekit.propagation.numerical.NumericalPropagator getNumPropagator()

Get the numerical propagator.

Returns:

the numerical propagator

getMassModel

public org.orekit.propagation.MassProvider getMassModel()

Get the mass model.

Returns:

the massModel the mass model

getfModels

public fr.cnes.genopus.nonWidget.forces.CustomForceModels getfModels()

Get force models.

Returns:

the fModels

getInitialOrbit

public org.orekit.orbits.Orbit getInitialOrbit()

Get initial orbit.

Returns:

the initialOrbit

getEarth

public org.orekit.bodies.ExtendedOneAxisEllipsoid getEarth()

Get Earth shape.

Returns:

Earth shape.

getPropagationDuration

public double getPropagationDuration()

Get propagation duration.

Returns:

the propagationDuration

getAssembly

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

Get assembly.

Returns:

the assembly

printSV

public void printSV(String title,
           org.orekit.orbits.Orbit originalOrbit,
           org.orekit.frames.Frame outputFrame,
           org.orekit.propagation.MassProvider massModel)
             throws org.orekit.errors.OrekitException

Prints the spacecraft state (epoch, frame, mass, Cartesian and Keplerian parameters). Verbose mode must be on. It is off by default in subroutine mode (method AppPSimu.setVerbose(boolean) is available to modify it).

Parameters:

title - title

originalOrbit - original orbit

outputFrame - output frame

massModel - mass model

Throws:

org.orekit.errors.OrekitException - if internal error occurs

addForceModel

public void addForceModel(org.orekit.forces.ForceModel forceModel)
                   throws PsimuException

Method to add an external force model to the numerical propagator.

Parameters:

forceModel - force model to be added.

Throws:

PsimuException - if force model is null or if its acceleration cannot be computed.

saveVTSFiles

public void saveVTSFiles(String outputDir,
                String resultName)
                  throws PsimuException

Save the VTS files.

Parameters:

outputDir - output directory.

resultName - result name to compose the filename.

Throws:

PsimuException - In case the files cannot be generated.