public class SphericalHarmonicGravityField extends Object
Constructor and Description 

SphericalHarmonicGravityField(SphericalHarmonicGravityModel gravityModel,
CentralBody centralBody,
int degree,
int order,
boolean includeTwoBody,
SphericalHarmonicsTideType tideType)
Initializes a new instance from a
SphericalHarmonicGravityModel ,
a CentralBody (get ), the degree and order
of the subset of the model that this field represents, and a boolean
representing whether or not to include two body forces. 
SphericalHarmonicGravityField(SphericalHarmonicGravityModel gravityModel,
CentralBody centralBody,
int degree,
int order,
int partialsDegree,
int partialsOrder,
boolean includeTwoBody,
SphericalHarmonicsTideType tideType)
Initializes a new instance from a
SphericalHarmonicGravityModel ,
a CentralBody (get ), the degree and order
of the subset of the model that this field represents, the
degree and order to use when calculating partial derivatives, and a boolean
representing whether or not to include two body forces. 
SphericalHarmonicGravityField(SphericalHarmonicGravityModel gravityModel,
int degree,
int order,
boolean includeTwoBody,
SphericalHarmonicsTideType tideType)
Initializes a new instance from a
SphericalHarmonicGravityModel , the degree and order
of the subset of the model that this field represents, and a boolean
representing whether or not to include two body forces. 
SphericalHarmonicGravityField(SphericalHarmonicGravityModel gravityModel,
int degree,
int order,
int partialsDegree,
int partialsOrder,
boolean includeTwoBody,
SphericalHarmonicsTideType tideType)
Initializes a new instance from a
SphericalHarmonicGravityModel , the degree and order
of the subset of the model that this field represents, the
degree and order to use when calculating partial derivatives, and a boolean
representing whether or not to include two body forces. 
Modifier and Type  Method and Description 

CentralBody 
getCentralBody()
Gets the
CentralBody (get ) of this gravity field. 
int 
getDegree()
Gets the degree of the subset of the model this gravitational field uses.

double 
getGravitationalParameter()
Gets the gravitational parameter of the central body described by this gravity field.

boolean 
getIncludeTwoBodyGravity()
Gets a value indicating whether to include the effects of (twobody) gravity of zero degree and order
or to instead simply return the higher order perturbations.

int 
getOrder()
Gets the order of the subset of the model this gravitational field uses.

int 
getPartialsDegree()
Gets the degree of the subset of the model this gravitational field uses
to calculate partial derivatives.

int 
getPartialsOrder()
Gets the order of the subset of the model this gravitational field uses
to calculate partial derivatives.

double 
getReferenceRadius()
Gets the reference radius of the central body described by this gravity field.

SphericalHarmonicsTideType 
getTideType()
Gets the
SphericalHarmonicsTideType to use when calculating gravitational force. 
void 
setTideType(SphericalHarmonicsTideType value)
Sets the
SphericalHarmonicsTideType to use when calculating gravitational force. 
public SphericalHarmonicGravityField(@Nonnull SphericalHarmonicGravityModel gravityModel, int degree, int order, boolean includeTwoBody, @Nonnull SphericalHarmonicsTideType tideType)
SphericalHarmonicGravityModel
, the degree and order
of the subset of the model that this field represents, and a boolean
representing whether or not to include two body forces.gravityModel
 The full gravity model to configure.degree
 The desired degree. The configured gravity field will have
this degree if FileDegree
(get
/ set
) allows it.order
 The desired order. The configured gravity field will have
this degree if FileDegree
(get
/ set
),
FileOrder
(get
/ set
) and degree allow it.includeTwoBody
 The flag representing whether a force model
using this field should include two body gravity, or just the higher order perturbations.tideType
 The type of tidal effects this field should include.IllegalStateException
 Thrown if the CentralBodyName
(get
/ set
) in model does not refer to
the Earth, Sun, or Moon. In that case use
SphericalHarmonicGravityField.SphericalHarmonicGravityField(SphericalHarmonicGravityModel,agi.foundation.celestial.CentralBody,int,int,boolean,SphericalHarmonicsTideType)
public SphericalHarmonicGravityField(@Nonnull SphericalHarmonicGravityModel gravityModel, CentralBody centralBody, int degree, int order, boolean includeTwoBody, @Nonnull SphericalHarmonicsTideType tideType)
SphericalHarmonicGravityModel
,
a CentralBody
(get
), the degree and order
of the subset of the model that this field represents, and a boolean
representing whether or not to include two body forces.gravityModel
 The full gravity model to configure.centralBody
 The central body to use for this gravity field instead
of referencing CentralBodyName
(get
/ set
)degree
 The desired degree. The configured gravity field will have
this degree if FileDegree
(get
/ set
) allows it.order
 The desired order. The configured gravity field will have
this degree if FileDegree
(get
/ set
),
FileOrder
(get
/ set
) and degree allow it.includeTwoBody
 The flag representing whether a force model
using this field should include two body gravity, or just the higher order perturbations.tideType
 The type of tidal effects this field should include.public SphericalHarmonicGravityField(@Nonnull SphericalHarmonicGravityModel gravityModel, int degree, int order, int partialsDegree, int partialsOrder, boolean includeTwoBody, @Nonnull SphericalHarmonicsTideType tideType)
SphericalHarmonicGravityModel
, the degree and order
of the subset of the model that this field represents, the
degree and order to use when calculating partial derivatives, and a boolean
representing whether or not to include two body forces.gravityModel
 The full gravity model to configure.degree
 The desired degree. The configured gravity field will have
this degree if FileDegree
(get
/ set
) allows it.order
 The desired order. The configured gravity field will have
this degree if FileDegree
(get
/ set
),
FileOrder
(get
/ set
) and degree allow it.partialsDegree
 The degree to use for calculating partial derivatives.partialsOrder
 The order to use for calculating partial derivatives.includeTwoBody
 The flag representing whether a force model
using this field should include two body gravity, or just the higher order perturbations.tideType
 The type of tidal effects this field should include.IllegalStateException
 Thrown if the CentralBodyName
(get
/ set
) in model does not refer to
the Earth, Sun, or Moon. In that case use
SphericalHarmonicGravityField.SphericalHarmonicGravityField(SphericalHarmonicGravityModel,agi.foundation.celestial.CentralBody,int,int,int,int,boolean,SphericalHarmonicsTideType)
public SphericalHarmonicGravityField(@Nonnull SphericalHarmonicGravityModel gravityModel, CentralBody centralBody, int degree, int order, int partialsDegree, int partialsOrder, boolean includeTwoBody, @Nonnull SphericalHarmonicsTideType tideType)
SphericalHarmonicGravityModel
,
a CentralBody
(get
), the degree and order
of the subset of the model that this field represents, the
degree and order to use when calculating partial derivatives, and a boolean
representing whether or not to include two body forces.gravityModel
 The full gravity model to configure.centralBody
 The central body to use for this gravity field instead
of referencing CentralBodyName
(get
/ set
)degree
 The desired degree. The configured gravity field will have
this degree if FileDegree
(get
/ set
) allows it.order
 The desired order. The configured gravity field will have
this degree if FileDegree
(get
/ set
),
FileOrder
(get
/ set
) and degree allow it.partialsDegree
 The degree to use for calculating partial derivatives.partialsOrder
 The order to use for calculating partial derivatives.includeTwoBody
 The flag representing whether a force model
using this field should include two body gravity, or just the higher order perturbations.tideType
 The type of tidal effects this field should include.public final double getGravitationalParameter()
public final double getReferenceRadius()
public final CentralBody getCentralBody()
CentralBody
(get
) of this gravity field.@Nonnull public final SphericalHarmonicsTideType getTideType()
SphericalHarmonicsTideType
to use when calculating gravitational force.
If this force model is set to use permanent tides and the gravity field does
not include permanent tides, then they are modeled as defined in the IERS 2003 Convention
and updated in 2006.public final void setTideType(@Nonnull SphericalHarmonicsTideType value)
SphericalHarmonicsTideType
to use when calculating gravitational force.
If this force model is set to use permanent tides and the gravity field does
not include permanent tides, then they are modeled as defined in the IERS 2003 Convention
and updated in 2006.public final boolean getIncludeTwoBodyGravity()
public final int getDegree()
public final int getOrder()
public final int getPartialsDegree()
public final int getPartialsOrder()