Click or drag to resize

SphericalHarmonicGravityField Class

The immutable class that describes the chosen subset and configuration of spherical harmonic gravitational model.
Inheritance Hierarchy
SystemObject
  AGI.Foundation.CelestialSphericalHarmonicGravityField

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 19.2.399.0 (19.2.399.0)
Syntax
public class SphericalHarmonicGravityField

The SphericalHarmonicGravityField type exposes the following members.

Constructors
  NameDescription
Public methodSphericalHarmonicGravityField(SphericalHarmonicGravityModel, Int32, Int32, Boolean, SphericalHarmonicsTideType)
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.
Public methodSphericalHarmonicGravityField(SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Boolean, SphericalHarmonicsTideType)
Initializes a new instance from a SphericalHarmonicGravityModel, a CentralBody, 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.
Public methodSphericalHarmonicGravityField(SphericalHarmonicGravityModel, Int32, Int32, Int32, Int32, Boolean, SphericalHarmonicsTideType)
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.
Public methodSphericalHarmonicGravityField(SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Int32, Int32, Boolean, SphericalHarmonicsTideType)
Initializes a new instance from a SphericalHarmonicGravityModel, a CentralBody, 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.
Top
Properties
  NameDescription
Public propertyCentralBody
Gets the CentralBody of this gravity field.
Public propertyDegree
Gets the degree of the subset of the model this gravitational field uses.
Public propertyGravitationalParameter
Gets the gravitational parameter of the central body described by this gravity field.
Public propertyIncludeTwoBodyGravity
Gets a value indicating whether to include the effects of (two-body) gravity of zero degree and order or to instead simply return the higher order perturbations.
Public propertyOrder
Gets the order of the subset of the model this gravitational field uses.
Public propertyPartialsDegree
Gets the degree of the subset of the model this gravitational field uses to calculate partial derivatives.
Public propertyPartialsOrder
Gets the order of the subset of the model this gravitational field uses to calculate partial derivatives.
Public propertyReferenceRadius
Gets the reference radius of the central body described by this gravity field.
Public propertyTideType
Gets or sets the 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.
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also