fr.cnes.sirius.patrius.forces

Class ForceModelsData

java.lang.Object

fr.cnes.sirius.patrius.forces.ForceModelsData

public class ForceModelsData
extends Object

Class gathering force models in one single class. This class be used then to configure a propagator and modify/retrieve forces one by one.

Since:

4.1

Version:

$Id: MSISE2000.java 17794 2017-09-01 07:15:56Z bignon $

Author:

Marie Capot

Constructor Summary

Constructors

Constructor and Description
ForceModelsData() Default constructor.
ForceModelsData(ForceModel earthPotentialAttractionModelIn, SolarActivityDataProvider solarActivityDataProviderIn, SolarRadiationPressureEllipsoid solarRadiationPressureEllipsoidIn, RediffusedRadiationPressure rediffusedRadiationPressureIn, ThirdBodyAttraction moonThirdBodyAttractionIn, ThirdBodyAttraction sunThirdBodyAttractionIn, ThirdBodyAttraction venusThirdBodyAttractionIn, ThirdBodyAttraction marsThirdBodyAttractionIn, ThirdBodyAttraction jupiterThirdBodyAttractionIn, OceanTides oceanTidesIn, TerrestrialTides terrestrialTidesIn, DragForce dragForceIn, CoriolisRelativisticEffect coriolisRelativisticEffectIn, LenseThirringRelativisticEffect lenseThirringRelativisticEffectIn, SchwarzschildRelativisticEffect schwarzschildRelativisticEffectIn) Constructor.

Method Summary

Modifier and Type	Method and Description
CoriolisRelativisticEffect	getCoriolisRelativisticEffect()
DragForce	getDragForce()
ForceModel	getEarthPotentialAttractionModel()
List<ForceModel>	getForceModelsList() Returns a list of all added force models.
ThirdBodyAttraction	getJupiterThirdBodyAttraction()
LenseThirringRelativisticEffect	getLenseThirringRelativisticEffect()
ThirdBodyAttraction	getMarsThirdBodyAttraction()
ThirdBodyAttraction	getMoonThirdBodyAttraction()
OceanTides	getOceanTides()
RediffusedRadiationPressure	getRediffusedRadiationPressure()
SchwarzschildRelativisticEffect	getSchwarzschildRelativisticEffect()
SolarActivityDataProvider	getSolarActivityDataProvider()
SolarRadiationPressureEllipsoid	getSolarRadiationPressureEllipsoid()
ThirdBodyAttraction	getSunThirdBodyAttraction()
TerrestrialTides	getTerrestrialTides()
ThirdBodyAttraction	getVenusThirdBodyAttraction()
void	setCoriolisRelativisticEffect(CoriolisRelativisticEffect coriolisRelativisticEffectIn)
void	setDragForce(DragForce dragForceIn)
void	setEarthPotentialAttractionModel(ForceModel earthPotentialAttractionModelIn)
void	setJupiterThirdBodyAttraction(ThirdBodyAttraction jupiterThirdBodyAttractionIn)
void	setLenseThirringRelativisticEffect(LenseThirringRelativisticEffect lenseThirring)
void	setMarsThirdBodyAttraction(ThirdBodyAttraction marsThirdBodyAttractionIn)
void	setMoonThirdBodyAttraction(ThirdBodyAttraction moonThirdBodyAttractionIn)
void	setOceanTides(OceanTides oceanTidesIn)
void	setRediffusedRadiationPressure(RediffusedRadiationPressure rediffusedRadiationPressureIn)
void	setSchwarzschildRelativisticEffect(SchwarzschildRelativisticEffect schwarzschildRelativistic)
void	setSolarActivityDataProvider(SolarActivityDataProvider solarActivityDataProviderIn)
void	setSolarRadiationPressureEllipsoid(SolarRadiationPressureEllipsoid srp)
void	setSunThirdBodyAttraction(ThirdBodyAttraction sunThirdBodyAttractionIn)
void	setTerrestrialTides(TerrestrialTides terrestrialTidesIn)
void	setVenusThirdBodyAttraction(ThirdBodyAttraction venusThirdBodyAttractionIn)
void	updateAssembly(Assembly assembly) Method to update the force models depending on the assembly (DragForce, CustomSolarRadiationPressureEllipsoidCircular and CustomRediffusedRadiationPressure).

Methods inherited from class java.lang.Object

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

Constructor Detail

ForceModelsData

public ForceModelsData()

Default constructor.

ForceModelsData

public ForceModelsData(ForceModel earthPotentialAttractionModelIn,
                       SolarActivityDataProvider solarActivityDataProviderIn,
                       SolarRadiationPressureEllipsoid solarRadiationPressureEllipsoidIn,
                       RediffusedRadiationPressure rediffusedRadiationPressureIn,
                       ThirdBodyAttraction moonThirdBodyAttractionIn,
                       ThirdBodyAttraction sunThirdBodyAttractionIn,
                       ThirdBodyAttraction venusThirdBodyAttractionIn,
                       ThirdBodyAttraction marsThirdBodyAttractionIn,
                       ThirdBodyAttraction jupiterThirdBodyAttractionIn,
                       OceanTides oceanTidesIn,
                       TerrestrialTides terrestrialTidesIn,
                       DragForce dragForceIn,
                       CoriolisRelativisticEffect coriolisRelativisticEffectIn,
                       LenseThirringRelativisticEffect lenseThirringRelativisticEffectIn,
                       SchwarzschildRelativisticEffect schwarzschildRelativisticEffectIn)

Constructor.

Parameters:

earthPotentialAttractionModelIn - the attraction model of earth potential

solarActivityDataProviderIn - solar activity data provider

solarRadiationPressureEllipsoidIn - model of the solar radiation pressure

rediffusedRadiationPressureIn - model of rediffused radiation pressure

moonThirdBodyAttractionIn - force model of the third body attraction: the moon

sunThirdBodyAttractionIn - force model of the third body attraction: the sun

venusThirdBodyAttractionIn - force model of the third body attraction: venus

marsThirdBodyAttractionIn - force model of the third body attraction: mars

jupiterThirdBodyAttractionIn - force model of the third body attraction: jupiter

oceanTidesIn - ocean tides

terrestrialTidesIn - terrestrial tides

dragForceIn - drag force

coriolisRelativisticEffectIn - Coriolis relativistic effect

lenseThirringRelativisticEffectIn - Lense-Thirring relativistic effect

schwarzschildRelativisticEffectIn - Schwarzschild relativistic effect

Method Detail

updateAssembly

public void updateAssembly(Assembly assembly)
                    throws PatriusException

Method to update the force models depending on the assembly (DragForce, CustomSolarRadiationPressureEllipsoidCircular and CustomRediffusedRadiationPressure).

Parameters:

assembly - to update the force models depending on it.

Throws:

PatriusException - if the assembly does not have only one valid aerodynamic property or if it has no radiative properties found

getEarthPotentialAttractionModel

public ForceModel getEarthPotentialAttractionModel()

Returns:

the Earth potential model

setEarthPotentialAttractionModel

public void setEarthPotentialAttractionModel(ForceModel earthPotentialAttractionModelIn)

Parameters:

earthPotentialAttractionModelIn - the Earth potential model to set

getSolarActivityDataProvider

public SolarActivityDataProvider getSolarActivityDataProvider()

Returns:

the solar activity data provider

setSolarActivityDataProvider

public void setSolarActivityDataProvider(SolarActivityDataProvider solarActivityDataProviderIn)

Parameters:

solarActivityDataProviderIn - the solar activity data provider to set

getSolarRadiationPressureEllipsoid

public SolarRadiationPressureEllipsoid getSolarRadiationPressureEllipsoid()

Returns:

the solar radiation pressure

setSolarRadiationPressureEllipsoid

public void setSolarRadiationPressureEllipsoid(SolarRadiationPressureEllipsoid srp)

Parameters:

srp - the solar radiation pressure to set

getRediffusedRadiationPressure

public RediffusedRadiationPressure getRediffusedRadiationPressure()

Returns:

the rediffused radiation pressure

setRediffusedRadiationPressure

public void setRediffusedRadiationPressure(RediffusedRadiationPressure rediffusedRadiationPressureIn)

Parameters:

rediffusedRadiationPressureIn - the rediffused radiation pressure to set

getMoonThirdBodyAttraction

public ThirdBodyAttraction getMoonThirdBodyAttraction()

Returns:

the Moon attraction

setMoonThirdBodyAttraction

public void setMoonThirdBodyAttraction(ThirdBodyAttraction moonThirdBodyAttractionIn)

Parameters:

moonThirdBodyAttractionIn - the Moon attraction to set

getSunThirdBodyAttraction

public ThirdBodyAttraction getSunThirdBodyAttraction()

Returns:

the Sun attraction

setSunThirdBodyAttraction

public void setSunThirdBodyAttraction(ThirdBodyAttraction sunThirdBodyAttractionIn)

Parameters:

sunThirdBodyAttractionIn - the Sun attraction to set

getVenusThirdBodyAttraction

public ThirdBodyAttraction getVenusThirdBodyAttraction()

Returns:

the Venus attraction

setVenusThirdBodyAttraction

public void setVenusThirdBodyAttraction(ThirdBodyAttraction venusThirdBodyAttractionIn)

Parameters:

venusThirdBodyAttractionIn - the Venus attraction to set

getMarsThirdBodyAttraction

public ThirdBodyAttraction getMarsThirdBodyAttraction()

Returns:

the Mars attraction

setMarsThirdBodyAttraction

public void setMarsThirdBodyAttraction(ThirdBodyAttraction marsThirdBodyAttractionIn)

Parameters:

marsThirdBodyAttractionIn - the Mars attraction to set

getJupiterThirdBodyAttraction

public ThirdBodyAttraction getJupiterThirdBodyAttraction()

Returns:

the Jupiter attraction

setJupiterThirdBodyAttraction

public void setJupiterThirdBodyAttraction(ThirdBodyAttraction jupiterThirdBodyAttractionIn)

Parameters:

jupiterThirdBodyAttractionIn - the Jupiter attraction to set

getOceanTides

public OceanTides getOceanTides()

Returns:

the oceanic tides

setOceanTides

public void setOceanTides(OceanTides oceanTidesIn)

Parameters:

oceanTidesIn - the oceanic tides to set

getTerrestrialTides

public TerrestrialTides getTerrestrialTides()

Returns:

the terrestrial tides

setTerrestrialTides

public void setTerrestrialTides(TerrestrialTides terrestrialTidesIn)

Parameters:

terrestrialTidesIn - the terrestrial tides to set

getDragForce

public DragForce getDragForce()

Returns:

the drag force

setDragForce

public void setDragForce(DragForce dragForceIn)

Parameters:

dragForceIn - the drag force to set

getCoriolisRelativisticEffect

public CoriolisRelativisticEffect getCoriolisRelativisticEffect()

Returns:

the Coriolis relativistic effect

setCoriolisRelativisticEffect

public void setCoriolisRelativisticEffect(CoriolisRelativisticEffect coriolisRelativisticEffectIn)

Parameters:

coriolisRelativisticEffectIn - the Coriolis relativistic effect to set

getLenseThirringRelativisticEffect

public LenseThirringRelativisticEffect getLenseThirringRelativisticEffect()

Returns:

the Lense Thirring relativistic effect

setLenseThirringRelativisticEffect

public void setLenseThirringRelativisticEffect(LenseThirringRelativisticEffect lenseThirring)

Parameters:

lenseThirring - the Lense Thirring relativistic effect to set

getSchwarzschildRelativisticEffect

public SchwarzschildRelativisticEffect getSchwarzschildRelativisticEffect()

Returns:

the Schwarzschild relativistic effect

setSchwarzschildRelativisticEffect

public void setSchwarzschildRelativisticEffect(SchwarzschildRelativisticEffect schwarzschildRelativistic)

Parameters:

schwarzschildRelativistic - the Schwarzschild relativistic effect to set

getForceModelsList

public List<ForceModel> getForceModelsList()

Returns a list of all added force models.

Returns:

the force models as a list