Package org.orekit.data

Class PoissonSeries

java.lang.Object

org.orekit.data.PoissonSeries

public class PoissonSeries
extends Object

Class representing a Poisson series for nutation or ephemeris computations.

A Poisson series is composed of a time polynomial part and a non-polynomial part which consist in summation series. The series terms are harmonic functions (combination of sines and cosines) of polynomial arguments. The polynomial arguments are combinations of luni-solar or planetary elements.

Author:

Luc Maisonobe

See Also:

PoissonSeriesParser, SeriesTerm, PolynomialNutation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PoissonSeries.CompiledSeries	This interface represents a fast evaluator for Poisson series.

Constructor Summary

Constructors

Constructor	Description
PoissonSeries(PolynomialNutation polynomial, Map<Long,org.orekit.data.SeriesTerm> series)	Build a Poisson series from an IERS table file.

Method Summary

Modifier and Type	Method	Description
static PoissonSeries.CompiledSeries	compile(PoissonSeries... poissonSeries)	Join several nutation series, for fast simultaneous evaluation.
int	getNonPolynomialSize()	Get the number of different terms in the non-polynomial part.
PolynomialNutation	getPolynomial()	Get the polynomial part of the series.
double	value(BodiesElements elements)	Evaluate the value of the series.
<T extends CalculusFieldElement<T>> T	value(FieldBodiesElements<T> elements)	Evaluate the value of the series.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoissonSeries

public PoissonSeries(PolynomialNutation polynomial,
                     Map<Long,org.orekit.data.SeriesTerm> series)

Build a Poisson series from an IERS table file.

Parameters:

polynomial - polynomial part (may be null)

series - non-polynomial part

Method Detail

getPolynomial

public PolynomialNutation getPolynomial()

Get the polynomial part of the series.

Returns:

polynomial part of the series.

getNonPolynomialSize

public int getNonPolynomialSize()

Get the number of different terms in the non-polynomial part.

Returns:

number of different terms in the non-polynomial part

value

public double value(BodiesElements elements)

Evaluate the value of the series.

Parameters:

elements - bodies elements for nutation

Returns:

value of the series

value

public <T extends CalculusFieldElement<T>> T value(FieldBodiesElements<T> elements)

Evaluate the value of the series.

Type Parameters:

T - type of the field elements

Parameters:

elements - bodies elements for nutation

Returns:

value of the series

compile

@SafeVarargs
public static PoissonSeries.CompiledSeries compile(PoissonSeries... poissonSeries)

Join several nutation series, for fast simultaneous evaluation.

Parameters:

poissonSeries - Poisson series to join

Returns:

a single function that evaluates all series together

Since:

6.1