Difference between revisions of "Template:OrbitAltitude"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Produce a value in meters if radius_m is specified instead of radius_km.)
(Undo revision 79402 by Aru (talk))
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{#if: {{{radius_km|}}}|<!--
+
<includeonly>{{formatnum|{{OrbitAltitude/Core|{{{1|{{{period|}}}}}}|{{{2|{{{mass|}}}}}}|{{{3|{{{radius|}}}}}}|f={{{factor|{{{f|}}}}}}|b={{{body|{{{b|}}}}}}|pf={{{period factor|{{{pf|1}}}}}}}}|2}}&nbsp;{{Dict|{{{factor|{{{f|}}}}}}}}{{Dict|m}}</includeonly><noinclude>This template calculates the altitude of an orbit, given the mass of the planet, the planet's radius and the period of the orbit. The altitude will be calculated by {{Tl|OrbitAltitude/Core}} and then parsed with {{Tl|Formatnum}} and adding a unit.
-->{{#expr: <!--
+
 
-->    ( <!--
+
== Parameters ==
-->        ( <!--
+
{{Parameter table|name=both|parameters=
-->            ( <!--
+
{{Parameter row|period|name2=1|Period of the orbit in seconds}}
-->                {{{period_s}}}^2 * {{G}} * {{{mass_kg}}} <!--
+
{{Parameter row|mass|name2=2|Mass of central body in kilograms}}
-->                / (4 * pi^2) <!--
+
{{Parameter row|radius|name2=3|Radius of central body in meters|0}}
-->            ) ^ (1/3) <!--
+
{{Parameter row|factor|name2=f|Factor in which the altitude should be shown. Available values: None (m), '''k''' (km), '''M''' (Mm), '''G''' (Gm). If the radius was given kilometers it uses the factor '''k'''.|None}}
-->        ) / 1000 <!--
+
{{Parameter row|body|name2=b|Uses the sidereal rotation period, mass and radius as default from the given body. Can be overwritten.|Not set (makes the first three parameters mandatory)}}
-->    ) - {{{radius_km}}} <!--
+
{{Parameter row|period factor|name2=pf|2=Multiplies the period with this value. Useful to easily calculate semi-synchronous orbits (<tt>pf=1/2</tt> then).|3=<tt>1</tt>}}
-->    {{{round|}}} <!--
+
}}
-->}} {{{suffix|km}}}<!--
+
 
-->|<!--
+
== Examples ==
-->{{#expr: <!--
 
-->    ( <!--
 
-->        ( <!--
 
-->            ( <!--
 
-->                {{{period_s}}}^2 * {{G}} * {{{mass_kg}}} <!--
 
-->                 / (4 * pi^2) <!--
 
-->             ) ^ (1/3) <!--
 
-->        ) <!--
 
-->    ) - {{{radius_m}}} <!--
 
-->    {{{round|}}} <!--
 
-->}} {{{suffix|m}}}<!--
 
-->|<!--
 
<noinclude>
 
  
 
{| class="wikitable"
 
{| class="wikitable"
! Usage || Produces
+
! Usage || Result
 
|-
 
|-
| <pre><nowiki>{{OrbitAltitude | period_s=64980 | mass_kg=4.515e21 | radius_km=320}}</nowiki></pre> || {{OrbitAltitude | period_s=64980 | mass_kg=4.515e21 | radius_km=320}}
+
| <pre>{{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000 | factor=k}}</pre> || {{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000|factor=k}}
 
|-
 
|-
| <pre><nowiki>{{OrbitAltitude | period_s=64980 | mass_kg=4.515e21 | radius_m=320000}}</nowiki></pre> || {{OrbitAltitude | period_s=64980 | mass_kg=4.515e21 | radius_m=320000}}
+
| <pre>{{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000}}</pre> || {{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000}}
 
|}
 
|}
  
This template calculates the altitude of an orbit, given the mass of the planet (in kg), the planet's radius (in km), and the period of the orbit (in seconds).
+
[[Category:Calculating templates]]
 
+
[[Category:Translating templates]]</noinclude>
[[Category:Templates|OrbitAltitude]]
 
</noinclude>
 

Latest revision as of 14:20, 28 August 2017

This template calculates the altitude of an orbit, given the mass of the planet, the planet's radius and the period of the orbit. The altitude will be calculated by {{OrbitAltitude/Core}} and then parsed with {{Formatnum}} and adding a unit.

Parameters

#/Name Optional Description Default
period or 1 No Period of the orbit in seconds
mass or 2 No Mass of central body in kilograms
radius or 3 Yes Radius of central body in meters 0
factor or f Yes Factor in which the altitude should be shown. Available values: None (m), k (km), M (Mm), G (Gm). If the radius was given kilometers it uses the factor k. None
body or b Yes Uses the sidereal rotation period, mass and radius as default from the given body. Can be overwritten. Not set (makes the first three parameters mandatory)
period factor or pf Yes Multiplies the period with this value. Useful to easily calculate semi-synchronous orbits (pf=1/2 then). 1

Examples

Usage Result
{{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000 | factor=k}}
2 862.36 km
{{OrbitAltitude | period=64980 | mass=4.515e21 | radius=320000}}
2 862 362.24 m