Skip to content

Commit fcca98d

Browse files
lwang-astrolwang-astro
committed
v1.0 Release version
1 parent 8678efc commit fcca98d

File tree

3,831 files changed

+257546
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,831 files changed

+257546
-2
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ In particular, users are encouraged to familiarize themselves with key Python mo
3434
This README document serves as a concise yet comprehensive guide detailing the installation and utilization of the code. It is strongly recommended that users thoroughly review this documentation before reaching out to the developers with any queries.
3535

3636
For a deeper understanding of the algorithms employed, additional details can be found in the work by Wang et al. (2020; available on arXiv: https://arxiv.org/abs/2006.16560).
37-
A Doxygen documentation tailored for developers is currently in the process of being prepared.
37+
For developers seeking to understand the code structure, please consult the [Doxygen documentation](https://lwang-astro.github.io/PeTar/docs/html/index.html).
3838

3939
To enhance the English in the given text, you could say:
4040

‎VERSION‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
1233
1+
1234r

‎doc/doc.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
/*! \mainpage Introduction
2+
3+
This document provides detailed descriptions of PeTar's source codes, including the functionality, usage, and argument descriptions for each class and function. Developers interested in modifying the PeTar codes may find useful information here. For using PeTar in simulations, please refer to the README.md.
4+
5+
Note that PeTar relies on the external libraries FPDS and SDAR. For details about these two codes, please refer to the official documentation provided on their GitHub pages.
6+
7+
The majority of PeTar code is written in C++ classes, with each class representing a function or data type. The main class, PeTar, is defined in petar.hpp. Users can begin with this class to grasp the main structure of the code.
8+
9+
*/

‎doc/doxygen.conf‎

Lines changed: 2579 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/html/annotated.html‎

Lines changed: 192 additions & 0 deletions
Large diffs are not rendered by default.

‎doc/html/annotated_dup.js‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
var annotated_dup =
2+
[
3+
[ "PIKG", "namespacePIKG.html", "namespacePIKG" ],
4+
[ "ARInteraction", "classARInteraction.html", "classARInteraction" ],
5+
[ "ARPerturber", "classARPerturber.html", "classARPerturber" ],
6+
[ "ArtificialParticleInformation", "classArtificialParticleInformation.html", "classArtificialParticleInformation" ],
7+
[ "ArtificialParticleManager", "classArtificialParticleManager.html", "classArtificialParticleManager" ],
8+
[ "BinaryBase", "structBinaryBase.html", "structBinaryBase" ],
9+
[ "BinaryEvent", "classBinaryEvent.html", "classBinaryEvent" ],
10+
[ "BSEManager", "classBSEManager.html", "classBSEManager" ],
11+
[ "CalcForceEpEpWithLinearCutoffNoSimd", "structCalcForceEpEpWithLinearCutoffNoSimd.html", "structCalcForceEpEpWithLinearCutoffNoSimd" ],
12+
[ "CalcForceEpSpMonoNoSimd", "structCalcForceEpSpMonoNoSimd.html", "structCalcForceEpSpMonoNoSimd" ],
13+
[ "CalcForceEpSpQuadNoSimd", "structCalcForceEpSpQuadNoSimd.html", "structCalcForceEpSpQuadNoSimd" ],
14+
[ "CalcForcePPNoSimd", "structCalcForcePPNoSimd.html", "structCalcForcePPNoSimd" ],
15+
[ "CalcForceWithLinearCutoffCUDA", "structCalcForceWithLinearCutoffCUDA.html", "structCalcForceWithLinearCutoffCUDA" ],
16+
[ "ChangeArgument", "structChangeArgument.html", "structChangeArgument" ],
17+
[ "ChangeOver", "classChangeOver.html", "classChangeOver" ],
18+
[ "Cluster", "structCluster.html", "structCluster" ],
19+
[ "cudaPointer", "structcudaPointer.html", "structcudaPointer" ],
20+
[ "EnergyAndMomemtum", "classEnergyAndMomemtum.html", "classEnergyAndMomemtum" ],
21+
[ "EPISoft", "classEPISoft.html", "classEPISoft" ],
22+
[ "EPJSoft", "classEPJSoft.html", "classEPJSoft" ],
23+
[ "Escaper", "classEscaper.html", "classEscaper" ],
24+
[ "FDPSProfile", "classFDPSProfile.html", "classFDPSProfile" ],
25+
[ "FileHeader", "classFileHeader.html", "classFileHeader" ],
26+
[ "FileHeaderNoOffset", "classFileHeaderNoOffset.html", "classFileHeaderNoOffset" ],
27+
[ "ForceSoft", "classForceSoft.html", "classForceSoft" ],
28+
[ "FPSoft", "classFPSoft.html", "classFPSoft" ],
29+
[ "FPSoftWriteArtificial", "classFPSoftWriteArtificial.html", "classFPSoftWriteArtificial" ],
30+
[ "FRWModel", "classFRWModel.html", "classFRWModel" ],
31+
[ "GalpyManager", "classGalpyManager.html", "classGalpyManager" ],
32+
[ "GroupDataDeliver", "unionGroupDataDeliver.html", "unionGroupDataDeliver" ],
33+
[ "HardDump", "classHardDump.html", "classHardDump" ],
34+
[ "HardDumpList", "classHardDumpList.html", "classHardDumpList" ],
35+
[ "HardEnergy", "structHardEnergy.html", "structHardEnergy" ],
36+
[ "HardIntegrator", "classHardIntegrator.html", "classHardIntegrator" ],
37+
[ "HardManager", "classHardManager.html", "classHardManager" ],
38+
[ "HermiteInformation", "classHermiteInformation.html", "classHermiteInformation" ],
39+
[ "HermiteInteraction", "classHermiteInteraction.html", "classHermiteInteraction" ],
40+
[ "HermitePerturber", "classHermitePerturber.html", "classHermitePerturber" ],
41+
[ "IOParams", "structIOParams.html", "structIOParams" ],
42+
[ "IOParamsBSE", "classIOParamsBSE.html", "classIOParamsBSE" ],
43+
[ "IOParamsContainer", "classIOParamsContainer.html", "classIOParamsContainer" ],
44+
[ "IOParamsGalpy", "classIOParamsGalpy.html", "classIOParamsGalpy" ],
45+
[ "IOParamsHardTest", "classIOParamsHardTest.html", "classIOParamsHardTest" ],
46+
[ "IOParamsPeTar", "classIOParamsPeTar.html", "classIOParamsPeTar" ],
47+
[ "IOParamsPrintHelp", "structIOParamsPrintHelp.html", "structIOParamsPrintHelp" ],
48+
[ "KickDriftStep", "classKickDriftStep.html", "classKickDriftStep" ],
49+
[ "Matrix3", "classMatrix3.html", "classMatrix3" ],
50+
[ "Mediator", "classMediator.html", "classMediator" ],
51+
[ "MWPotentialEvolve", "classMWPotentialEvolve.html", "classMWPotentialEvolve" ],
52+
[ "NumCounter", "structNumCounter.html", "structNumCounter" ],
53+
[ "OrbitalSamplingManager", "classOrbitalSamplingManager.html", "classOrbitalSamplingManager" ],
54+
[ "Particle", "classParticle.html", "classParticle" ],
55+
[ "ParticleBase", "classParticleBase.html", "classParticleBase" ],
56+
[ "ParticleDistributionGenerator", "classParticleDistributionGenerator.html", null ],
57+
[ "PhantomGrapeQuad", "classPhantomGrapeQuad.html", "classPhantomGrapeQuad" ],
58+
[ "PotentialSet", "structPotentialSet.html", "structPotentialSet" ],
59+
[ "PotentialSetPar", "structPotentialSetPar.html", "structPotentialSetPar" ],
60+
[ "PseudoParticleMultipoleManager", "classPseudoParticleMultipoleManager.html", "classPseudoParticleMultipoleManager" ],
61+
[ "Ptcl", "classPtcl.html", "classPtcl" ],
62+
[ "PtclCluster", "structPtclCluster.html", "structPtclCluster" ],
63+
[ "PtclComm", "classPtclComm.html", "classPtclComm" ],
64+
[ "PtclHard", "classPtclHard.html", "classPtclHard" ],
65+
[ "PtclOuter", "classPtclOuter.html", "classPtclOuter" ],
66+
[ "SearchCluster", "classSearchCluster.html", "classSearchCluster" ],
67+
[ "SearchGroupCandidate", "classSearchGroupCandidate.html", "classSearchGroupCandidate" ],
68+
[ "SearchNeighborEpEpNoSimd", "structSearchNeighborEpEpNoSimd.html", "structSearchNeighborEpEpNoSimd" ],
69+
[ "Stability", "classStability.html", "classStability" ],
70+
[ "StarParameter", "structStarParameter.html", "structStarParameter" ],
71+
[ "StarParameterOut", "structStarParameterOut.html", "structStarParameterOut" ],
72+
[ "Status", "classStatus.html", "classStatus" ],
73+
[ "SysCounts", "classSysCounts.html", "classSysCounts" ],
74+
[ "SysProfile", "classSysProfile.html", "classSysProfile" ],
75+
[ "SystemHard", "classSystemHard.html", "classSystemHard" ],
76+
[ "TidalTensor", "classTidalTensor.html", "classTidalTensor" ],
77+
[ "Tprofile", "structTprofile.html", "structTprofile" ],
78+
[ "TwoBodyTide", "classTwoBodyTide.html", "classTwoBodyTide" ]
79+
];

‎doc/html/ar__interaction_8hpp.html‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.17"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>PeTar: ar_interaction.hpp File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<script type="text/x-mathjax-config">
20+
MathJax.Hub.Config({
21+
extensions: ["tex2jax.js"],
22+
jax: ["input/TeX","output/HTML-CSS"],
23+
});
24+
</script>
25+
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></script>
26+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
27+
</head>
28+
<body>
29+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
30+
<div id="titlearea">
31+
<table cellspacing="0" cellpadding="0">
32+
<tbody>
33+
<tr style="height: 56px;">
34+
<td id="projectalign" style="padding-left: 0.5em;">
35+
<div id="projectname">PeTar
36+
</div>
37+
<div id="projectbrief">N-body code for collisional gravitational systems</div>
38+
</td>
39+
</tr>
40+
</tbody>
41+
</table>
42+
</div>
43+
<!-- end header part -->
44+
<!-- Generated by Doxygen 1.8.17 -->
45+
<script type="text/javascript">
46+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
47+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
48+
/* @license-end */
49+
</script>
50+
<script type="text/javascript" src="menudata.js"></script>
51+
<script type="text/javascript" src="menu.js"></script>
52+
<script type="text/javascript">
53+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
54+
$(function() {
55+
initMenu('',true,false,'search.php','Search');
56+
$(document).ready(function() { init_search(); });
57+
});
58+
/* @license-end */</script>
59+
<div id="main-nav"></div>
60+
</div><!-- top -->
61+
<div id="side-nav" class="ui-resizable side-nav-resizable">
62+
<div id="nav-tree">
63+
<div id="nav-tree-contents">
64+
<div id="nav-sync" class="sync"></div>
65+
</div>
66+
</div>
67+
<div id="splitbar" style="-moz-user-select:none;"
68+
class="ui-resizable-handle">
69+
</div>
70+
</div>
71+
<script type="text/javascript">
72+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
73+
$(document).ready(function(){initNavTree('ar__interaction_8hpp.html',''); initResizable(); });
74+
/* @license-end */
75+
</script>
76+
<div id="doc-content">
77+
<!-- window showing the filter options -->
78+
<div id="MSearchSelectWindow"
79+
onmouseover="return searchBox.OnSearchSelectShow()"
80+
onmouseout="return searchBox.OnSearchSelectHide()"
81+
onkeydown="return searchBox.OnSearchSelectKey(event)">
82+
</div>
83+
84+
<!-- iframe showing the search results (closed by default) -->
85+
<div id="MSearchResultsWindow">
86+
<iframe src="javascript:void(0)" frameborder="0"
87+
name="MSearchResults" id="MSearchResults">
88+
</iframe>
89+
</div>
90+
91+
<div class="header">
92+
<div class="summary">
93+
<a href="#nested-classes">Classes</a> </div>
94+
<div class="headertitle">
95+
<div class="title">ar_interaction.hpp File Reference</div> </div>
96+
</div><!--header-->
97+
<div class="contents">
98+
<div class="textblock"><code>#include &lt;cmath&gt;</code><br />
99+
<code>#include &quot;Common/Float.h&quot;</code><br />
100+
<code>#include &quot;Common/binary_tree.h&quot;</code><br />
101+
<code>#include &quot;<a class="el" href="changeover_8hpp_source.html">changeover.hpp</a>&quot;</code><br />
102+
<code>#include &quot;AR/force.h&quot;</code><br />
103+
<code>#include &quot;<a class="el" href="hard__ptcl_8hpp_source.html">hard_ptcl.hpp</a>&quot;</code><br />
104+
<code>#include &quot;Hermite/hermite_particle.h&quot;</code><br />
105+
<code>#include &quot;<a class="el" href="ar__perturber_8hpp_source.html">ar_perturber.hpp</a>&quot;</code><br />
106+
<code>#include &quot;<a class="el" href="two__body__tide_8hpp_source.html">two_body_tide.hpp</a>&quot;</code><br />
107+
</div><div class="textblock"><div class="dynheader">
108+
Include dependency graph for ar_interaction.hpp:</div>
109+
<div class="dyncontent">
110+
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="ar__interaction_8hpp__incl.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
111+
</div>
112+
</div><div class="textblock"><div class="dynheader">
113+
This graph shows which files directly or indirectly include this file:</div>
114+
<div class="dyncontent">
115+
<div class="center"><iframe scrolling="no" frameborder="0" src="ar__interaction_8hpp__dep__incl.svg" width="379" height="262"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
116+
</div>
117+
</div>
118+
<p><a href="ar__interaction_8hpp_source.html">Go to the source code of this file.</a></p>
119+
<table class="memberdecls">
120+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
121+
Classes</h2></td></tr>
122+
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classARInteraction.html">ARInteraction</a></td></tr>
123+
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">AR interaction clas. <a href="classARInteraction.html#details">More...</a><br /></td></tr>
124+
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
125+
</table>
126+
</div><!-- contents -->
127+
</div><!-- doc-content -->
128+
<!-- start footer part -->
129+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
130+
<ul>
131+
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="ar__interaction_8hpp.html">ar_interaction.hpp</a></li>
132+
<li class="footer">Generated by
133+
<a href="http://www.doxygen.org/index.html">
134+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.17 </li>
135+
</ul>
136+
</div>
137+
</body>
138+
</html>

‎doc/html/ar__interaction_8hpp__dep__incl.map‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<map id="ar_interaction.hpp" name="ar_interaction.hpp">
2+
<area shape="rect" id="node1" title=" " alt="" coords="141,5,281,32"/>
3+
<area shape="rect" id="node2" href="$hard_8hpp.html" title=" " alt="" coords="171,80,250,107"/>
4+
<area shape="rect" id="node3" href="$hard__debug_8cxx.html" title=" " alt="" coords="5,155,131,181"/>
5+
<area shape="rect" id="node4" href="$hard__test_8cxx.html" title=" " alt="" coords="155,155,266,181"/>
6+
<area shape="rect" id="node5" href="$petar_8hpp.html" title=" " alt="" coords="291,155,373,181"/>
7+
<area shape="rect" id="node6" href="$main_8cc.html" title=" " alt="" coords="295,229,369,256"/>
8+
</map>

‎doc/html/ar__interaction_8hpp__dep__incl.md5‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
b63aa304e94fbfb2d63e97c87629b534

‎doc/html/ar__interaction_8hpp__dep__incl.svg‎

Lines changed: 97 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)