Skip to content

Commit

Permalink
Merge branch 'master' of https://github.com/teuben/nemo
Browse files Browse the repository at this point in the history
  • Loading branch information
@teuben
teuben committed Dec 25, 2023
2 parents 8768814 + 2094869 commit 4898fe2
Show file tree
Hide file tree
Showing 23 changed files with 695 additions and 513 deletions.
1 change: 1 addition & 0 deletions docs/man_html/bench.5.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ <h2><a name='sect3' href='#toc3'>Nemobench5</a></h2>
i7-1185G7<tt> </tt>&nbsp;<tt> </tt>&nbsp;1060<tt> </tt>&nbsp;<tt> </tt>&nbsp;Dell Latitude 5420
i5-1135G7<tt> </tt>&nbsp;<tt> </tt>&nbsp;1000<tt> </tt>&nbsp;<tt> </tt>&nbsp;XPS13 1460 /
AMD threadripper 3960x<tt> </tt>&nbsp;<tt> </tt>&nbsp;896<tt> </tt>&nbsp;<tt> </tt>&nbsp;AlexBox
AMD Ryzen 7 5800H<tt> </tt>&nbsp;<tt> </tt>&nbsp;891<tt> </tt>&nbsp;<tt> </tt>&nbsp;beelink
i5-10400H<tt> </tt>&nbsp;<tt> </tt>&nbsp;700<tt> </tt>&nbsp;<tt> </tt>&nbsp;Dell Precision 3351 (astroumd)
AMD EPYC 7302 @ 3.0GHz<tt> </tt>&nbsp;<tt> </tt>&nbsp;630<tt> </tt>&nbsp;<tt> </tt>&nbsp;lma 1000/ 28000
Intel Core i9-9900X<tt> </tt>&nbsp;<tt> </tt>&nbsp;-<tt> </tt>&nbsp;<tt> </tt>&nbsp;geminid 1214 / 9467
Expand Down
2 changes: 1 addition & 1 deletion docs/man_html/bibcode.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ <H1>NEMO BIBCODE Manual Reference </H1>
is located in NEMO. For some codes that do not have a manual page,
the source code file will be mentioned.
<P>
Created on: Sun Dec 24 11:13:10 EST 2023 by teuben@DL5420(none)<P>
Created on: Sun Dec 24 11:35:31 PM EST 2023 by teuben@k2(none)<P>
<!-- Created by ./make_bibcode.csh - do not edit -->
<DIR COMPACT>
<TABLE BORDER>
Expand Down
110 changes: 61 additions & 49 deletions docs/man_html/hackcode1.1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,14 @@
HTML automatically generated with <A HREF=http://manpages.ubuntu.com/manpages/bionic/man1/rman.1.html>rman</A><br>
<a href='#toc'>Table of Contents</a><p>

<p>
<h2><a name='sect0' href='#toc0'>Name</a></h2>
hackcode1, hackcode1_qp - hierarchical N-body code
<p>
<h2><a name='sect1' href='#toc1'>Synopsis</a></h2>
<b>hackcode1</b>
[<i>parameter</i>=<i>value</i>] ...
<p>
<h2><a name='sect2' href='#toc2'>Description</a></h2>
<i>hackcode1</i> is an equal-timestep implementation
of a hierarchical N-body code (J. Barnes and P. Hut, <i>Nature</i> <b>324</b>, 446). It uses
Expand All @@ -26,73 +29,75 @@ <h2><a name='sect2' href='#toc2'>Description</a></h2>
A special program, <a href='snapdiagplot.1.html'><i>snapdiagplot(1NEMO)</i></i></b></a>

can be used to monitor conservation of energy and momentum.
<p>
<h2><a name='sect3' href='#toc3'>Parameters</a></h2>
The
following parameters are recognized; they may be given in any order.

The following parameters are recognized in order; they may be given in
any order if the keyword is also given. Use <b>--help</b> to confirm this man page
is up to date.
<dl>

<dt><b>in=</b><i>in-file</i>
</dt>
<dd>If given, initial conditions will be read from <i>in-file</i> in snapshot format.
At most one of <b>in</b>, <b>restart</b>, or <b>continue</b> may be specified. </dd>
<dt><b>in=</b><i>in-file</i> </dt>
<dd>If given, initial conditions will be read from
<i>in-file</i> in snapshot format. At most one of <b>in</b>, <b>restart</b>, or <b>continue</b> may be
specified. </dd>

<dt><b>out=</b><i>out-file</i> </dt>
<dd>If
given, results are written to <i>out-file</i> in snapshot format. </dd>
<dd>If given, results are written to <i>out-file</i> in snapshot
format. </dd>

<dt><b>restart=</b><i>state-file</i>
</dt>
<dd>If given, the system state will be read from <i>state-file</i>. New values are accepted
for the following parameters: <b>out</b>, <b>save</b>, <b>eps</b>, <b>tol</b>, <b>options</b>, <b>fcells</b>, <b>tstop</b>,
<b>freqout</b>, <b>minor_freqout</b>, and <b>debug</b>. At most one of <b>in</b>, <b>restart</b>, or <b>continue</b>
may be specified. </dd>
<dt><b>restart=</b><i>state-file</i> </dt>
<dd>If given, the system state will be read from <i>state-file</i>.
New values are accepted for the following parameters: <b>out</b>, <b>save</b>, <b>eps</b>, <b>tol</b>,
<b>options</b>, <b>fcells</b>, <b>tstop</b>, <b>freqout</b>, <b>minor_freqout</b>, and <b>debug</b>. At most one of
<b>in</b>, <b>restart</b>, or <b>continue</b> may be specified. </dd>

<dt><b>continue=</b><i>state-file</i> </dt>
<dd>If given, the system state will be
read from <i>state-file</i>. New values are accepted for the following parameters:
<b>out</b>, <b>save</b>, and <b>debug</b>. At most one of <b>in</b>, <b>restart</b>, or <b>continue</b> may be specified.
</dd>
<dd>If given,
the system state will be read from <i>state-file</i>. New values are accepted for
the following parameters: <b>out</b>, <b>save</b>, and <b>debug</b>. At most one of <b>in</b>, <b>restart</b>,
or <b>continue</b> may be specified. </dd>

<dt><b>save=</b><i>state-file</i> </dt>
<dd>If given, the system state will be saved in <i>state-file</i> after
each timestep. </dd>
<dd>If given, the system state
will be saved in <i>state-file</i> after each timestep. </dd>

<dt><b>nbody=</b><i>nbody-value</i> </dt>
<dd>Number of bodies for test data, generated
only if none of <b>in</b>, <b>restart</b>, or <b>continue</b> are specified. Default is <b>128</b>. </dd>
<dd>Number
of bodies for test data, generated only if none of <b>in</b>, <b>restart</b>, or <b>continue</b>
are specified. Default is <b>128</b>. </dd>

<dt><b>seed=</b><i>random-seed</i>
</dt>
<dd>Random number seed used in generating initial conditions. Default is <b>123</b>.
</dd>
<dt><b>seed=</b><i>random-seed</i> </dt>
<dd>Random number seed used in
generating initial conditions. Default is <b>123</b>. </dd>

<dt><b>cencon=</b><i>cencon-flag</i> </dt>
<dd>If <b>true</b>, generate centrally concentrated test system.
Default is <b>false</b>. </dd>
<dd>If <b>true</b>,
generate centrally concentrated test system. Default is <b>false</b>. </dd>

<dt><b>freq=</b><i>integ-freq</i> </dt>
<dd>Inverse time-step, to be used with a leap-frog
integrator. Default is <b>32.0</b> (32 steps per unit time). </dd>
<dt><b>freq=</b><i>integ-freq</i>
</dt>
<dd>Inverse time-step, to be used with a leap-frog integrator. Default is <b>32.0</b>
(32 steps per unit time). </dd>

<dt><b>eps=</b><i>soft-length</i> </dt>
<dd>Force
softening parameter. Default is <b>0.05</b>. </dd>
<dd>Force softening parameter. Default
is <b>0.05</b>. </dd>

<dt><b>tol=</b><i>theta-value</i> </dt>
<dd>Opening-angle tolerence
parameter. Default is <b>1.0</b>. </dd>

<dt><b>fcells=</b><i>fcells-value</i> </dt>
<dd>Ratio of cells to bodies, used
when allocating cells. Default is <b>0.75</b>. </dd>

<dt><b>options=</b><i>option-string</i> </dt>
<dd>Miscellaneous
control options, specified as a comma-separated list of keywords. Currently
recognized keywords are: <b>reset_time</b>: when reading initial data, set <i>tnow</i>
to zero; <b>new_tout</b>: when restarting, set new output times; <b>mass</b>, <b>phi</b>, <b>acc</b>:
output mass, potential, acceleration data with major data outputs. The phase
space coordinates are always output. It also seems that the reset_time
<dd>Opening-angle tolerence parameter. Default is <b>1.0</b>. </dd>

<dt><b>fcells=</b><i>fcells-value</i>
</dt>
<dd>Ratio of cells to bodies, used when allocating cells. Default is <b>0.75</b>. </dd>

<dt><b>options=</b><i>option-string</i>
</dt>
<dd>Miscellaneous control options, specified as a comma-separated list of keywords.
Currently recognized keywords are: <b>reset_time</b>: when reading initial data,
set <i>tnow</i> to zero; <b>new_tout</b>: when restarting, set new output times; <b>mass</b>,
<b>phi</b>, <b>acc</b>: output mass, potential, acceleration data with major data outputs.
The phase space coordinates are always output. It also seems that the reset_time
and new_tout options have not been implemented yet. Default: <b>mass,phase</b>.
</dd>

Expand Down Expand Up @@ -125,7 +130,7 @@ <h2><a name='sect4' href='#toc4'>See Also</a></h2>
, <a href='gyrfalcON.1.html'>gyrfalcON(1NEMO)</a>
, <a href='snapdiagplot.1.html'>snapdiagplot(1NEMO)</a>
<br>
<pre>https://ui.adsabs.harvard.edu/abs/1986Natur.324..446B
<pre>Barnes &amp; Hut paper: https://ui.adsabs.harvard.edu/abs/1986Natur.324..446B
Appel, A. SIAM J. Sei. statist. Comput. 6, 85-103 (1985) https://doi.org/10.1137/0906008
</pre>
<p>
Expand Down Expand Up @@ -164,7 +169,14 @@ <h2><a name='sect7' href='#toc7'>Benchmark</a></h2>
<p>
<h2><a name='sect8' href='#toc8'>Caveats</a></h2>
Particles cannot occupy the same position, since building the treestructure
is done in integerized coordinates.
is done in integerized coordinates. <p>
This code is part of NEMOBENCH5 (see
<a href='bench.5.html'><i>bench(5NEMO)</i></a>
) and sometimes after a recompilation <b>hackcode1</b> shows a severe
underperformance. This is some kind of compilation bug, which can be resolved
by recompiling and running the test again, e.g.
<p> mknemo -t -T hackcode1<br>

<p>
<h2><a name='sect9' href='#toc9'>Author</a></h2>
Joshua E. Barnes.
Expand Down
110 changes: 108 additions & 2 deletions docs/man_html/henyey.1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,113 @@ <h2><a name='sect2' href='#toc2'>Description</a></h2>
The method has been used first by T.S. v. Albada &amp; R.H. Sanders (1982) MNRAS,
201, 303. For more details see also: Henyey et al.(1964) ApJ 139, 309 <p>
The
method originated from the same equations as looking for oscillations in
Cepheid type stars. See e.g. van Albada and Baker (1971)
method originated from the same equations as looking for solutions of pulsation
stars (RR Lyr, Cepheids). See e.g. van Albada and Baker (1971)
<p>
<h2><a name='sect3' href='#toc3'>Parameters</a></h2>

The following parameters are recognized in order; they may be given in
any order if the keyword is also given. Use <b>--help</b> to confirm this man page
is up to date.
<dl>

<dt><b>x0=</b> </dt>
<dd>Initial launching x coordinate [1] </dd>

<dt><b>y0=</b> </dt>
<dd>Initial launching
y coordinate [0] </dd>

<dt><b>u0=</b> </dt>
<dd>Initial launching u velocity [0] </dd>

<dt><b>v0=</b> </dt>
<dd>Initial launching
v velocity [1] </dd>

<dt><b>per=</b> </dt>
<dd>Period, corresponding to the orbit <b>type</b> [3] </dd>

<dt><b>type=</b>
</dt>
<dd>Type of orbit {1,2,3} referring to half, full or quarter orbit (in some
TDB order) [1] </dd>

<dt><b>ome=</b> </dt>
<dd>Pattern speed of potential [0] </dd>

<dt><b>norbit=</b> </dt>
<dd>Number of
extra orbits to compute [1] </dd>

<dt><b>step=</b> </dt>
<dd>Step to increase the non-zero (x or
y) position for extra orbits [0.1]
<p> </dd>
</dl>

<h2><a name='sect4' href='#toc4'>Examples</a></h2>

<p>
<p> # henyey:<br>
./henyey 0.6 0 0 1.9 1.0 1 0.0 0 &gt; bench1.log<br>
tabcomment bench1.log | tabplot - 3 4 -1 1 -1 1 line=1,1 yapp=1/xs<br>

<p> # perorb:<br>
perorb phase=0.6,0,0,0,1.89,0 dir=x potname=bar83 potpars=0,1,1,0.2,1
out=o2<br>
orbplot o2 xrange=-1:1 yrange=-1:1 yapp=2/xs<br>

<p>
<p>
<h2><a name='sect5' href='#toc5'>Caveats</a></h2>
For a bar-only model this code has been confirmed to produce
the same orbits as <a href='perorb.1.html'><i>perorb(1NEMO)</i></a>
. <p>
Unlike other NEMO orbit related programs,
the potential has been hard-coded. The corresponding Makefile makes it relatively
easy to plug in another potential. Parameters are passed through FORTRAN
common blocks, but again, hard-coded and not available via the command line
interface yet, with the exception of the pattern speed.
<p>
<h2><a name='sect6' href='#toc6'>See Also</a></h2>
<a href='perorb.1.html'>perorb(1NEMO)</a>

<br>
<pre>1964ApJ...139..306H - A New Method of Automatic Computation of Stellar Evolution.
1982MNRAS.201..303V - Periodic orbits and gas flow in barred spirals
</pre>
<p>
<h2><a name='sect7' href='#toc7'>Ads</a></h2>

<p> @ads 1982MNRAS.201..303V
<p>
<h2><a name='sect8' href='#toc8'>Author</a></h2>
Tjeerd van Albada, Peter Teuben (NEMO
adaptation)
<p>
<h2><a name='sect9' href='#toc9'>History</a></h2>
<br>
<pre>28-may-1979<tt> </tt>&nbsp;<tt> </tt>&nbsp;original version as SBORB<tt> </tt>&nbsp;<tt> </tt>&nbsp;TVA
1981? <tt> </tt>&nbsp;<tt> </tt>&nbsp;Cyber7600 version - sheltran<tt> </tt>&nbsp;<tt> </tt>&nbsp;PJT
xx-may-92<tt> </tt>&nbsp;<tt> </tt>&nbsp;V0.0 ported to NEMO <tt> </tt>&nbsp;<tt> </tt>&nbsp;PJT
xx-mar-03<tt> </tt>&nbsp;<tt> </tt>&nbsp;V0.01 .. and still working ..<tt> </tt>&nbsp;<tt> </tt>&nbsp;PJT
24-dec-2023<tt> </tt>&nbsp;<tt> </tt>&nbsp;V0.2 renumbered, cleanup, confirm perorb<tt> </tt>&nbsp;<tt> </tt>&nbsp;PJT
</pre><p>

<hr><p>
<a name='toc'><b>Table of Contents</b></a><p>
<ul>
<li><a name='toc0' href='#sect0'>Name</a></li>
<li><a name='toc1' href='#sect1'>Synopsis</a></li>
<li><a name='toc2' href='#sect2'>Description</a></li>
<li><a name='toc3' href='#sect3'>Parameters</a></li>
<li><a name='toc4' href='#sect4'>Examples</a></li>
<li><a name='toc5' href='#sect5'>Caveats</a></li>
<li><a name='toc6' href='#sect6'>See Also</a></li>
<li><a name='toc7' href='#sect7'>Ads</a></li>
<li><a name='toc8' href='#sect8'>Author</a></li>
<li><a name='toc9' href='#sect9'>History</a></li>
</ul>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/man_html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ <H1>Nemo Reference Manual</H1>
<LI> <A HREF=bibcode.html>bibcode</A> pages.
</UL>
<hr>
Automatically created by make_html on DL5420 Sun Dec 24 11:13:10 EST 2023 <P>
Automatically created by make_html on k2 Sun Dec 24 11:35:31 PM EST 2023 <P>
</BODY></HTML>
Loading

0 comments on commit 4898fe2

Please sign in to comment.