fr.cnes.sirius.patrius.forces.gravity.potential

Class GravityFieldFactory

java.lang.Object

fr.cnes.sirius.patrius.forces.gravity.potential.GravityFieldFactory

public final class GravityFieldFactory
extends Object

Factory used to read gravity field files in several supported formats.

Loading of gravity field data follows PATRIUS standard way of handling data:

Data are automatically loaded based on provided PotentialCoefficientsProvider.

User can provide its own implementation of these loaders and provide them using addPotentialCoefficientsReader(PotentialCoefficientsReader).

By default some loaders are added (see below). Loaders are used in the defined order below. These loaders will use data provided by DataProvidersManager.

List of loaders can be cleared and reordered using clearPotentialCoefficientsReaders().

By default, some loaders are added in the following order:

• ICGEMFormatReader: ICGEM file format. See the ICGEM-format for more information
• SHMFormatReader: SHM file format. See Potsdam university website for more information
• EGMFormatReader: EGM file format.
• GRGSFormatReader: GRGS file format.

There is no included data in PATRIUS by default.
Once loaded, data are stored in static variables and are used for gravity force computation accessible through getPotentialProvider() method.

Author:

Fabien Maussion, Pascal Parraud, Luc Maisonobe

Field Summary

Fields

Modifier and Type	Field and Description
static String	EGM_FILENAME Default regular expression for EGM files.
static String	GRGS_FILENAME Default regular expression for GRGS files.
static String	ICGEM_FILENAME Default regular expression for ICGEM files.
static String	SHM_FILENAME Default regular expression for SHM files.

Method Summary

Modifier and Type	Method and Description
static void	addDefaultPotentialCoefficientsReaders() Add the default READERS for gravity fields.
static void	addPotentialCoefficientsReader(PotentialCoefficientsReader reader) Add a reader for gravity fields.
static void	clearPotentialCoefficientsReaders() Clear gravity field READERS.
static PotentialCoefficientsProvider	getPotentialProvider() Get the gravity field coefficients provider from the first supported file.

Methods inherited from class java.lang.Object

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

Field Detail

ICGEM_FILENAME

public static final String ICGEM_FILENAME

Default regular expression for ICGEM files.

See Also:

Constant Field Values

SHM_FILENAME

public static final String SHM_FILENAME

Default regular expression for SHM files.

See Also:

Constant Field Values

EGM_FILENAME

public static final String EGM_FILENAME

Default regular expression for EGM files.

See Also:

Constant Field Values

GRGS_FILENAME

public static final String GRGS_FILENAME

Default regular expression for GRGS files.

See Also:

Constant Field Values

Method Detail

addPotentialCoefficientsReader

public static void addPotentialCoefficientsReader(PotentialCoefficientsReader reader)

Add a reader for gravity fields.

Parameters:

reader - custom reader to add for the gravity field

See Also:

addDefaultPotentialCoefficientsReaders(), clearPotentialCoefficientsReaders()

addDefaultPotentialCoefficientsReaders

public static void addDefaultPotentialCoefficientsReaders()

Add the default READERS for gravity fields.

The default READERS supports ICGEM, SHM, EGM and GRGS formats with the default names ICGEM_FILENAME, SHM_FILENAME, EGM_FILENAME, GRGS_FILENAME and don't allow missing coefficients.

See Also:

addPotentialCoefficientsReader(PotentialCoefficientsReader), clearPotentialCoefficientsReaders()

clearPotentialCoefficientsReaders

public static void clearPotentialCoefficientsReaders()

Clear gravity field READERS.

See Also:

addPotentialCoefficientsReader(PotentialCoefficientsReader), addDefaultPotentialCoefficientsReaders()

getPotentialProvider

public static PotentialCoefficientsProvider getPotentialProvider()
                                                          throws IOException,
                                                                 ParseException,
                                                                 PatriusException

Get the gravity field coefficients provider from the first supported file.

If no PotentialCoefficientsReader has been added by calling addPotentialCoefficientsReader or if clearPotentialCoefficientsReaders has been called afterwards,the addDefaultPotentialCoefficientsReaders method will be called automatically.

Returns:

a gravity field coefficients provider containing already loaded data

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