Package org.orekit.files.ccsds.ndm.odm.ocm

Class Perturbations

  • All Implemented Interfaces:
    Section
    public class Perturbations
extends CommentsContainer
    Perturbation parameters.

    Beware that the Orekit getters and setters all rely on SI units. The parsers and writers take care of converting these SI units into CCSDS mandatory units. The Unit class provides useful fromSi and toSI methods in case the callers already use CCSDS units instead of the API SI units. The general-purpose Unit class (without an 's') and the CCSDS-specific Units class (with an 's') also provide some predefined units. These predefined units and the fromSi and toSI conversion methods are indeed what the parsers and writers use for the conversions.

    Since:
    11.0
    Author:
    Luc Maisonobe

    • Constructor Detail

      • Perturbations

        public Perturbations​(CelestialBodies celestialBodies)
        Simple constructor.
        Parameters:
        celestialBodies - factory for celestial bodies

    • Method Detail

      • getAtmosphericModel

        public String getAtmosphericModel()
        Get name of atmospheric model.
        Returns:
        name of atmospheric model

      • setAtmosphericModel

        public void setAtmosphericModel​(String atmosphericModel)
        Set name of atmospheric model.
        Parameters:
        atmosphericModel - name of atmospheric model

      • getGravityModel

        public String getGravityModel()
        Get gravity model name.
        Returns:
        gravity model name

      • getGravityDegree

        public int getGravityDegree()
        Get degree of the gravity model.
        Returns:
        degree of the gravity model

      • getGravityOrder

        public int getGravityOrder()
        Get order of the gravity model.
        Returns:
        order of the gravity model

      • setGravityModel

        public void setGravityModel​(String name,
                            int degree,
                            int order)
        Set gravity model.
        Parameters:
        name - name of the model
        degree - degree of the model
        order - order of the model

      • getEquatorialRadius

        public double getEquatorialRadius()
        Get oblate spheroid equatorial radius of central body.
        Returns:
        oblate spheroid equatorial radius of central body

      • setEquatorialRadius

        public void setEquatorialRadius​(double equatorialRadius)
        Set oblate spheroid equatorial radius of central body.
        Parameters:
        equatorialRadius - oblate spheroid equatorial radius of central body

      • getGm

        public double getGm()
        Get gravitational coefficient of attracting body.
        Returns:
        gravitational coefficient of attracting body

      • setGm

        public void setGm​(double gm)
        Set gravitational coefficient of attracting body.
        Parameters:
        gm - gravitational coefficient of attracting body

      • getNBodyPerturbations

        public List<BodyFacade> getNBodyPerturbations()
        Get n-body perturbation bodies.
        Returns:
        n-body perturbation bodies

      • setNBodyPerturbations

        public void setNBodyPerturbations​(List<BodyFacade> nBody)
        Set n-body perturbation bodies.
        Parameters:
        nBody - n-body perturbation bodies

      • getCentralBodyRotation

        public double getCentralBodyRotation()
        Get central body angular rotation rate.
        Returns:
        central body angular rotation rate

      • setCentralBodyRotation

        public void setCentralBodyRotation​(double centralBodyRotation)
        Set central body angular rotation rate.
        Parameters:
        centralBodyRotation - central body angular rotation rate

      • getOblateFlattening

        public double getOblateFlattening()
        Get central body oblate spheroid oblateness.
        Returns:
        central body oblate spheroid oblateness

      • setOblateFlattening

        public void setOblateFlattening​(double oblateFlattening)
        Set central body oblate spheroid oblateness.
        Parameters:
        oblateFlattening - central body oblate spheroid oblateness

      • getOceanTidesModel

        public String getOceanTidesModel()
        Get ocean tides model.
        Returns:
        ocean tides model

      • setOceanTidesModel

        public void setOceanTidesModel​(String oceanTidesModel)
        Set ocean tides model.
        Parameters:
        oceanTidesModel - ocean tides model

      • getSolidTidesModel

        public String getSolidTidesModel()
        Get solid tides model.
        Returns:
        solid tides model

      • setSolidTidesModel

        public void setSolidTidesModel​(String solidTidesModel)
        Set solid tides model.
        Parameters:
        solidTidesModel - solid tides model

      • getReductionTheory

        public String getReductionTheory()
        Get reduction theory used for precession and nutation modeling.
        Returns:
        reduction theory used for precession and nutation modeling

      • setReductionTheory

        public void setReductionTheory​(String reductionTheory)
        Set reduction theory used for precession and nutation modeling.
        Parameters:
        reductionTheory - reduction theory used for precession and nutation modeling

      • getAlbedoModel

        public String getAlbedoModel()
        Get albedo model.
        Returns:
        albedo model

      • setAlbedoModel

        public void setAlbedoModel​(String albedoModel)
        Set albedo model.
        Parameters:
        albedoModel - albedo model

      • getAlbedoGridSize

        public Integer getAlbedoGridSize()
        Get albedo grid size.
        Returns:
        albedo grid size

      • setAlbedoGridSize

        public void setAlbedoGridSize​(Integer albedoGridSize)
        Set albedo grid size.
        Parameters:
        albedoGridSize - albedo grid size

      • getShadowModel

        public ShadowModel getShadowModel()
        Get shadow model used for solar radiation pressure.
        Returns:
        shadow model used for solar radiation pressure

      • setShadowModel

        public void setShadowModel​(ShadowModel shadowModel)
        Set shadow model used for solar radiation pressure.
        Parameters:
        shadowModel - shadow model used for solar radiation pressure

      • getShadowBodies

        public List<BodyFacade> getShadowBodies()
        Get celestial bodies casting shadows.
        Returns:
        celestial bodies casting shadows

      • setShadowBodies

        public void setShadowBodies​(List<BodyFacade> shadowBodies)
        Set celestial bodies casting shadows.
        Parameters:
        shadowBodies - celestial bodies casting shadows

      • getSrpModel

        public String getSrpModel()
        Get Solar Radiation Pressure model.
        Returns:
        Solar Radiation Pressure model

      • setSrpModel

        public void setSrpModel​(String srpModel)
        Set Solar Radiation Pressure model.
        Parameters:
        srpModel - Solar Radiation Pressure model

      • getSpaceWeatherSource

        public String getSpaceWeatherSource()
        Get Space Weather data source.
        Returns:
        Space Weather data source

      • setSpaceWeatherSource

        public void setSpaceWeatherSource​(String spaceWeatherSource)
        Set Space Weather data source.
        Parameters:
        spaceWeatherSource - Space Weather data source

      • getSpaceWeatherEpoch

        public AbsoluteDate getSpaceWeatherEpoch()
        Get epoch of the Space Weather data.
        Returns:
        epoch of the Space Weather data

      • setSpaceWeatherEpoch

        public void setSpaceWeatherEpoch​(AbsoluteDate spaceWeatherEpoch)
        Set epoch of the Space Weather data.
        Parameters:
        spaceWeatherEpoch - epoch of the Space Weather data

      • getInterpMethodSW

        public String getInterpMethodSW()
        Get the interpolation method for Space Weather data.
        Returns:
        interpolation method for Space Weather data

      • setInterpMethodSW

        public void setInterpMethodSW​(String interpMethodSW)
        Set the interpolation method for Space Weather data.
        Parameters:
        interpMethodSW - interpolation method for Space Weather data

      • getFixedGeomagneticKp

        public double getFixedGeomagneticKp()
        Get fixed (time invariant) value of the planetary 3-hour-range geomagnetic index Kₚ.
        Returns:
        fixed (time invariant) value of the planetary 3-hour-range geomagnetic index Kₚ

      • setFixedGeomagneticKp

        public void setFixedGeomagneticKp​(double fixedGeomagneticKp)
        Set fixed (time invariant) value of the planetary 3-hour-range geomagnetic index Kₚ.
        Parameters:
        fixedGeomagneticKp - fixed (time invariant) value of the planetary 3-hour-range geomagnetic index Kₚ

      • getFixedGeomagneticAp

        public double getFixedGeomagneticAp()
        Get fixed (time invariant) value of the planetary 3-hour-range geomagnetic index aₚ.
        Returns:
        fixed (time invariant) value of the planetary 3-hour-range geomagnetic index aₚ

      • setFixedGeomagneticAp

        public void setFixedGeomagneticAp​(double fixedGeomagneticAp)
        Set fixed (time invariant) value of the planetary 3-hour-range geomagnetic index aₚ.
        Parameters:
        fixedGeomagneticAp - fixed (time invariant) value of the planetary 3-hour-range geomagnetic index aₚ

      • getFixedGeomagneticDst

        public double getFixedGeomagneticDst()
        Get fixed (time invariant) value of the planetary 1-hour-range geomagnetic index Dst.
        Returns:
        fixed (time invariant) value of the planetary 1-hour-range geomagnetic index Dst

      • setFixedGeomagneticDst

        public void setFixedGeomagneticDst​(double fixedGeomagneticDst)
        Set fixed (time invariant) value of the planetary 1-hour-range geomagnetic index Dst.
        Parameters:
        fixedGeomagneticDst - fixed (time invariant) value of the planetary 1-hour-range geomagnetic index Dst

      • getFixedF10P7

        public double getFixedF10P7()
        Get fixed (time invariant) value of the Solar Flux Unit daily proxy F10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux Unit daily proxy F10.7

      • setFixedF10P7

        public void setFixedF10P7​(double fixedF10P7)
        Set fixed (time invariant) value of the Solar Flux Unit daily proxy F10.7.
        Parameters:
        fixedF10P7 - fixed (time invariant) value of the Solar Flux Unit daily proxy F10.7

      • getFixedF10P7Mean

        public double getFixedF10P7Mean()
        Get fixed (time invariant) value of the Solar Flux Unit 81-day running center-average proxy F10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux Unit 81-day running center-average proxy F10.7

      • setFixedF10P7Mean

        public void setFixedF10P7Mean​(double fixedF10P7Mean)
        Set fixed (time invariant) value of the Solar Flux Unit 81-day running center-average proxy F10.7.
        Parameters:
        fixedF10P7Mean - fixed (time invariant) value of the Solar Flux Unit 81-day running center-average proxy F10.7

      • getFixedM10P7

        public double getFixedM10P7()
        Get fixed (time invariant) value of the Solar Flux daily proxy M10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux daily proxy M10.7

      • setFixedM10P7

        public void setFixedM10P7​(double fixedM10P7)
        Set fixed (time invariant) value of the Solar Flux daily proxy M10.7.
        Parameters:
        fixedM10P7 - fixed (time invariant) value of the Solar Flux daily proxy M10.7

      • getFixedM10P7Mean

        public double getFixedM10P7Mean()
        Get fixed (time invariant) value of the Solar Flux 81-day running center-average proxy M10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux 81-day running center-average proxy M10.7

      • setFixedM10P7Mean

        public void setFixedM10P7Mean​(double fixedM10P7Mean)
        Set fixed (time invariant) value of the Solar Flux 81-day running center-average proxy M10.7.
        Parameters:
        fixedM10P7Mean - fixed (time invariant) value of the Solar Flux 81-day running center-average proxy M10.7

      • getFixedS10P7

        public double getFixedS10P7()
        Get fixed (time invariant) value of the Solar Flux daily proxy S10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux daily proxy S10.7

      • setFixedS10P7

        public void setFixedS10P7​(double fixedS10P7)
        Set fixed (time invariant) value of the Solar Flux daily proxy S10.7.
        Parameters:
        fixedS10P7 - fixed (time invariant) value of the Solar Flux daily proxy S10.7

      • getFixedS10P7Mean

        public double getFixedS10P7Mean()
        Get fixed (time invariant) value of the Solar Flux 81-day running center-average proxy S10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux 81-day running center-average proxy S10.7

      • setFixedS10P7Mean

        public void setFixedS10P7Mean​(double fixedS10P7Mean)
        Set fixed (time invariant) value of the Solar Flux 81-day running center-average proxy S10.7.
        Parameters:
        fixedS10P7Mean - fixed (time invariant) value of the Solar Flux 81-day running center-average proxy S10.7

      • getFixedY10P7

        public double getFixedY10P7()
        Get fixed (time invariant) value of the Solar Flux daily proxy Y10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux daily proxy Y10.7

      • setFixedY10P7

        public void setFixedY10P7​(double fixedY10P7)
        Set fixed (time invariant) value of the Solar Flux daily proxy Y10.7.
        Parameters:
        fixedY10P7 - fixed (time invariant) value of the Solar Flux daily proxy Y10.7

      • getFixedY10P7Mean

        public double getFixedY10P7Mean()
        Get fixed (time invariant) value of the Solar Flux 81-day running center-average proxy Y10.7.
        Returns:
        fixed (time invariant) value of the Solar Flux 81-day running center-average proxy Y10.7

      • setFixedY10P7Mean

        public void setFixedY10P7Mean​(double fixedY10P7Mean)
        Set fixed (time invariant) value of the Solar Flux 81-day running center-average proxy Y10.7.
        Parameters:
        fixedY10P7Mean - fixed (time invariant) value of the Solar Flux 81-day running center-average proxy Y10.7