SphericalHarmonicGravityField Constructor (SphericalHarmonicGravityModel, Int32, Int32, Int32, Int32, Boolean, SphericalHarmonicsTideType) |
Note: This API is now obsolete.
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.
Namespace:
AGI.Foundation.Celestial
Assembly:
AGI.Foundation.OrbitPropagation (in AGI.Foundation.OrbitPropagation.dll) Version: 22.1.413.0 (22.1.413.0)
Syntax[ObsoleteAttribute("Any constructor with tideType is deprecated and needs to be replaced with a constructor that includes a tideModel.")]
public SphericalHarmonicGravityField(
SphericalHarmonicGravityModel gravityModel,
int degree,
int order,
int partialsDegree,
int partialsOrder,
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,
degree As Integer,
order As Integer,
partialsDegree As Integer,
partialsOrder 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,
int degree,
int order,
int partialsDegree,
int partialsOrder,
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 *
degree : int *
order : int *
partialsDegree : int *
partialsOrder : int *
includeTwoBody : bool *
tideType : SphericalHarmonicsTideType -> SphericalHarmonicGravityField
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. - partialsDegree
- Type: SystemInt32
The degree to use for calculating partial derivatives. - partialsOrder
- Type: SystemInt32
The order to use for calculating partial derivatives. - 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.
ExceptionsException | Condition |
---|
ArgumentNullException | Thrown when gravityModel is . |
ArgumentException | Thrown when the inferred central body 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, Int32, Int32, Int32, Int32, Boolean, SolidTideModel). |
InvalidOperationException |
Thrown if the CentralBodyName in model does not refer to
the Earth, Sun, or Moon. In that case use
SphericalHarmonicGravityField(SphericalHarmonicGravityModel, CentralBody, Int32, Int32, Int32, Int32, Boolean, SphericalHarmonicsTideType) |
Remarks
If the inferred central body 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).
See Also