Skip to content

Commit

Permalink
Update Doxygen output.
Browse files Browse the repository at this point in the history
  • Loading branch information
@kartikkumar
kartikkumar committed Aug 28, 2018
1 parent 6798570 commit 43edeb1
Show file tree
Hide file tree
Showing 53 changed files with 605 additions and 156 deletions.
2 changes: 1 addition & 1 deletion docs/README_8md.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="README_8md.html">README.md</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:28 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/README_8md_source.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/astro_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0fc3206047eab508bd310c9d22a11fd1.html">astro</a></li><li class="navelem"><a class="el" href="astro_8hpp.html">astro.hpp</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:27 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/astro_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0fc3206047eab508bd310c9d22a11fd1.html">astro</a></li><li class="navelem"><a class="el" href="astro_8hpp.html">astro.hpp</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:27 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/centralBodyAccelerationModel_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0fc3206047eab508bd310c9d22a11fd1.html">astro</a></li><li class="navelem"><a class="el" href="centralBodyAccelerationModel_8hpp.html">centralBodyAccelerationModel.hpp</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:27 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
4 changes: 2 additions & 2 deletions docs/centralBodyAccelerationModel_8hpp_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,15 +91,15 @@
<div class="title">centralBodyAccelerationModel.hpp</div> </div>
</div><!--header-->
<div class="contents">
<a href="centralBodyAccelerationModel_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2014-2018 Kartik Kumar (me@kartikkumar.com)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Marko Jankovic, DFKI GmbH</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Natalia Ortiz, University of Southampton</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Juan Romero, University of Strathclyde</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Distributed under the MIT License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifndef ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceastro.html"> 15</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceastro.html">astro</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">template</span>&lt; <span class="keyword">typename</span> Real, <span class="keyword">typename</span> Vector3 &gt;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespaceastro.html#ab85bb7990a62e3651be25b345a826438"> 41</a></span>&#160;Vector3 <a class="code" href="namespaceastro.html#ab85bb7990a62e3651be25b345a826438">computeCentralBodyAcceleration</a>( <span class="keyword">const</span> Real gravitationalParameter,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> Vector3&amp; position )</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; Vector3 acceleration = position;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> Real positionNorm = std::sqrt( position[ 0 ] * position[ 0 ]</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; + position[ 1 ] * position[ 1 ]</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; + position[ 2 ] * position[ 2 ] );</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> Real preMultiplier = -gravitationalParameter</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; / ( positionNorm * positionNorm * positionNorm );</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; acceleration[ 0 ] = preMultiplier * position[ 0 ];</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; acceleration[ 1 ] = preMultiplier * position[ 1 ];</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; acceleration[ 2 ] = preMultiplier * position[ 2 ];</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> acceleration;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">// namespace astro</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif // ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="ttc" id="namespaceastro_html"><div class="ttname"><a href="namespaceastro.html">astro</a></div><div class="ttdef"><b>Definition:</b> <a href="centralBodyAccelerationModel_8hpp_source.html#l00015">centralBodyAccelerationModel.hpp:15</a></div></div>
<a href="centralBodyAccelerationModel_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * Copyright (c) 2014-2018 Kartik Kumar (me@kartikkumar.com)</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Marko Jankovic, DFKI GmbH</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Natalia Ortiz, University of Southampton</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment"> * Copyright (c) 2014-2015 Juan Romero, University of Strathclyde</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * Distributed under the MIT License.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * See accompanying file LICENSE.md or copy at http://opensource.org/licenses/MIT</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> */</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="preprocessor">#ifndef ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#include &lt;cmath&gt;</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div><div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="namespaceastro.html"> 15</a></span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceastro.html">astro</a></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;{</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="keyword">template</span>&lt; <span class="keyword">typename</span> Real, <span class="keyword">typename</span> Vector3 &gt;</div><div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="namespaceastro.html#ab85bb7990a62e3651be25b345a826438"> 41</a></span>&#160;Vector3 <a class="code" href="namespaceastro.html#ab85bb7990a62e3651be25b345a826438">computeCentralBodyAcceleration</a>( <span class="keyword">const</span> Real gravitationalParameter,</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160; <span class="keyword">const</span> Vector3&amp; position )</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;{</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; Vector3 acceleration = position;</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160; <span class="keyword">const</span> Real positionNorm = std::sqrt( position[ 0 ] * position[ 0 ]</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160; + position[ 1 ] * position[ 1 ]</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160; + position[ 2 ] * position[ 2 ] );</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160; <span class="keyword">const</span> Real preMultiplier = -gravitationalParameter</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; / ( positionNorm * positionNorm * positionNorm );</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160; acceleration[ 0 ] = preMultiplier * position[ 0 ];</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160; acceleration[ 1 ] = preMultiplier * position[ 1 ];</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160; acceleration[ 2 ] = preMultiplier * position[ 2 ];</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160; <span class="keywordflow">return</span> acceleration;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;}</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;} <span class="comment">// namespace astro</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;<span class="preprocessor">#endif // ASTRO_CENTRAL_BODY_ACCELERATION_MODEL_HPP</span></div><div class="ttc" id="namespaceastro_html"><div class="ttname"><a href="namespaceastro.html">astro</a></div><div class="ttdef"><b>Definition:</b> <a href="centralBodyAccelerationModel_8hpp_source.html#l00015">centralBodyAccelerationModel.hpp:15</a></div></div>
<div class="ttc" id="namespaceastro_html_ab85bb7990a62e3651be25b345a826438"><div class="ttname"><a href="namespaceastro.html#ab85bb7990a62e3651be25b345a826438">astro::computeCentralBodyAcceleration</a></div><div class="ttdeci">Vector3 computeCentralBodyAcceleration(const Real gravitationalParameter, const Vector3 &amp;position)</div><div class="ttdoc">Compute the acceleration of a point mass body orbiting a uniform central body. </div><div class="ttdef"><b>Definition:</b> <a href="centralBodyAccelerationModel_8hpp_source.html#l00041">centralBodyAccelerationModel.hpp:41</a></div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0fc3206047eab508bd310c9d22a11fd1.html">astro</a></li><li class="navelem"><a class="el" href="centralBodyAccelerationModel_8hpp.html">centralBodyAccelerationModel.hpp</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:27 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
8 changes: 4 additions & 4 deletions docs/constants_8hpp.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,17 +122,17 @@
<tr class="memitem:ab41d7f04d66225abb1c664fc5144eab2"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceastro.html#ab41d7f04d66225abb1c664fc5144eab2">astro::ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS</a> = 1721425.5</td></tr>
<tr class="memdesc:ab41d7f04d66225abb1c664fc5144eab2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start of Gregorian epoch in Julian days (Ramsey, 2016). <a href="namespaceastro.html#ab41d7f04d66225abb1c664fc5144eab2">More...</a><br /></td></tr>
<tr class="separator:ab41d7f04d66225abb1c664fc5144eab2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d0d331186d44d7119f84e2678173b48"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceastro.html#a4d0d331186d44d7119f84e2678173b48">astro::ASTRO_SPEED_OF_FLIGHT</a> = 299792458.0</td></tr>
<tr class="memdesc:a4d0d331186d44d7119f84e2678173b48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Speed of light [m s^-1] (Wikipedia, 2018). <a href="namespaceastro.html#a4d0d331186d44d7119f84e2678173b48">More...</a><br /></td></tr>
<tr class="separator:a4d0d331186d44d7119f84e2678173b48"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a35c5e8babf7badd1156e9e1596df82c5"><td class="memItemLeft" align="right" valign="top">static const double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceastro.html#a35c5e8babf7badd1156e9e1596df82c5">astro::ASTRO_SPEED_OF_LIGHT</a> = 299792458.0</td></tr>
<tr class="memdesc:a35c5e8babf7badd1156e9e1596df82c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Speed of light [m s^-1] (Wikipedia, 2018). <a href="namespaceastro.html#a35c5e8babf7badd1156e9e1596df82c5">More...</a><br /></td></tr>
<tr class="separator:a35c5e8babf7badd1156e9e1596df82c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_0fc3206047eab508bd310c9d22a11fd1.html">astro</a></li><li class="navelem"><a class="el" href="constants_8hpp.html">constants.hpp</a></li>
<li class="footer">Generated on Thu Aug 16 2018 19:21:27 for astro by
<li class="footer">Generated on Tue Aug 28 2018 11:14:43 for astro by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/constants_8hpp.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ var constants_8hpp =
[ "ASTRO_JULIAN_YEAR_IN_SECONDS", "constants_8hpp.html#ae04db502051681a1d03a4e4413328616", null ],
[ "ASTRO_AU_IN_KM", "constants_8hpp.html#a39a8b26b6629488f7a6cbea91b306bc1", null ],
[ "ASTRO_GREGORIAN_EPOCH_IN_JULIAN_DAYS", "constants_8hpp.html#ab41d7f04d66225abb1c664fc5144eab2", null ],
[ "ASTRO_SPEED_OF_FLIGHT", "constants_8hpp.html#a4d0d331186d44d7119f84e2678173b48", null ]
[ "ASTRO_SPEED_OF_LIGHT", "constants_8hpp.html#a35c5e8babf7badd1156e9e1596df82c5", null ]
];
Loading

0 comments on commit 43edeb1

Please sign in to comment.