Package 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	Description
NumericalPropagatorBuilder(Orbit referenceOrbit, ODEIntegratorBuilder builder, PositionAngle positionAngle, double positionScale)	Build a new instance.

Method Summary

Modifier and Type	Method	Description
void	addForceModel(ForceModel model)	Add a force model to the global perturbation model.
NumericalPropagator	buildPropagator(double[] normalizedParameters)	Build a propagator.
NumericalPropagatorBuilder	copy()	Create a copy of a NumericalPropagatorBuilder object.
List<ForceModel>	getAllForceModels()	Get the list of all force models.
AttitudeProvider	getAttitudeProvider()	Get the attitudeProvider.
ODEIntegratorBuilder	getIntegratorBuilder()	Get the integrator builder.
double	getMass()	Get the mass.
void	setAttitudeProvider(AttitudeProvider attitudeProvider)	Set the attitude provider.
void	setMass(double mass)	Set the initial mass.

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

addSupportedParameter, createInitialOrbit, getFrame, getInitialOrbitDate, getMu, getOrbitalParametersDrivers, getOrbitType, getPositionAngle, getPositionScale, getPropagationParametersDrivers, getSelectedNormalizedParameters, resetOrbit, setParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

NumericalPropagatorBuilder

public NumericalPropagatorBuilder(Orbit referenceOrbit,
                                  ODEIntegratorBuilder builder,
                                  PositionAngle positionAngle,
                                  double positionScale)
                           throws OrekitException

Build a new instance.

The reference orbit is used as a model to create initial orbit. It defines the inertial frame, the central attraction coefficient, and is also used together with the positionScale to convert from the normalized parameters used by the callers of this builder to the real orbital parameters.

Parameters:

referenceOrbit - reference orbit from which real orbits will be built

builder - first order integrator builder

positionAngle - position angle type to use

positionScale - scaling factor used for orbital parameters normalization (typically set to the expected standard deviation of the position)

Throws:

OrekitException - if parameters drivers cannot be scaled

Since:

8.0

Method Detail

copy

public NumericalPropagatorBuilder copy()
                                throws OrekitException

Create a copy of a NumericalPropagatorBuilder object.

Returns:

Copied version of the NumericalPropagatorBuilder

Throws:

OrekitException - if parameters drivers cannot be scaled

getIntegratorBuilder

public ODEIntegratorBuilder getIntegratorBuilder()

Get the integrator builder.

Returns:

the integrator builder

Since:

9.2

getAllForceModels

public List<ForceModel> getAllForceModels()

Get the list of all force models.

Returns:

the list of all force models

Since:

9.2

addForceModel

public void addForceModel(ForceModel model)
                   throws OrekitException

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

Throws:

OrekitException - if model parameters cannot be set

getMass

public double getMass()

Get the mass.

Returns:

the mass

Since:

9.2

setMass

public void setMass(double mass)

Set the initial mass.

Parameters:

mass - the mass (kg)

getAttitudeProvider

public AttitudeProvider getAttitudeProvider()

Get the attitudeProvider.

Returns:

the attitude provider

Since:

9.2

setAttitudeProvider

public void setAttitudeProvider(AttitudeProvider attitudeProvider)

Set the attitude provider.

Parameters:

attitudeProvider - attitude provider

buildPropagator

public NumericalPropagator buildPropagator(double[] normalizedParameters)
                                    throws OrekitException

Build a propagator.

Parameters:

normalizedParameters - normalized values for the selected parameters

Returns:

an initialized propagator

Throws:

OrekitException - if propagator cannot be build