Click or drag to resize

OrbitalElementsComputePeriod Method

Calculates the period of the orbit.

Namespace:  AGI.Foundation.Coordinates
Assembly:  AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 19.1.398.0 (19.1.398.0)
Syntax
public static double ComputePeriod(
	double inverseSemimajorAxis,
	double gravitationalParameter
)

Parameters

inverseSemimajorAxis
Type: SystemDouble
The inverse of the semimajor axis (distance).
gravitationalParameter
Type: SystemDouble
The gravitational parameter (distance cubed per time squared).

Return Value

Type: Double
The period of the orbit.
Exceptions
ExceptionCondition
ArgumentOutOfRangeExceptionThrown if the gravitationalParameter is negative or zero.
Remarks
The inverseSemimajorAxis and gravitationalParameter parameters must have consistent units and the units of the resulting period will correspond with the units of the input parameters.
See Also