fr.cnes.genopus.math

Enum GPIntegrator.IntegratorTypeEnum

java.lang.Object

java.lang.Enum<GPIntegrator.IntegratorTypeEnum>

fr.cnes.genopus.math.GPIntegrator.IntegratorTypeEnum

All Implemented Interfaces:

Serializable, Comparable<GPIntegrator.IntegratorTypeEnum>

Enclosing class:

GPIntegrator

public static enum GPIntegrator.IntegratorTypeEnum
extends Enum<GPIntegrator.IntegratorTypeEnum>

Enumeration for first order integrators types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOP DOP integrator.
RK4 RK4 integrator.
RK6 RK6 integrator.

Method Summary

Modifier and Type	Method and Description
abstract fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator	getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit, double timestepRK, double minimumTimeStep, double maximumTimeStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance, boolean acceptSmall) Get the first order integrator.
int	getId() Method to get the rank in the enumeration of the type.
String	toString() Method allowing to get the type as a string.
static GPIntegrator.IntegratorTypeEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static GPIntegrator.IntegratorTypeEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOP

public static final GPIntegrator.IntegratorTypeEnum DOP

DOP integrator.

RK4

public static final GPIntegrator.IntegratorTypeEnum RK4

RK4 integrator.

RK6

public static final GPIntegrator.IntegratorTypeEnum RK6

RK6 integrator.

Method Detail

values

public static GPIntegrator.IntegratorTypeEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (GPIntegrator.IntegratorTypeEnum c : GPIntegrator.IntegratorTypeEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static GPIntegrator.IntegratorTypeEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Method allowing to get the type as a string.

Overrides:

toString in class Enum<GPIntegrator.IntegratorTypeEnum>

Returns:

type as a string

getId

public int getId()

Method to get the rank in the enumeration of the type.

Returns:

rank in the enumeration of the type

getFirstOrderIntegrator

public abstract fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit,
                                                                                             double timestepRK,
                                                                                             double minimumTimeStep,
                                                                                             double maximumTimeStep,
                                                                                             double[] vecAbsoluteTolerance,
                                                                                             double[] vecRelativeTolerance,
                                                                                             boolean acceptSmall)
                                                                                      throws fr.cnes.genius.exception.GException

Get the first order integrator.

Parameters:

initialOrbit - initial orbit for simplified tolerances computation. It might be null if complete tolerances were already given. (Only for DOP Integrator)

timestepRK - time step (Only for Runge-Kutta integrator)

minimumTimeStep - minimum time step (Only for DOP Integrator)

maximumTimeStep - maximum time step (Only for DOP Integrator)

vecAbsoluteTolerance - absolute tolerance values. It might be null if the simplified tolerances are to be computed (Only for DOP Integrator)

vecRelativeTolerance - absolute tolerance values. It might be null if the simplified tolerances are to be computed (Only for DOP Integrator)

acceptSmall - If true, steps smaller than the minimal value are silently increased up to this value, if false such small steps generate an exception

Returns:

the first order integrator

Throws:

fr.cnes.genius.exception.GException - if simplified tolerances are required and no orbit is given