Click or drag to resize

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

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

Namespace:  AGI.Foundation.Celestial
Assembly:  AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax
Copy
public SphericalHarmonicGravityField(
	SphericalHarmonicGravityModel gravityModel,
	int degree,
	int order,
	bool includeTwoBody,
	SolidTideModel tideModel
)

Parameters

gravityModel
Type: AGI.Foundation.CelestialSphericalHarmonicGravityModel
The full gravity model to configure.
degree
Type: SystemInt32
The desired degree. The configured gravity field will have this degree if FileDegree allows it.
order
Type: SystemInt32
The desired order. The configured gravity field will have this degree if FileDegree, FileOrder and degree allow it.
includeTwoBody
Type: SystemBoolean
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.CelestialSolidTideModel
The solid tide model that incorporates the effects of tides upon the gravity model.
Exceptions
ExceptionCondition
ArgumentNullExceptionThrown when gravityModel is .
ArgumentExceptionThrown when gravityModel includes permanent tides and tideModel is not . 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 .
InvalidOperationException Thrown if the CentralBodyName in gravityModel does not refer to one of the supported central bodies. In that case use SphericalHarmonicGravityField(SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Boolean, SolidTideModel)
See Also