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

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

Note: This API is now obsolete.

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.

Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 23.2.417.0 (23.2.417.0)

Syntax

C++

Copy

[ObsoleteAttribute("Any constructor with tideType is deprecated and needs to be replaced with a constructor that includes a tideModel.")]
public SphericalHarmonicGravityField(
	SphericalHarmonicGravityModel gravityModel,
	CentralBody centralBody,
	int degree,
	int order,
	bool includeTwoBody,
	SphericalHarmonicsTideType tideType
)

<ObsoleteAttribute("Any constructor with tideType is deprecated and needs to be replaced with a constructor that includes a tideModel.")>
Public Sub New ( 
	gravityModel As SphericalHarmonicGravityModel,
	centralBody As CentralBody,
	degree As Integer,
	order As Integer,
	includeTwoBody As Boolean,
	tideType As SphericalHarmonicsTideType
)

public:
[ObsoleteAttribute(L"Any constructor with tideType is deprecated and needs to be replaced with a constructor that includes a tideModel.")]
SphericalHarmonicGravityField(
	SphericalHarmonicGravityModel^ gravityModel, 
	CentralBody^ centralBody, 
	int degree, 
	int order, 
	bool includeTwoBody, 
	SphericalHarmonicsTideType tideType
)

[<ObsoleteAttribute("Any constructor with tideType is deprecated and needs to be replaced with a constructor that includes a tideModel.")>]
new : 
        gravityModel : SphericalHarmonicGravityModel * 
        centralBody : CentralBody * 
        degree : int * 
        order : int * 
        includeTwoBody : bool * 
        tideType : SphericalHarmonicsTideType -> SphericalHarmonicGravityField

Parameters

gravityModel: Type: AGI.Foundation.CelestialSphericalHarmonicGravityModel
The full gravity model to configure.
centralBody: Type: AGI.Foundation.CelestialCentralBody
The central body to use for this gravity field instead of referencing CentralBodyName
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.
tideType: Type: AGI.Foundation.CelestialSphericalHarmonicsTideType
The type of tidal effects this field should include.

Exceptions

Exception	Condition
ArgumentNullException	Thrown when gravityModel is .
ArgumentException	Thrown when the centralBody is not Earth and the tideType requires permanent or time-varying tides to be added or removed from the gravityModel. In that case, use SphericalHarmonicGravityField(SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Boolean, SolidTideModel).

Remarks

If the centralBody is Earth and the desired tideType is not automatically satisfied by the IncludesPermanentTides property of the gravityModel, the tideType will be satisfied by adding or removing permanent tides from the gravityModel using the default IERS 2003 Earth permanent tide values (if needed).

Reference

SphericalHarmonicGravityField Class

SphericalHarmonicGravityField Overload

AGI.Foundation.Celestial Namespace