Click or drag to resize

SphericalHarmonicGravityField Constructor (SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Int32, Int32, Boolean, SolidTideModel)

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 to include two body forces.

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 25.1.421.0 (25.1.421.0)
Syntax
public SphericalHarmonicGravityField(
	SphericalHarmonicGravityModel gravityModel,
	CentralBody centralBody,
	int degree,
	int order,
	int partialsDegree,
	int partialsOrder,
	bool includeTwoBody,
	SolidTideModel tideModel
)

Parameters

gravityModel
Type: AGI.Foundation.Celestial.SphericalHarmonicGravityModel
The full gravity model to configure.
centralBody
Type: AGI.Foundation.Celestial.CentralBody
The central body to use for this gravity field instead of referencing CentralBodyName
degree
Type: System.Int32
The desired degree. The configured gravity field will have this degree if FileDegree allows it.
order
Type: System.Int32
The desired order. The configured gravity field will have this degree if FileDegree, FileOrder and degree allow it.
partialsDegree
Type: System.Int32
The degree to use for calculating partial derivatives.
partialsOrder
Type: System.Int32
The order to use for calculating partial derivatives.
includeTwoBody
Type: System.Boolean
The flag representing whether a force model using this field should include two body gravity, or just the higher order perturbations.
tideModel
Type: AGI.Foundation.Celestial.SolidTideModel
The solid tide model that incorporates the effects of tides upon the gravity model.
Exceptions
ExceptionCondition
ArgumentNullExceptionThrown when gravityModel is null.
ArgumentExceptionThrown when gravityModel includes permanent tides and tideModel is not null. In this case, the solid tide effects would be double counted. This exception can be mitigated by using WithoutEarthPermanentTides() or WithoutPermanentTides(SphericalHarmonicCoefficients) to remove the permanent tides from gravityModel or to set tideModel to be null.
See Also