fr.cnes.dynvol.psimu.calc.integrator.firstOrderIntegrators

Class DopData

java.lang.Object

fr.cnes.dynvol.psimu.calc.integrator.AbstractNumericalIntegratorData

fr.cnes.dynvol.psimu.calc.integrator.firstOrderIntegrators.DopData

public class DopData
extends AbstractNumericalIntegratorData

This class contains the eighth order Dormand-Prince integrator data.

Author:

sumelzi

Field Summary

Fields

Modifier and Type	Field and Description
static double	DEFAULT_ABS_MASS_TOL Default absolute mass tolerance for simplified tolerances (1E-3 kg).
static double	DEFAULT_REL_MASS_TOLERANCE Default relative mass tolerance for simplified tolerances (1E-5).
static int	THREE_DIM 3D vector length.
static int	TOL_LENGTH Tolerances length.

Constructor Summary

Constructors

Constructor and Description
DopData(PsimuPropagationData propData, double minimumTimeStep, double maximumTimeStep, double positionErrorIn) Creates a new instance.
DopData(PsimuPropagationData propData, double minimumTimeStep, double maximumTimeStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance, double absMassTolerance, double relMassTolerance) Creates a new instance.
DopData(PsimuPropagationData propData, double minimumTimeStep, double maximumTimeStep, double[] vecAbsoluteTolerance, double[] vecRelativeTolerance, double absMassTolerance, double relMassTolerance, boolean byPassErrorOnMinTimeStep) Creates a new instance.
DopData(PsimuPropagationData propData, double minimumTimeStep, double maximumTimeStep, double positionErrorIn, boolean byPassErrorOnMinTimeStep) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
double	getAbsMassTolerance() Get the absolute mass tolerance.
fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator	getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit) Get the first order integrator.
double	getRelMassTolerance() Get the relative mass tolerance.

Methods inherited from class fr.cnes.dynvol.psimu.calc.integrator.AbstractNumericalIntegratorData

getPropData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TOL_LENGTH

public static final int TOL_LENGTH

Tolerances length.

See Also:

Constant Field Values

THREE_DIM

public static final int THREE_DIM

3D vector length.

See Also:

Constant Field Values

DEFAULT_ABS_MASS_TOL

public static final double DEFAULT_ABS_MASS_TOL

Default absolute mass tolerance for simplified tolerances (1E-3 kg).

See Also:

Constant Field Values

DEFAULT_REL_MASS_TOLERANCE

public static final double DEFAULT_REL_MASS_TOLERANCE

Default relative mass tolerance for simplified tolerances (1E-5).

See Also:

Constant Field Values

Constructor Detail

DopData

public DopData(PsimuPropagationData propData,
               double minimumTimeStep,
               double maximumTimeStep,
               double[] vecAbsoluteTolerance,
               double[] vecRelativeTolerance,
               double absMassTolerance,
               double relMassTolerance)
        throws PsimuException

Creates a new instance. Tolerances are complete An error is thrown if a timestep lower than min time step is required.

Parameters:

propData - propagation data.

minimumTimeStep - minimum timestep (s)

maximumTimeStep - maximum timestep (s)

vecAbsoluteTolerance - absolute tolerances (position -> m, velocity -> m/s)

vecRelativeTolerance - relative tolerances

absMassTolerance - absolute mass tolerance (kg)

relMassTolerance - relative mass tolerance

Throws:

PsimuException - if complete tolerances were required but not given

DopData

public DopData(PsimuPropagationData propData,
               double minimumTimeStep,
               double maximumTimeStep,
               double positionErrorIn)
        throws PsimuException

Creates a new instance. Tolerances are not complete. An error is thrown if a timestep lower than min time step is required.

Parameters:

propData - propagation data.

minimumTimeStep - minimum timestep (s)

maximumTimeStep - maximum timestep (s)

positionErrorIn - local position error

Throws:

PsimuException - if complete tolerances were required but not given

DopData

public DopData(PsimuPropagationData propData,
               double minimumTimeStep,
               double maximumTimeStep,
               double[] vecAbsoluteTolerance,
               double[] vecRelativeTolerance,
               double absMassTolerance,
               double relMassTolerance,
               boolean byPassErrorOnMinTimeStep)
        throws PsimuException

Creates a new instance. Tolerances are complete

Parameters:

propData - propagation data.

minimumTimeStep - minimum timestep (s)

maximumTimeStep - maximum timestep (s)

vecAbsoluteTolerance - absolute tolerances (position -> m, velocity -> m/s)

vecRelativeTolerance - relative tolerances

absMassTolerance - absolute mass tolerance (kg)

relMassTolerance - relative mass tolerance

byPassErrorOnMinTimeStep - true if not error should be thrown if a time step lower than provided is required

Throws:

PsimuException - if complete tolerances were required but not given

DopData

public DopData(PsimuPropagationData propData,
               double minimumTimeStep,
               double maximumTimeStep,
               double positionErrorIn,
               boolean byPassErrorOnMinTimeStep)
        throws PsimuException

Creates a new instance. Tolerances are not complete.

Parameters:

propData - propagation data.

minimumTimeStep - minimum timestep (s)

maximumTimeStep - maximum timestep (s)

positionErrorIn - local position error

byPassErrorOnMinTimeStep - true if not error should be thrown if a time step lower than provided is required

Throws:

PsimuException - if complete tolerances were required but not given

Method Detail

getFirstOrderIntegrator

public fr.cnes.sirius.patrius.math.ode.FirstOrderIntegrator getFirstOrderIntegrator(fr.cnes.sirius.patrius.orbits.Orbit initialOrbit)
                                                                             throws PsimuException

Get the first order integrator.

Specified by:

getFirstOrderIntegrator in class AbstractNumericalIntegratorData

Parameters:

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

Returns:

the first order integrator

Throws:

PsimuException - if simplified tolerances are required and no orbit is given

getAbsMassTolerance

public double getAbsMassTolerance()

Get the absolute mass tolerance.

Specified by:

getAbsMassTolerance in class AbstractNumericalIntegratorData

Returns:

the absolute mass tolerance

getRelMassTolerance

public double getRelMassTolerance()

Get the relative mass tolerance.

Specified by:

getRelMassTolerance in class AbstractNumericalIntegratorData

Returns:

the relative mass tolerance