Class FixedPointConverter
- java.lang.Object
-
- org.orekit.propagation.conversion.osc2mean.FixedPointConverter
-
- All Implemented Interfaces:
OsculatingToMeanConverter
public class FixedPointConverter extends Object implements OsculatingToMeanConverter
Class enabling conversion from osculating to mean orbit for a given theory using a fixed-point algorithm.- Since:
- 13.0
- Author:
- Pascal Parraud
-
-
Field Summary
Fields Modifier and Type Field Description static double
DEFAULT_DAMPING
Default damping ratio.static int
DEFAULT_MAX_ITERATIONS
Default maximum number of iterations.static double
DEFAULT_THRESHOLD
Default convergence threshold.
-
Constructor Summary
Constructors Constructor Description FixedPointConverter()
Default constructor.FixedPointConverter(double threshold, int maxIterations, double damping)
Constructor.FixedPointConverter(MeanTheory theory)
Constructor.FixedPointConverter(MeanTheory theory, double threshold, int maxIterations, double damping)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description <T extends CalculusFieldElement<T>>
FieldOrbit<T>convertToMean(FieldOrbit<T> osculating)
Converts an osculating orbit into a mean orbit.Orbit
convertToMean(Orbit osculating)
Converts an osculating orbit into a mean orbit.double
getDamping()
Gets damping ratio.int
getIterationsNb()
Gets the number of iterations performed by the last conversion.int
getMaxIterations()
Gets maximum number of iterations.MeanTheory
getMeanTheory()
Gets the theory defining the mean orbit.double
getThreshold()
Gets convergence threshold.void
setDamping(double damping)
Sets damping ratio.void
setMaxIterations(int maxIterations)
Sets maximum number of iterations.void
setMeanTheory(MeanTheory meanTheory)
Sets the theory defining the mean orbit.void
setThreshold(double threshold)
Sets convergence threshold.
-
-
-
Field Detail
-
DEFAULT_THRESHOLD
public static final double DEFAULT_THRESHOLD
Default convergence threshold.- See Also:
- Constant Field Values
-
DEFAULT_MAX_ITERATIONS
public static final int DEFAULT_MAX_ITERATIONS
Default maximum number of iterations.- See Also:
- Constant Field Values
-
DEFAULT_DAMPING
public static final double DEFAULT_DAMPING
Default damping ratio.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FixedPointConverter
public FixedPointConverter()
Default constructor.The mean theory must be set before converting.
-
FixedPointConverter
public FixedPointConverter(MeanTheory theory)
Constructor.- Parameters:
theory
- mean theory to be used
-
FixedPointConverter
public FixedPointConverter(double threshold, int maxIterations, double damping)
Constructor.The mean theory must be set before converting.
- Parameters:
threshold
- tolerance for convergencemaxIterations
- maximum number of iterationsdamping
- damping ratio
-
FixedPointConverter
public FixedPointConverter(MeanTheory theory, double threshold, int maxIterations, double damping)
Constructor.- Parameters:
theory
- mean theory to be usedthreshold
- tolerance for convergencemaxIterations
- maximum number of iterationsdamping
- damping ratio
-
-
Method Detail
-
getMeanTheory
public MeanTheory getMeanTheory()
Gets the theory defining the mean orbit.- Specified by:
getMeanTheory
in interfaceOsculatingToMeanConverter
- Returns:
- the mean theory
-
setMeanTheory
public void setMeanTheory(MeanTheory meanTheory)
Sets the theory defining the mean orbit.- Specified by:
setMeanTheory
in interfaceOsculatingToMeanConverter
- Parameters:
meanTheory
- the mean theory
-
getThreshold
public double getThreshold()
Gets convergence threshold.- Returns:
- convergence threshold
-
setThreshold
public void setThreshold(double threshold)
Sets convergence threshold.- Parameters:
threshold
- convergence threshold
-
getMaxIterations
public int getMaxIterations()
Gets maximum number of iterations.- Returns:
- maximum number of iterations
-
setMaxIterations
public void setMaxIterations(int maxIterations)
Sets maximum number of iterations.- Parameters:
maxIterations
- maximum number of iterations
-
getDamping
public double getDamping()
Gets damping ratio.- Returns:
- damping ratio
-
setDamping
public void setDamping(double damping)
Sets damping ratio.- Parameters:
damping
- damping ratio
-
getIterationsNb
public int getIterationsNb()
Gets the number of iterations performed by the last conversion.- Returns:
- number of iterations
-
convertToMean
public Orbit convertToMean(Orbit osculating)
Converts an osculating orbit into a mean orbit. Uses a fixed-point algorithm.- Specified by:
convertToMean
in interfaceOsculatingToMeanConverter
- Parameters:
osculating
- osculating orbit- Returns:
- mean orbit
-
convertToMean
public <T extends CalculusFieldElement<T>> FieldOrbit<T> convertToMean(FieldOrbit<T> osculating)
Converts an osculating orbit into a mean orbit. Uses a fixed-point algorithm.- Specified by:
convertToMean
in interfaceOsculatingToMeanConverter
- Type Parameters:
T
- type of the filed elements- Parameters:
osculating
- osculating orbit- Returns:
- mean orbit
-
-