fr.cnes.sirius.patrius.forces.gravity

Class EarthGravitationalModelFactory

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.EarthGravitationalModelFactory

public final class EarthGravitationalModelFactory
extends Object

Factory class for earth gravitational model. This factory provides earth gravitational model by giving the potential file name, the degree and the order.

Since:

2.3

Version:

$Id: EarthGravitationalModelFactory.java 17680 2017-07-07 15:00:50Z bignon $

Author:

Charlotte Maggiorani

See Also:

BalminoAttractionModel, CunninghamAttractionModel, DrozinerAttractionModel, GravityFieldFactory

Use sample :

final ForceModel model = EarthGravitationalModelFactory.getGravitationalModel(potentialFileName, n, m);

Concurrency :

not thread-safe

Concurrency comment :

the presence of static methods makes this class not thread-safe

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EarthGravitationalModelFactory.GravityFieldNames Gravity field names enumerate.

Method Summary

Modifier and Type	Method and Description
static ForceModel	getBalmino(EarthGravitationalModelFactory.GravityFieldNames potentialFileName, String filename, int n, int m, boolean missingCoefficientsAllowed) Create an instance of a central body attraction with normalized coefficients, Helmholtz Polynomials (Balmino model) and specific data.
static ForceModel	getCunningham(EarthGravitationalModelFactory.GravityFieldNames potentialFileName, String filename, int n, int m, boolean missingCoefficientsAllowed) Create an instance of the gravitational field of a celestial body using Cunningham model and specific data.
static ForceModel	getDroziner(EarthGravitationalModelFactory.GravityFieldNames potentialFileName, String filename, int n, int m, boolean missingCoefficientsAllowed) Create an instance of the gravitational field of a celestial body using Droziner model and specific data.
static ForceModel	getGravitationalModel(EarthGravitationalModelFactory.GravityFieldNames potentialFileName, String filename, int n, int m) Create an default instance of a gravitational field of a celestial body using Balmino model and specific data.
static ForceModel	getGravitationalModel(EarthGravitationalModelFactory.GravityFieldNames potentialFileName, String filename, int n, int m, boolean missingCoefficientsAllowed) Create an default instance of a gravitational field of a celestial body using Balmino model and specific data.

Methods inherited from class java.lang.Object

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

Method Detail

getGravitationalModel

public static ForceModel getGravitationalModel(EarthGravitationalModelFactory.GravityFieldNames potentialFileName,
                                               String filename,
                                               int n,
                                               int m)
                                        throws IOException,
                                               ParseException,
                                               PatriusException

Create an default instance of a gravitational field of a celestial body using Balmino model and specific data. Missing coefficients are allowed.

Parameters:

potentialFileName - the gravity field name

filename - gravity data filename

n - the degree

m - the order

Returns:

an instance of the gravitational field of a celestial body

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs

Since:

3.4

See Also:

BalminoAttractionModel

getGravitationalModel

public static ForceModel getGravitationalModel(EarthGravitationalModelFactory.GravityFieldNames potentialFileName,
                                               String filename,
                                               int n,
                                               int m,
                                               boolean missingCoefficientsAllowed)
                                        throws IOException,
                                               ParseException,
                                               PatriusException

Create an default instance of a gravitational field of a celestial body using Balmino model and specific data.

Parameters:

potentialFileName - the gravity field name

filename - gravity data filename

n - the degree

m - the order

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Returns:

an instance of the gravitational field of a celestial body

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs

Since:

3.4

See Also:

BalminoAttractionModel

getBalmino

public static ForceModel getBalmino(EarthGravitationalModelFactory.GravityFieldNames potentialFileName,
                                    String filename,
                                    int n,
                                    int m,
                                    boolean missingCoefficientsAllowed)
                             throws IOException,
                                    ParseException,
                                    PatriusException

Create an instance of a central body attraction with normalized coefficients, Helmholtz Polynomials (Balmino model) and specific data.

Parameters:

potentialFileName - the gravity field name

filename - gravity data filename

n - the degree

m - the order

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Returns:

an instance of the gravitational field of a celestial body

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs

Since:

3.4

See Also:

BalminoAttractionModel

getCunningham

public static ForceModel getCunningham(EarthGravitationalModelFactory.GravityFieldNames potentialFileName,
                                       String filename,
                                       int n,
                                       int m,
                                       boolean missingCoefficientsAllowed)
                                throws IOException,
                                       ParseException,
                                       PatriusException

Create an instance of the gravitational field of a celestial body using Cunningham model and specific data.

Parameters:

potentialFileName - the gravity field name

filename - gravity data filename

n - the degree

m - the order

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Returns:

an instance of the gravitational field of a celestial body

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs

Since:

3.4

See Also:

CunninghamAttractionModel

getDroziner

public static ForceModel getDroziner(EarthGravitationalModelFactory.GravityFieldNames potentialFileName,
                                     String filename,
                                     int n,
                                     int m,
                                     boolean missingCoefficientsAllowed)
                              throws IOException,
                                     ParseException,
                                     PatriusException

Create an instance of the gravitational field of a celestial body using Droziner model and specific data.

Parameters:

potentialFileName - the gravity field name

filename - gravity data filename

n - the degree

m - the order

missingCoefficientsAllowed - if true, allows missing coefficients in the input data

Returns:

an instance of the gravitational field of a celestial body

Throws:

IOException - if data can't be read

ParseException - if data can't be parsed

PatriusException - if some data is missing or if some loader specific error occurs

Since:

3.4

See Also:

DrozinerAttractionModel