org.orekit.propagation.conversion

Class NumericalPropagatorBuilder

java.lang.Object

org.orekit.propagation.conversion.AbstractPropagatorBuilder

org.orekit.propagation.conversion.NumericalPropagatorBuilder

All Implemented Interfaces:

PropagatorBuilder

public class NumericalPropagatorBuilder
extends AbstractPropagatorBuilder

Builder for numerical propagator.

Since:

6.0

Author:

Pascal Parraud

Constructor Summary

Constructors

Constructor and Description
NumericalPropagatorBuilder(double mu, Frame frame, FirstOrderIntegratorBuilder builder) Deprecated. as of 7.1, replaced with NumericalPropagatorBuilder(double, Frame, FirstOrderIntegratorBuilder, OrbitType, PositionAngle)
NumericalPropagatorBuilder(double mu, Frame frame, FirstOrderIntegratorBuilder builder, OrbitType orbitType, PositionAngle positionAngle) Build a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addForceModel(ForceModel model) Add a force model to the global perturbation model.
NumericalPropagator	buildPropagator(AbsoluteDate date, double[] parameters) Build a propagator.
double	getParameter(String name) Get parameter value from its name.
void	setAttitudeProvider(AttitudeProvider attitudeProvider) Set the attitude provider.
void	setMass(double mass) Set the initial mass.
void	setParameter(String name, double value) Set parameter value from its name.

Methods inherited from class org.orekit.propagation.conversion.AbstractPropagatorBuilder

addSupportedParameter, checkParameters, createInitialOrbit, getFrame, getFreeParameters, getOrbitType, getPositionAngle, getSupportedParameters, setFreeParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericalPropagatorBuilder

@Deprecated
public NumericalPropagatorBuilder(double mu,
                                     Frame frame,
                                     FirstOrderIntegratorBuilder builder)

Deprecated. as of 7.1, replaced with NumericalPropagatorBuilder(double, Frame, FirstOrderIntegratorBuilder, OrbitType, PositionAngle)

Build a new instance.

Parameters:

mu - central attraction coefficient (m³/s²)

frame - the frame in which the orbit is propagated (must be a pseudo-inertial frame)

builder - first order integrator builder

NumericalPropagatorBuilder

public NumericalPropagatorBuilder(double mu,
                          Frame frame,
                          FirstOrderIntegratorBuilder builder,
                          OrbitType orbitType,
                          PositionAngle positionAngle)

Build a new instance.

Parameters:

mu - central attraction coefficient (m³/s²)

frame - the frame in which the orbit is propagated (must be a pseudo-inertial frame)

builder - first order integrator builder

orbitType - orbit type to use

positionAngle - position angle type to use

Since:

7.1

Method Detail

setAttitudeProvider

public void setAttitudeProvider(AttitudeProvider attitudeProvider)

Set the attitude provider.

Parameters:

attitudeProvider - attitude provider

setMass

public void setMass(double mass)

Set the initial mass.

Parameters:

mass - the mass (kg)

addForceModel

public void addForceModel(ForceModel model)

Add a force model to the global perturbation model.

If this method is not called at all, the integrated orbit will follow a keplerian evolution only.

Parameters:

model - perturbing ForceModel to add

buildPropagator

public NumericalPropagator buildPropagator(AbsoluteDate date,
                                  double[] parameters)
                                    throws OrekitException

Build a propagator.

Parameters:

date - date associated to the parameters to configure the initial state

parameters - set of position/velocity(/free) parameters to configure the propagator

Returns:

an initialized propagator

Throws:

OrekitException - if propagator cannot be build

getParameter

public double getParameter(String name)
                    throws OrekitIllegalArgumentException

Get parameter value from its name.

The abstract base class only supports NewtonianAttraction.CENTRAL_ATTRACTION_COEFFICIENT, specialized propagator builders may support more parameters.

Specified by:

getParameter in interface PropagatorBuilder

Overrides:

getParameter in class AbstractPropagatorBuilder

Parameters:

name - parameter name

Returns:

parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported

setParameter

public void setParameter(String name,
                double value)
                  throws OrekitIllegalArgumentException

Set parameter value from its name.

The abstract base class only supports NewtonianAttraction.CENTRAL_ATTRACTION_COEFFICIENT, specialized propagator builders may support more parameters.

Specified by:

setParameter in interface PropagatorBuilder

Overrides:

setParameter in class AbstractPropagatorBuilder

Parameters:

name - parameter name

value - parameter value

Throws:

OrekitIllegalArgumentException - if parameter is not supported