fr.cnes.sirius.patrius.signalpropagation

Enum VacuumSignalPropagationModel.ConvergenceAlgorithm

java.lang.Object

java.lang.Enum<VacuumSignalPropagationModel.ConvergenceAlgorithm>

fr.cnes.sirius.patrius.signalpropagation.VacuumSignalPropagationModel.ConvergenceAlgorithm

All Implemented Interfaces:

Serializable, Comparable<VacuumSignalPropagationModel.ConvergenceAlgorithm>

Enclosing class:

VacuumSignalPropagationModel

public static enum VacuumSignalPropagationModel.ConvergenceAlgorithm
extends Enum<VacuumSignalPropagationModel.ConvergenceAlgorithm>

Convergence algorithm to compute the geometric signal propagation duration. The equation to solve is f(x)=x where x is the propagation time.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIXE_POINT Fixe point convergence algorithm.
NEWTON Newton convergence algorithm.

Method Summary

Modifier and Type	Method and Description
abstract double	computeTprop(double oldTprop, Vector3D velEmitterOrReceptor, Vector3D propagation) Recompute the signal propagation duration with the convergence algorithm.
static VacuumSignalPropagationModel.ConvergenceAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static VacuumSignalPropagationModel.ConvergenceAlgorithm[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FIXE_POINT

public static final VacuumSignalPropagationModel.ConvergenceAlgorithm FIXE_POINT

Fixe point convergence algorithm. The algorithm is x_n+1 = f(x_n).

NEWTON

public static final VacuumSignalPropagationModel.ConvergenceAlgorithm NEWTON

Newton convergence algorithm. The algorithm is x_n+1 = x_n - h(x_n)/h'(x_n) where h(x)=f(x)-x.

Method Detail

values

public static VacuumSignalPropagationModel.ConvergenceAlgorithm[] 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 (VacuumSignalPropagationModel.ConvergenceAlgorithm c : VacuumSignalPropagationModel.ConvergenceAlgorithm.values())
    System.out.println(c);

Returns:

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

valueOf

public static VacuumSignalPropagationModel.ConvergenceAlgorithm 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

computeTprop

public abstract double computeTprop(double oldTprop,
                                    Vector3D velEmitterOrReceptor,
                                    Vector3D propagation)

Recompute the signal propagation duration with the convergence algorithm.

Parameters:

oldTprop - the old signal propagation duration (n-1)

velEmitterOrReceptor - the emitter (resp. receptor) velocity at the emission (resp. reception) date according to the FixedDate value

propagation - the propagation vector in the reference frame

Returns:

the updated signal propagation duration