OrbitalElementsComputePeriod Method |
Calculates the period of the orbit.
Namespace:
AGI.Foundation.Coordinates
Assembly:
AGI.Foundation.Core (in AGI.Foundation.Core.dll) Version: 25.2.423.0 (25.2.423.0)
Syntaxpublic static double ComputePeriod(
double inverseSemimajorAxis,
double gravitationalParameter
)
Public Shared Function ComputePeriod (
inverseSemimajorAxis As Double,
gravitationalParameter As Double
) As Double
public:
static double ComputePeriod(
double inverseSemimajorAxis,
double gravitationalParameter
)
static member ComputePeriod :
inverseSemimajorAxis : float *
gravitationalParameter : float -> float
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:
DoubleThe period of the orbit.
Exceptions| Exception | Condition |
|---|
| ArgumentOutOfRangeException | Thrown when gravitationalParameter is negative or zero. |
RemarksinverseSemimajorAxis and gravitationalParameter must have consistent units
and the units of the resulting period will correspond with the units of the input parameters.
See Also