FixedPointOsculatingToAveragedConverter (OREKIT 12.1-SNAPSHOT API)

java.lang.Object
- org.orekit.propagation.conversion.averaging.converters.FixedPointOsculatingToAveragedConverter<T>

Type Parameters:

T - type of averaged orbital state

All Implemented Interfaces:

OsculatingToAveragedConverter<T>

Direct Known Subclasses:

OsculatingToBrouwerLyddaneConverter, OsculatingToDSST6X0Converter, OsculatingToEcksteinHechlerConverter, OsculatingToSGP4Converter
```
public abstract class FixedPointOsculatingToAveragedConverter<T extends AveragedOrbitalState>
extends Object
implements OsculatingToAveragedConverter<T>
```
Abstract class for osculating-to-averaged converters based on a fixed-point algorithm.

Since:

12.1

Author:

Romain Serra

See Also:

OsculatingToAveragedConverter

Field Summary

Fields
Modifier and Type Field Description

static double DEFAULT_EPSILON
Default convergence threshold.

static int DEFAULT_MAX_ITERATIONS
Default maximum number of iterations.

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`FixedPointOsculatingToAveragedConverter(double epsilon, int maxIterations)`	Protected constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`double`	`getEpsilon()`	Getter for the convergence threshold.
`int`	`getMaxIterations()`	Getter for the maximum number of iterations.
`void`	`setEpsilon(double epsilon)`	Setter for epsilon.
`void`	`setMaxIterations(int maxIterations)`	Setter for maximum number of iterations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.propagation.conversion.averaging.converters.OsculatingToAveragedConverter
convertToAveraged

- Field Detail
  - DEFAULT_EPSILON
```
public static final double DEFAULT_EPSILON
```
    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
- Constructor Detail
  - FixedPointOsculatingToAveragedConverter
```
protected FixedPointOsculatingToAveragedConverter(double epsilon,
                                                  int maxIterations)
```
    Protected constructor.
    
    Parameters:
    
    epsilon - tolerance for convergence
    
    maxIterations - maximum number of iterations
- Method Detail
  - getMaxIterations
```
public int getMaxIterations()
```
    Getter for the maximum number of iterations.
    
    Returns:
    
    maximum number of iterations
  - getEpsilon
```
public double getEpsilon()
```
    Getter for the convergence threshold.
    
    Returns:
    
    convergence threshold
  - setEpsilon
```
public void setEpsilon(double epsilon)
```
    Setter for epsilon.
    
    Parameters:
    
    epsilon - convergence threshold.
  - setMaxIterations
```
public void setMaxIterations(int maxIterations)
```
    Setter for maximum number of iterations.
    
    Parameters:
    
    maxIterations - maximum iterations