Functions/GenXdev.Helpers.Physics/Get-EscapeVelocityByMassAndRadius.cs
|
// ################################################################################
// Part of PowerShell module : GenXdev.Helpers.Physics // Original cmdlet filename : Get-EscapeVelocityByMassAndRadius.cs // Original author : René Vaessen / GenXdev // Version : 2.0.2025 // ################################################################################ // Copyright (c) René Vaessen / GenXdev // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // ################################################################################ using System; using System.Management.Automation; namespace GenXdev.Helpers.Physics { /// <summary> /// <para type="synopsis"> /// Calculates escape velocity. /// </para> /// /// <para type="description"> /// Uses v = sqrt(2 G M / r). /// </para> /// /// <para type="description"> /// PARAMETERS /// </para> /// /// <para type="description"> /// -MassInKilograms <double><br/> /// Mass of body in kg.<br/> /// - <b>Position</b>: 0<br/> /// - <b>Mandatory</b>: true<br/> /// </para> /// /// <para type="description"> /// -RadiusInMeters <double><br/> /// Radius in meters.<br/> /// - <b>Position</b>: 1<br/> /// - <b>Mandatory</b>: true<br/> /// </para> /// /// <para type="description"> /// -As <string><br/> /// Output unit for velocity. Default 'm/s'.<br/> /// - <b>Position</b>: 2<br/> /// - <b>Mandatory</b>: false<br/> /// - <b>Default</b>: "m/s"<br/> /// </para> /// /// <example> /// <para>Calculate escape velocity for Earth</para> /// <para>Calculates the escape velocity for a body with Earth's mass and radius.</para> /// <code> /// Get-EscapeVelocityByMassAndRadius -MassInKilograms 5.972e24 -RadiusInMeters 6371000 -As "km/h" /// </code> /// </example> /// /// <example> /// <para>Calculate escape velocity with default units</para> /// <para>Calculates escape velocity using default m/s units.</para> /// <code> /// Get-EscapeVelocityByMassAndRadius 1e26 10000000 /// </code> /// </example> /// </summary> [Cmdlet(VerbsCommon.Get, "EscapeVelocityByMassAndRadius")] [OutputType(typeof(double))] public class GetEscapeVelocityByMassAndRadiusCommand : PSGenXdevCmdlet { /// <summary> /// Mass of body in kg /// </summary> [Parameter( Mandatory = true, Position = 0, HelpMessage = "Mass of body in kg")] public double MassInKilograms { get; set; } /// <summary> /// Radius in meters /// </summary> [Parameter( Mandatory = true, Position = 1, HelpMessage = "Radius in meters")] public double RadiusInMeters { get; set; } /// <summary> /// Output unit for velocity /// </summary> [Parameter( Mandatory = false, Position = 2, HelpMessage = "Output unit for velocity")] [ValidateSet("m/s", "km/h", "mph", "ft/s")] public string As { get; set; } = "m/s"; private const double G = 6.67430e-11; /// <summary> /// Begin processing - initialize gravitational constant /// </summary> protected override void BeginProcessing() { // Gravitational constant is defined as a constant } /// <summary> /// Process record - calculate escape velocity and convert units /// </summary> protected override void ProcessRecord() { // Calculate escape velocity using v = sqrt(2 G M / r) double velocity = Math.Sqrt(2 * G * MassInKilograms / RadiusInMeters); // Convert to desired unit using Convert-PhysicsUnit cmdlet var scriptResult = InvokeCommand.InvokeScript( $"GenXdev.Helpers\\Convert-PhysicsUnit -Value {velocity} -FromUnit 'm/s' -ToUnit '{As}'"); // Output the converted result WriteObject(scriptResult[0].BaseObject); } /// <summary> /// End processing - cleanup if needed /// </summary> protected override void EndProcessing() { // No cleanup needed } } } // ############################################################################### |