fr.cnes.dynvol.psimu.calc.main

Class Psimu

java.lang.Object

fr.cnes.dynvol.psimu.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(fr.cnes.sirius.patrius.orbits.Orbit initialOrbitIn, fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid earthIn, UserFramesConfsEnum userFramesConfigurationIn, AbstractNumericalIntegratorData numericalIntegratorDataIn, fr.cnes.sirius.patrius.assembly.Vehicle vehicleIn, fr.cnes.sirius.patrius.propagation.MassProvider massModelIn, fr.cnes.sirius.patrius.forces.ForceModelsData forceModelsIn, fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence maneuversSeq, fr.cnes.sirius.patrius.attitudes.AttitudeProvider attitudesSequenceIn) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addForceModel(fr.cnes.sirius.patrius.forces.ForceModel forceModel) Method to add an external force model to the numerical propagator.
void	closeDataBaseConnection() Close database connection.
fr.cnes.sirius.patrius.assembly.Assembly	getAssembly() Get assembly.
fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid	getEarth() Get Earth shape.
fr.cnes.sirius.patrius.forces.ForceModelsData	getfModels() Get force models.
fr.cnes.sirius.patrius.orbits.Orbit	getInitialOrbit() Get initial orbit.
fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence	getManeuversSequence() Get maneuvers data.
fr.cnes.sirius.patrius.propagation.MassProvider	getMassModel() Get the mass model.
fr.cnes.sirius.patrius.propagation.numerical.NumericalPropagator	getNumPropagator() Get the numerical propagator.
double	getPropagationDuration() Get propagation duration.
fr.cnes.sirius.patrius.propagation.SpacecraftState	getSpacecraftState(int index) Get the spacecraft state with the requested index.
List<fr.cnes.sirius.patrius.propagation.SpacecraftState>	getSpacecraftStateList() Get the list of spacecraft state after a propagation in master mode.
fr.cnes.sirius.patrius.propagation.SpacecraftState	getSpacecraftStateOnlyEvents(int index) Get the spacecraft state with the requested index from a list without events.
List<fr.cnes.sirius.patrius.propagation.SpacecraftState>	getSpacecraftStateOnlyEventsList() Get the list of events spacecraft state after a propagation in master mode.
fr.cnes.sirius.patrius.propagation.SpacecraftState	getSpacecraftStateWithoutEvents(int index) Get the spacecraft state with the requested index from a list without events.
List<fr.cnes.sirius.patrius.propagation.SpacecraftState>	getSpacecraftStateWithoutEventsList() Get the list of spacecraft state without events after a propagation in master mode.
Object	getVariable(int index, String key) Method to get an element of a list of output variables (given by the index).
Object	getVariableOnlyEvents(int index, String key) Method to get an element of a list of output variables (given by the index) only for events.
Map<String,Object>	getVariables(int index) Method to get a list of output variables (given by the index).
List<Map<String,Object>>	getVariablesList() Method to get lists of output variables.
Map<String,Object>	getVariablesOnlyEvents(int index) Method to get a list of output variables (given by the index) only for events.
List<Map<String,Object>>	getVariablesOnlyEventsList() Method to get lists of output variables only for events.
Map<String,Object>	getVariablesWithoutEvents(int index) Method to get a list of output variables (given by the index) without events.
List<Map<String,Object>>	getVariablesWithoutEventsList() Method to get lists of output variables without events.
Object	getVariableWithoutEvents(int index, String key) Method to get an element of a list of output variables (given by the index) without events.
void	printSV(String title, fr.cnes.sirius.patrius.orbits.Orbit originalOrbit, fr.cnes.sirius.patrius.frames.Frame outputFrame, fr.cnes.sirius.patrius.propagation.MassProvider massModelIn) 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.
void	propagateInMasterMode(OutputConfig outputConfig, List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect, Psimu.StorageType storageMemory, Psimu.StorageType storageFile) Method to propagate the orbit in IHM mode.
void	propagateInMasterMode(OutputConfig outputConfig, List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect, Psimu.StorageType storageMemory, Psimu.StorageType storageFile, String resultName) Method to propagate the orbit in IHM mode.
void	propagateInMasterMode(OutputConfig outputConfig, List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect, Psimu.StorageType storageType, String resultName) Method to propagate the orbit in IHM mode.
fr.cnes.sirius.patrius.propagation.SpacecraftState	propagateInSlaveMode() Method to propagate the orbit in slave mode.
void	saveVTSFiles(String outputDir, String resultName) Save the VTS files.
void	saveVTSFiles(String outputDir, String resultName, String dateTime) Save the VTS files.
void	saveVTSFiles(String outputDir, String resultName, String dateTime, String varListFilename) 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(fr.cnes.sirius.patrius.orbits.Orbit initialOrbitIn,
             fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid earthIn,
             UserFramesConfsEnum userFramesConfigurationIn,
             AbstractNumericalIntegratorData numericalIntegratorDataIn,
             fr.cnes.sirius.patrius.assembly.Vehicle vehicleIn,
             fr.cnes.sirius.patrius.propagation.MassProvider massModelIn,
             fr.cnes.sirius.patrius.forces.ForceModelsData forceModelsIn,
             fr.cnes.genopus.nonWidget.maneuvers.CustomManeuverSequence maneuversSeq,
             fr.cnes.sirius.patrius.attitudes.AttitudeProvider attitudesSequenceIn)
      throws PsimuException

Creates a new instance.

Parameters:

earthIn - earth shape.

userFramesConfigurationIn - user frames configuration.

initialOrbitIn - initial orbit to propagate

numericalIntegratorDataIn - numerical integrator data

vehicleIn - vehicle

massModelIn - mass model.

forceModelsIn - force models.

maneuversSeq - maneuvers sequence.

attitudesSequenceIn - 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 fr.cnes.sirius.patrius.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:

PsimuPropagationException - psimu exception

propagateInMasterMode

public void propagateInMasterMode(OutputConfig outputConfig,
                                  List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect,
                                  Psimu.StorageType storageType,
                                  String resultName)
                           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.

resultName - prefix for the results.

Throws:

PsimuPropagationException - psimu exception

propagateInMasterMode

public void propagateInMasterMode(OutputConfig outputConfig,
                                  List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect,
                                  Psimu.StorageType storageMemory,
                                  Psimu.StorageType storageFile)
                           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)

storageMemory - memory storage type to save the results.

storageFile - file storage type to save the results.

Throws:

PsimuPropagationException - psimu exception

propagateInMasterMode

public void propagateInMasterMode(OutputConfig outputConfig,
                                  List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> eventsToDetect,
                                  Psimu.StorageType storageMemory,
                                  Psimu.StorageType storageFile,
                                  String resultName)
                           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)

storageMemory - memory storage type to save the results.

storageFile - file storage type to save the results.

resultName - prefix for the results.

Throws:

PsimuPropagationException - psimu exception

getVariablesList

public List<Map<String,Object>> getVariablesList()
                                          throws PsimuException

Method to get lists of output variables.

Returns:

lists of output variables

Throws:

PsimuException - if problem when getting the list

getVariablesWithoutEventsList

public List<Map<String,Object>> getVariablesWithoutEventsList()
                                                       throws PsimuException

Method to get lists of output variables without events.

Returns:

lists of output variables

Throws:

PsimuException - if problem when getting the list

getVariablesOnlyEventsList

public List<Map<String,Object>> getVariablesOnlyEventsList()
                                                    throws PsimuException

Method to get lists of output variables only for events.

Returns:

lists of output variables

Throws:

PsimuException - if problem when getting the list

getVariables

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

Method to get a list of output variables (given by the index).

Parameters:

index - index in the list

Returns:

list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getVariablesWithoutEvents

public Map<String,Object> getVariablesWithoutEvents(int index)
                                             throws PsimuOutputManagerException

Method to get a list of output variables (given by the index) without events.

Parameters:

index - index in the list

Returns:

list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getVariablesOnlyEvents

public Map<String,Object> getVariablesOnlyEvents(int index)
                                          throws PsimuOutputManagerException

Method to get a list of output variables (given by the index) only for events.

Parameters:

index - index in the list

Returns:

list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getVariable

public Object getVariable(int index,
                          String key)
                   throws PsimuOutputManagerException

Method to get an element of a list of output variables (given by the index).

Parameters:

index - index in the list

key - key parameter defining the element.

Returns:

element of a list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getVariableWithoutEvents

public Object getVariableWithoutEvents(int index,
                                       String key)
                                throws PsimuOutputManagerException

Method to get an element of a list of output variables (given by the index) without events.

Parameters:

index - index in the list

key - key parameter defining the element.

Returns:

element of a list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getVariableOnlyEvents

public Object getVariableOnlyEvents(int index,
                                    String key)
                             throws PsimuOutputManagerException

Method to get an element of a list of output variables (given by the index) only for events.

Parameters:

index - index in the list

key - key parameter defining the element.

Returns:

element of a list of output variables

Throws:

PsimuOutputManagerException - output manager exception

getSpacecraftStateList

public List<fr.cnes.sirius.patrius.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.

getSpacecraftStateWithoutEventsList

public List<fr.cnes.sirius.patrius.propagation.SpacecraftState> getSpacecraftStateWithoutEventsList()
                                                                                             throws PsimuException

Get the list of spacecraft state without events 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.

getSpacecraftStateOnlyEventsList

public List<fr.cnes.sirius.patrius.propagation.SpacecraftState> getSpacecraftStateOnlyEventsList()
                                                                                          throws PsimuException

Get the list of events 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 fr.cnes.sirius.patrius.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.

getSpacecraftStateWithoutEvents

public fr.cnes.sirius.patrius.propagation.SpacecraftState getSpacecraftStateWithoutEvents(int index)
                                                                                   throws PsimuException

Get the spacecraft state with the requested index from a list without events.

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.

getSpacecraftStateOnlyEvents

public fr.cnes.sirius.patrius.propagation.SpacecraftState getSpacecraftStateOnlyEvents(int index)
                                                                                throws PsimuException

Get the spacecraft state with the requested index from a list without events.

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 fr.cnes.sirius.patrius.propagation.numerical.NumericalPropagator getNumPropagator()

Get the numerical propagator.

Returns:

the numerical propagator

getMassModel

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

Get the mass model.

Returns:

the massModel the mass model

getfModels

public fr.cnes.sirius.patrius.forces.ForceModelsData getfModels()

Get force models.

Returns:

the fModels

getInitialOrbit

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

Get initial orbit.

Returns:

the initialOrbit

getEarth

public fr.cnes.sirius.patrius.bodies.OneAxisEllipsoid 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,
                    fr.cnes.sirius.patrius.orbits.Orbit originalOrbit,
                    fr.cnes.sirius.patrius.frames.Frame outputFrame,
                    fr.cnes.sirius.patrius.propagation.MassProvider massModelIn)
             throws fr.cnes.sirius.patrius.utils.exception.PatriusException

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

massModelIn - mass model

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException - if internal error occurs

addForceModel

public void addForceModel(fr.cnes.sirius.patrius.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.

saveVTSFiles

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

Save the VTS files.

Parameters:

outputDir - output directory.

resultName - result name to compose the filename.

dateTime - current date-time.

Throws:

PsimuException - In case the files cannot be generated.

saveVTSFiles

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

Save the VTS files.

Parameters:

outputDir - output directory.

resultName - result name to compose the filename.

dateTime - current date-time.

varListFilename - name of the file containing the list of output variables.

Throws:

PsimuException - In case the files cannot be generated.

closeDataBaseConnection

public void closeDataBaseConnection()

Close database connection.