Commit 8165d781 authored by LAMBERT Jean-charles's avatar LAMBERT Jean-charles

new manuals

parent 1c23e4cc
.TH uns_addgravity "March 17, 2020"
.SH name
uns_addgravity \- adds gravity to a snapshot; using falcON (public version)
.SH synopsis
\fBuns_addgravity\fP [parameter=value]
.SH description
\fBuns_addgravity\fP it's based on addgravity program by Walter Dehnen
(WD). It uses Walter Dehnen's force algorithm of complexity
O(N) (\fBfalcON\fP), to add the gravitational potential and
accelerations to an \fBUNS snapshots\fP.
.SH parameters
.TP 12
\fBin=\fP\fIfile\fP
Input snapshots are read from \fIfile\fP, which must an UNS
snapshot format (NEMO, Gadget1/2/3, Ramses, etc..). If \fIfile\fP=-, input is expected from stdin,
useful for piping data from another program. Default: \fBrequired\fP
.TP
\fBout=\fP\fIfile\fP
Snapshots are written in NEMO snapshot format to \fIfile\fP with same
body data as the input plus acceleration and potential. Default:
\fBrequired\fP.
.TP
\fBselect=\fP\fIselect-particles\fP
Select particles. Set of particles must be selected using the ":" range operator, separated by a comma.
E.g. select=0:9,10:19 would select two sets of 10 particles, or by
component (gas,halo,stars,bulge,disk,bndry) for Gadget/Ramses
files. E.g. select=gas,stars . Default: \fIrequired\fP.
.TP
\fBtimes=\fP\fItime range(s)\fP
Range(s) of simulation times, for which snapshots shall be processed.
Default: \fBall\fP.
.TP
\fBeps=\fP\fIval\fP
The (globally constant) softening length is set to \fIval\fP. For
details, see documentation in the user guide. Default: \fB0.05\fP.
.TP
\fBkernel=\fP\fInum\fP
The softening kernel is taken to be the P\fInum\fP kernel (see the
documentation in the user guide). Default: \fB1\fP.
.TP
\fBtheta=\fP\fIval\fP
The tolerance parameter for \fBfalcON\fP is set to \fIval\fP. It is
recommended to stick to the default or smaller value, but see the
discussion in the \fBfalcON\fP user guide Default: \fB0.6\fP.
.TP
\fBncrit=\fP\fInum\fP
In building the tree, a cell containg \fInum\fP bodies or less is not
splitted. Default: \fB6\fP.
.TP
\fBfirst=\fP\fIboolean\fP
if true, add a trailing number to the first output file [f]
.TP
\fBoffset=\fP\fItime offset\fP
+/- time offset between two consecutives snapshots [0.01]
.TP
\fBverbose=\fP\fIflag\fP
If true, give some verbose output [t].
.SH see also
addgravity(1falcON) gyrfalcON(1falcON), getgravity(1falcON)
.TP
https://projets.lam.fr/projects/unsio/wiki
.PP
.nf
Dehnen, W., 2000, ApJ, 536, L39
Dehnen, W., 2002, JCP, 179, 27
.fi
.SH files
.ta +3i
.nf
falcON/doc/user_guide.pdf \fIUser Guide for falcON\fP
.fi
.SH author
.nf
Jean-Charles LAMBERT
.SH update history of this man page
.nf
.ta +1.0i +2.0i
17-Mar-20 first version of manual JCL
.fi
.TH uns_density 1NEMO "March 17, 2020"
.SH NAME
uns_density \- estimate mass density based on distance to Kth neighbour, add distance to the kth neighbours
.SH SYNOPSIS
\fBuns_density in=\fPin_file \fBout=\fPout_file [parameter=value] .\|.\|.
.SH DESCRIPTION
\fIuns_density\fP reads a compatible UNS snapshot, estimate mass
density based on distance to Kth neighbour, add distance to the kth
neighbours, and save it in a NEMO format file. It computes very
quickly density by using falcON library from Walter Dehnen (WD). It works
like density program (WD) but accepts UNS input snapshot, plus 2
differents method to estimate density, making it more versatile.
.SH PARAMETERS
The following parameters are recognized.
.TP 24
\fBin=\fP\fIuns input file snapshot\fP
give as input a compatible UNS file snapshot (Nemo, Gadget, Ramses...)
Default: \fIrequired\fP.
.TP
\fBout=\fP\fIout_file\fP
Output NEMO file name. You can give a filename or "-" (to pipe with
another NEMO program). Default: \fIrequired\fP.
.TP
\fBselect=\fP\fIselect-particles\fP
Select particles. Set of particles must be selected using the ":" range operator, separated by a comma.
E.g. select=0:9,10:19 would select two sets of 10 particles, or by
component (gas,halo,stars,bulge,disk,bndry) for Gadget/Ramses
files. E.g. select=gas,stars . Default: \fIrequired\fP.
.TP
\fBm=\fP\fImethod\fP
select method to approximate density, 0:used by density program (WD),
1:used by hackdens program [0]
.TP
\fBK=\fP\fInumber of neighbours\fP
select number of neighbours to approximate density [32]
.TP
\fBN=\fP\fIorder\fP
order of Ferrers kernel [1]
.TP
\fBncrit=\fP\fvalue\fP
ncrit value, if empty=max(1,K/4) []
.TP
\fBtimes=\fP\fItime-range\fP
Select time [all]
.TP
\fBfirst=\fP\fIboolean\fP
if true, add a trailing number to the first output file [f]
.TP
\fBoffset=\fP\fItime offset\fP
+/- time offset between two consecutives snapshots [0.01]
.TP
\fBverbose=\fP\fIflag\fP
If true, give some verbose output [t].
.TP
.SH SEE ALSO
falcON(1falcON), hackdens(1NEMO), uns_projects(1NEMO), snapshot(5NEMO)
.TP
https://projets.lam.fr/projects/unsio/wiki
.SH AUTHOR
Jean-Charles LAMBERT
.SH HISTORY
.nf
.ta +1i +4i
17-Mar-20 V2.0 manual created JCL
.fi
.TH uns_info 1NEMO "March 17, 2020"
.SH NAME
uns_info \- Print information about UNS snapshot file like tsf nemo programs
.SH SYNOPSIS
\fBuns_info in=\fPin_file [parameter=value] .\|.\|.
.SH DESCRIPTION
\fIuns_info\fP reads a compatible UNS snapshot and print
information of its content.
.SH PARAMETERS
The following parameters are recognized.
.TP 24
\fBin=\fP\fIuns input file snapshot\fP
give as input a compatible UNS file snapshot (Nemo, Gadget, Ramses...)
Default: \fIrequired\fP.
.TP
\fBselect=\fP\fIselect-particles\fP
Select particles. Set of particles must be selected using the ":" range operator, separated by a comma.
E.g. select=0:9,10:19 would select two sets of 10 particles, or by
component (gas,halo,stars,bulge,disk,bndry) for Gadget/Ramses
files. E.g. select=gas,stars
[all]
.TP
\fBdisplay=\fP\fIboolean\fP
if true display first elements of arrays, nbody otherwise [t]
.TP
\fBbits=\fP\fIsring\fP
select which physical quantities to display. Here is the list of differents
values:
'm' mass
'x' position
'v' velolcity
'p' potential
'a' acceleration
'e' softening
'k' keys array (from nemo)
'X' aux array (from nemo)
'R' density
'I' particles's Id
'U' Internal energy
'M' metallicity
'A' stars's age
'H' hsml
'T' temperature
ex: bits=mRH will display positions, densities and hsml if they exist
(see also :
https://projets.lam.fr/projects/unsio/wiki/UnsioVariablesUtilisation#How-to-select-data-at-loading)
[all]
.TP
\fBfloat=\fP\fIboolean\fP
use true to display in float format, or false to display in
double [t]
.TP
\fBmaxline=\fP\fIinteger\fP
diplay # max lines per components [2]
.TP
\fBtimes=\fP\fItime-range\fP
Select time [all]
.TP
\fBverbose=\fP\fIflag\fP
If true, give some verbose output [t].
.TP
.SH SEE ALSO
tsf(1NEMO), uns_projects(1NEMO), snapshot(5NEMO)
.TP
https://projets.lam.fr/projects/unsio/wiki
.SH AUTHOR
Jean-Charles LAMBERT
.SH HISTORY
.nf
.ta +1i +4i
17-Mar-20 V2.2 manual created JCL
.fi
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment