SphericalHarmonicGravityModel Class |
Contains the coefficient data for a gravity model, either specified upon construction or
read in from a file. This type is passed to a SphericalHarmonicGravityField
which down selects to the desired subset of this full model, and sets other configuration options.
The field is then used by SphericalHarmonicGravity in order to calculate the
gravitational force.
Inheritance HierarchyNamespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.2.419.0 (24.2.419.0)
SyntaxThe SphericalHarmonicGravityModel type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | SphericalHarmonicGravityModel | Initializes a new instance. |
| SphericalHarmonicGravityModel(String, String, Double, Double, Double, Double, Double, Boolean, Boolean) |
Initializes a new instance.
|
| SphericalHarmonicGravityModel(String, String, Double, Double, Double, Double, Double, Boolean, Boolean, SphericalHarmonicGravitySecularVariations) |
Initializes a new instance.
|
Properties| Name | Description | |
|---|---|---|
 | CentralBodyName |
Gets or sets the name of the central body described by the model.
|
| CosineCoefficients |
Gets the list of this model's Cosine coefficients (m= [1, L])
|
| FileDegree |
Gets or sets the maximum degree of the gravitation coefficients defined by the .grv file.
|
| FileOrder |
Gets or sets the maximum order of the gravitation coefficients defined by the .grv file.
|
| GravitationalParameter |
Gets or sets the gravitational parameter of the central body.
|
| IncludesPermanentTides |
Gets or sets a value indicating whether the coefficients of the gravity model include permanent tides.
|
| ModelName |
Gets or sets the name of the gravity model being used.
|
| Normalized |
Gets or sets a value indicating whether the coefficients of the gravity model are normalized.
|
| ReferenceDistance |
Gets or sets the reference distance of the central body.
|
| SecularVariations |
Gets or sets the linear model for the secular variations of this gravity model.
|
| SineCoefficients |
Gets the list of this model's Sine coefficients (m= [1, L])
|
| ZonalCoefficients |
Gets the list of this model's zonal coefficients (cosine coefficients for m=0).
|
Methods| Name | Description | |
|---|---|---|
 | CreateEarthPermanentTideCoefficients |
Creates a set of the default IERS 2003 permanent tide coefficients for Earth.
These are identical to those created by the default constructor of PermanentSolidTideModel.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadFrom(String) |
Reads the gravity model information in from a file (most likely a .grv) and
returns a SphericalHarmonicGravityModel.
|
| ReadFrom(TextReader) |
Reads the gravity model information in from a TextReader and
returns a SphericalHarmonicGravityModel |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| WithoutEarthPermanentTides |
Removes the IERS2003 Earth permanent tide contributions so that a time-varying tide model can be applied instead.
|
| WithoutPermanentTides |
Removes the permanent tide contributions so that a time-varying tide model can be applied instead.
|
See Also