diff --git a/Doc/newdoc/rst/GeneratingMassProfiles.rst b/Doc/newdoc/rst/GeneratingMassProfiles.rst new file mode 100644 index 0000000..ef209f3 --- /dev/null +++ b/Doc/newdoc/rst/GeneratingMassProfiles.rst @@ -0,0 +1,120 @@ +Generating mass profiles +********************** + +A serie of routines dedictated to the generation of mass profiles +are provided by the ``ic`` module. + +They can be devided according to their geometry: + +.. table:: cubic distribution + + =============== =============== + function name description + =============== =============== + box particles in a box + =============== =============== + + + +.. table:: axi-symetrical (disk) distribution + + =============== =============== + function name description + =============== =============== + homodisk + kuzmin + expd + miyamoto_nagai + =============== =============== + + + + + +.. table:: spherical distribution + + =============== =============== + function name description + =============== =============== + homosphere + plummer + nfw + hernquist + dl2 + isothm + pisothm + shell + burkert + nfwg + generic2c + generic_alpha + generic_Mr + =============== =============== + +Finally, some routines generate special object used +for rendering: + +.. table:: special objects + + =============== =============== + function name description + =============== =============== + line + square + circle + grid + cube + sphere + =============== =============== + + +Each of these routines returns an **Nbody** object. + + +Examples: +-------- + + >>> from pNbody import ic + >>> nb=ic.box(1000,1,1,1) + >>> nb.info() + ----------------------------------- + particle file : ['box.dat'] + ftype : 'Nbody_binary' + mxntpe : 6 + nbody : 1000 + nbody_tot : 1000 + npart : [1000, 0, 0, 0, 0, 0] + npart_tot : [1000, 0, 0, 0, 0, 0] + mass_tot : 0.9999907 + byteorder : 'little' + pio : 'no' + len pos : 1000 + pos[0] : array([ 0.78348911, 0.03045347, 0.34180355], dtype=float32) + pos[-1] : array([ 0.14677997, -0.05187676, 0.11189017], dtype=float32) + len vel : 1000 + vel[0] : array([ 0., 0., 0.], dtype=float32) + vel[-1] : array([ 0., 0., 0.], dtype=float32) + len mass : 1000 + mass[0] : 0.001 + mass[-1] : 0.001 + len num : 1000 + num[0] : 0 + num[-1] : 999 + len tpe : 1000 + tpe[0] : 0 + tpe[-1] : 0 + tnow : 0.0 + label : binary + dt : 0.0 + >>> + >>> nb.display() + + +here, we need a complex example using a grid. + + + + + + + diff --git a/Doc/newdoc/rst/GeneratingVelocities.rst b/Doc/newdoc/rst/GeneratingVelocities.rst new file mode 100644 index 0000000..0729c45 --- /dev/null +++ b/Doc/newdoc/rst/GeneratingVelocities.rst @@ -0,0 +1,2 @@ +Generating velocities +**********************