Updated documentation

Author: Jim Carr

docs/Main_8java_source.html

@@ -137,9 +137,10 @@
 <div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>        <a class="code hl_function" href="classMain.html#a782c36108b1ec82a5ce456394cafdb50">testCoordinates</a>.testRefraction();</div>
 <div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span>        <a class="code hl_function" href="classMain.html#a782c36108b1ec82a5ce456394cafdb50">testCoordinates</a>.testParallax();</div>
 <div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>        <a class="code hl_function" href="classMain.html#a782c36108b1ec82a5ce456394cafdb50">testCoordinates</a>.testHeliographicCoordinates();</div>
-<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>    }</div>
+<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>        <a class="code hl_function" href="classMain.html#a782c36108b1ec82a5ce456394cafdb50">testCoordinates</a>.testCarringtonRotationNumber();</div>
+<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>    }</div>
 </div>
-<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>}</div>
+<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>}</div>
 </div>
 <div class="ttc" id="aclassMain_html"><div class="ttname"><a href="classMain.html">Main</a></div><div class="ttdef"><b>Definition</b> <a href="Main_8java_source.html#l00001">Main.java:1</a></div></div>
 <div class="ttc" id="aclassMain_html_a6a2b50d4208f7a6dab79fc53c8e8cc53"><div class="ttname"><a href="classMain.html#a6a2b50d4208f7a6dab79fc53c8e8cc53">Main.testDateTime</a></div><div class="ttdeci">static void testDateTime()</div><div class="ttdef"><b>Definition</b> <a href="Main_8java_source.html#l00007">Main.java:7</a></div></div>

docs/PACoordinates_8java_source.html

@@ -625,7 +625,17 @@
 <div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span>        <span class="keywordflow">return</span> <span class="keyword">new</span> HeliographicCoordinates(helioLongDeg, helioLatDeg);</div>
 <div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span>    }</div>
 </div>
-<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span>}</div>
+<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span> </div>
+<div class="foldopen" id="foldopen00560" data-start="{" data-end="}">
+<div class="line"><a id="l00560" name="l00560"></a><span class="lineno"><a class="line" href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a539bfcda499dfda32b24a925c2149ab1">  560</a></span>    <span class="keyword">public</span> <span class="keywordtype">int</span> <a class="code hl_function" href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a539bfcda499dfda32b24a925c2149ab1">carringtonRotationNumber</a>(<span class="keywordtype">double</span> gwdateDay, <span class="keywordtype">int</span> gwdateMonth, <span class="keywordtype">int</span> gwdateYear) {</div>
+<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span>        <span class="keywordtype">double</span> julianDateDays = <a class="code hl_class" href="classastro_1_1practical_1_1lib_1_1PAMacros.html">PAMacros</a>.<a class="code hl_function" href="classastro_1_1practical_1_1lib_1_1PAMacros.html#a7d664294ec8964eba672c83957d59dea">civilDateToJulianDate</a>(gwdateDay, gwdateMonth, gwdateYear);</div>
+<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span> </div>
+<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span>        <span class="keywordtype">int</span> crn = 1690 + (int) <a class="code hl_class" href="classastro_1_1practical_1_1lib_1_1PAUtil.html">PAUtil</a>.<a class="code hl_function" href="classastro_1_1practical_1_1lib_1_1PAUtil.html#a3af69cfbf5990d739a9ffc3cc489de89">round</a>((julianDateDays - 2444235.34) / 27.2753, 0);</div>
+<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span> </div>
+<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span>        <span class="keywordflow">return</span> crn;</div>
+<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span>    }</div>
+</div>
+<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span>}</div>
 </div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html">astro.practical.lib.PACoordinates</a></div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00020">PACoordinates.java:20</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a00447028bb7e2390fbb676667dca5453"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a00447028bb7e2390fbb676667dca5453">astro.practical.lib.PACoordinates.decimalDegreesToAngle</a></div><div class="ttdeci">Angle decimalDegreesToAngle(double decimalDegrees)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00036">PACoordinates.java:36</a></div></div>
@@ -638,6 +648,7 @@
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a2e30d9722eb33997e46295b723b4bdd9"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a2e30d9722eb33997e46295b723b4bdd9">astro.practical.lib.PACoordinates.rightAscensionToHourAngle</a></div><div class="ttdeci">HourAngle rightAscensionToHourAngle(double raHours, double raMinutes, double raSeconds, double lctHours, double lctMinutes, double lctSeconds, boolean isDaylightSavings, int zoneCorrection, double localDay, int localMonth, int localYear, double geographicalLongitude)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00055">PACoordinates.java:55</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a3c584d324750fc55fd58890837182319"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a3c584d324750fc55fd58890837182319">astro.practical.lib.PACoordinates.hourAngleToRightAscension</a></div><div class="ttdeci">RightAscension hourAngleToRightAscension(double hourAngleHours, double hourAngleMinutes, double hourAngleSeconds, double lctHours, double lctMinutes, double lctSeconds, boolean isDaylightSaving, int zoneCorrection, double localDay, int localMonth, int localYear, double geographicalLongitude)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00075">PACoordinates.java:75</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a5100be61f814353c9dfd62000f07bb2b"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a5100be61f814353c9dfd62000f07bb2b">astro.practical.lib.PACoordinates.atmosphericRefraction</a></div><div class="ttdeci">RightAscensionDeclination atmosphericRefraction(double trueRAHour, double trueRAMin, double trueRASec, double trueDecDeg, double trueDecMin, double trueDecSec, CoordinateType coordinateType, double geogLongDeg, double geogLatDeg, int daylightSavingHours, int timezoneHours, double lcdDay, int lcdMonth, int lcdYear, double lctHour, double lctMin, double lctSec, double atmosphericPressureMbar, double atmosphericTemperatureCelsius)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00454">PACoordinates.java:454</a></div></div>
+<div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a539bfcda499dfda32b24a925c2149ab1"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a539bfcda499dfda32b24a925c2149ab1">astro.practical.lib.PACoordinates.carringtonRotationNumber</a></div><div class="ttdeci">int carringtonRotationNumber(double gwdateDay, int gwdateMonth, int gwdateYear)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00560">PACoordinates.java:560</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a5bb6897b3878d2085ced03729982d7a0"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a5bb6897b3878d2085ced03729982d7a0">astro.practical.lib.PACoordinates.nutationInEclipticLongitudeAndObliquity</a></div><div class="ttdeci">Nutation nutationInEclipticLongitudeAndObliquity(double greenwichDay, int greenwichMonth, int greenwichYear)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00399">PACoordinates.java:399</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a5f54a5273355f679f6cde74ad6bc9e14"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a5f54a5273355f679f6cde74ad6bc9e14">astro.practical.lib.PACoordinates.eclipticCoordinateToEquatorialCoordinate</a></div><div class="ttdeci">EquatorialCoordinatesRA eclipticCoordinateToEquatorialCoordinate(double eclipticLongitudeDegrees, double eclipticLongitudeMinutes, double eclipticLongitudeSeconds, double eclipticLatitudeDegrees, double eclipticLatitudeMinutes, double eclipticLatitudeSeconds, double greenwichDay, int greenwichMonth, int greenwichYear)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00155">PACoordinates.java:155</a></div></div>
 <div class="ttc" id="aclassastro_1_1practical_1_1lib_1_1PACoordinates_html_a6785fb42d9eb4fde7c79b213d9a541ca"><div class="ttname"><a href="classastro_1_1practical_1_1lib_1_1PACoordinates.html#a6785fb42d9eb4fde7c79b213d9a541ca">astro.practical.lib.PACoordinates.galacticCoordinateToEquatorialCoordinate</a></div><div class="ttdeci">EquatorialCoordinatesRA galacticCoordinateToEquatorialCoordinate(double galLongDeg, double galLongMin, double galLongSec, double galLatDeg, double galLatMin, double galLatSec)</div><div class="ttdef"><b>Definition</b> <a href="PACoordinates_8java_source.html#l00253">PACoordinates.java:253</a></div></div>

docs/TestCoordinates_8java_source.html

@@ -366,10 +366,21 @@
 <div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span>                .Assert(-19.94, heliographicCoordinates.helioLatDeg);</div>
 <div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span>    }</div>
 </div>
-<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span>}</div>
+<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span> </div>
+<div class="foldopen" id="foldopen00240" data-start="{" data-end="}">
+<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"><a class="line" href="classTestCoordinates.html#a1389bff3519166d47e96aea6daa1df4e">  240</a></span>    <span class="keyword">public</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classTestCoordinates.html#a1389bff3519166d47e96aea6daa1df4e">testCarringtonRotationNumber</a>() {</div>
+<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span>        TestLib testLib = <span class="keyword">new</span> TestLib();</div>
+<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span> </div>
+<div class="line"><a id="l00243" name="l00243"></a><span class="lineno">  243</span>        <span class="keywordtype">int</span> carringtonRotationNumber = paCoordinates.carringtonRotationNumber(27, 1, 1975);</div>
+<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span> </div>
+<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span>        testLib.setTestName(<span class="stringliteral">&quot;Carrington Rotation Number&quot;</span>).Assert(1624, carringtonRotationNumber);</div>
+<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>    }</div>
+</div>
+<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span>}</div>
 </div>
 <div class="ttc" id="aclassTestCoordinates_html"><div class="ttname"><a href="classTestCoordinates.html">TestCoordinates</a></div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00021">TestCoordinates.java:21</a></div></div>
 <div class="ttc" id="aclassTestCoordinates_html_a0bc145beb0b8dbccd43eab173cd1ef71"><div class="ttname"><a href="classTestCoordinates.html#a0bc145beb0b8dbccd43eab173cd1ef71">TestCoordinates.testCorrectForAberration</a></div><div class="ttdeci">void testCorrectForAberration()</div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00190">TestCoordinates.java:190</a></div></div>
+<div class="ttc" id="aclassTestCoordinates_html_a1389bff3519166d47e96aea6daa1df4e"><div class="ttname"><a href="classTestCoordinates.html#a1389bff3519166d47e96aea6daa1df4e">TestCoordinates.testCarringtonRotationNumber</a></div><div class="ttdeci">void testCarringtonRotationNumber()</div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00240">TestCoordinates.java:240</a></div></div>
 <div class="ttc" id="aclassTestCoordinates_html_a1a8ecc8751a4a0980f8c240c6931fe37"><div class="ttname"><a href="classTestCoordinates.html#a1a8ecc8751a4a0980f8c240c6931fe37">TestCoordinates.testEquatorialCoordinateToFromGalacticCoordinate</a></div><div class="ttdeci">void testEquatorialCoordinateToFromGalacticCoordinate()</div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00116">TestCoordinates.java:116</a></div></div>
 <div class="ttc" id="aclassTestCoordinates_html_a22922264bf821aa17aeebaba0bf55ab1"><div class="ttname"><a href="classTestCoordinates.html#a22922264bf821aa17aeebaba0bf55ab1">TestCoordinates.TestCoordinates</a></div><div class="ttdeci">TestCoordinates()</div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00024">TestCoordinates.java:24</a></div></div>
 <div class="ttc" id="aclassTestCoordinates_html_a273efa91f5deec2908e118bd0d3857b8"><div class="ttname"><a href="classTestCoordinates.html#a273efa91f5deec2908e118bd0d3857b8">TestCoordinates.testEclipticCoordinateToFromEquatorialCoordinate</a></div><div class="ttdeci">void testEclipticCoordinateToFromEquatorialCoordinate()</div><div class="ttdef"><b>Definition</b> <a href="TestCoordinates_8java_source.html#l00091">TestCoordinates.java:91</a></div></div>