This page was created by the IDL library routine
make_html_help. For more information on
this routine, refer to the IDL Online Help Navigator
or type:
? make_html_help
at the IDL command line prompt.
Last modified: Wed May 20 22:19:23 1998.
NAME:
PURPOSE:
CATEGORY:
CALLING SEQUENCE:
INPUTS:
KEYWORD PARAMETERS:
OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
NOTES:
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/read_grp_id.pro)
NAME:
EVOLVE_MOVIE
PURPOSE:
Make a movie of an N-body simulation.
CATEGORY:
Nbody/plots
CALLING SEQUENCE:
evolve_movie,files
INPUTS:
files -- A list of the files containing particle in
positions.
KEYWORD PARAMETERS:
/T3D -- Make a 3d plot, including a frame box.
GIF_TOO -- String containing base name to use for in
making GIF files for the movie images.
Files are named base.nnnn.gif, where
nnnn is the frame number.
Default is '', no gif files.
/NO_XINTERANIMATE -- Set this if you do NOT want to
create the movie in XINTERANIMATE (i.e.
you want GIFs only).
KEEPERS -- Set to the indices of the particle to in
plot in each timestep. Default is to
plot all, but see also FRACTION.
FRACTION -- Set to the fraction of particles in each in
time step to keep. If KEEPERS is also set,
the particles in there wil also be plotted.
/HELP -- Display useful message and exit.
OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
NOTES:
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/evolve_movie.pro)
NAME:
EVOLVE_MOVIE
PURPOSE:
Make a movie of an N-body simulation.
CATEGORY:
Nbody/plots
CALLING SEQUENCE:
evolve_movie,files
INPUTS:
files -- A list of the files containing particle in
positions.
KEYWORD PARAMETERS:
/T3D -- Make a 3d plot, including a frame box.
GIF_TOO -- String containing base name to use for in
making GIF files for the movie images.
Files are named base.nnnn.gif, where
nnnn is the frame number.
Default is '', no gif files.
/NO_XINTERANIMATE -- Set this if you do NOT want to
create the movie in XINTERANIMATE (i.e.
you want GIFs only).
KEEPERS -- Set to the indices of the particle to in
plot in each timestep. Default is to
plot all, but see also FRACTION.
FRACTION -- Set to the fraction of particles in each in
time step to keep. If KEEPERS is also set,
the particles in there wil also be plotted.
/HELP -- Display useful message and exit.
OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
NOTES:
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/evolve_phase.pro)
NAME:
MARK_READ
PURPOSE:
Read a file of potentials fgenerated by external force code.
CATEGORY:
Nbody/temp
CALLING SEQUENCE:
Markers = MARK_READ( File )
INPUTS:
File -- Name of the file to be read.
KEYWORD PARAMETERS:
HEADER -- Set to named variable to receive structure out
containing file headers.
OUTPUTS:
Markers -- Array of grid markers.
COMMON BLOCKS:
SIDE EFFECTS:
Temporarily uses a file LUN.
NOTES:
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/mark_read.pro)
NAME:
READ_GRAPE3A_FILE
PURPOSE:
Read a file in the grape3a output format and return an
associated array containing the data.
CATEGORY:
Nbody/berk_io
CALLING SEQUENCE:
DataStruc = read_grape3a_file( FileName )
INPUTS:
FileName -- Name of the file to be read. in
KEYWORD PARAMETERS:
NRECS -- Set to named variable to receive number of output in
records contained in FileName.
FILE_LUN -- Set to named variable to receive LUN associated in
with the file being read.
OUTPUTS:
DataStruc -- An associated variable containing the data read
in. See Notes below for details.
COMMON BLOCKS:
SIDE EFFECTS:
A LUN is allocated.
NOTES:
Each element of the associated variable DataStruc is a
structure. The structure contains the following tags:
N_Part -- number of particles
N_Dim -- Number of dimensions
Time -- Time of the output
Mass -- Array fltarr(N_Part) containing particle
masses.
X -- Array fltarr(2, N_Part) containing particle
positions.
V -- Array fltarr(3, N_Part) containing particle
velocities.
Poten -- Array fltarr(N_Part) containing particle
potential energy of each particle.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/read_grape3a_file.pro)
NAME:
READ_GROUP_FILE
PURPOSE:
Read a file containing group information.
CATEGORY:
nbody/berk_io
CALLING SEQUENCE:
GroupInfo = read_group_file( FileName )
INPUTS:
FileName -- Name of the file to read. in
KEYWORD PARAMETERS:
/HELP -- Print a help message and exit.
All of the following keywords should be set to a
named variable to receive the info described.
NGROUPS -- Number of groups. out
NPART -- Number of particles in file from out
which grouops were drawn.
GRPID -- List of group membership for each out
particle. Negative means that
particle is also most bound.
Vector with NPART elements.
POSMB -- Position of most bound particle in out
group. Most bound really means
particle with most negative
potential.
3 X NGROUPS array.
POSCOM -- Center of mass of the group, may out
not include all group member in COM.
3 X NGROUPS array.
COV -- Mean velocity of the group, out
3 X NGROUPS array.
GROUP_MASS -- Mass (in number of particles) of out
each group.
Vecotr with NGROUPS elements.
GROUP_SIZES -- Radial extent of group. May be out
distance of furthest particle from
most bound particle or virial radius
depending on group finder.
Vector with NRGOUPS elements.
ISVIRIAL -- If nonzero, groups were found by out
including all particles within
overdensity ISVIRIAL of center.
Zero means groups not identified this
way.
LINKLEN -- Linking length used if FoF groups. out
Specified as fraction of mean
interparticle spacing.
MIN_GRP_MASS - Minimum mass of a group, in number out
of particles.
SPECIES -- Species number of the particles from out
which the groups were made.
DATA_FILE_NAME -- Name of the file with position out
and velocity data from which the
group file was created.
OUTPUTS:
GroupInfo -- A two-dimensional array, out
NGroups X Ncols containing NCols
vectors of information about NGroups
groups.
COMMON BLOCKS:
SIDE EFFECTS:
Temporarily uses a file unit.
NOTES:
Not all of the information you obtain from here is
necessarily useful.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/read_group_file.pro)
NAME:
READ_GROUP_INFO
PURPOSE:
Read the information in an ASCII group file output by the
local group finder.
CATEGORY:
specialized file I/O
CALLING SEQUENCE:
GroupInfo = read_group_info( FileName )
INPUTS:
FileName -- Name of the file to read. in
KEYWORD PARAMETERS:
/HEADERS -- Print a brief description of each
of the items in the GroupInfo array.
/HELP -- Print a help message and exit.
OUTPUTS:
GroupInfo -- A two-dimensional array, out
NGroups X Ncols containing NCols
vectors of information about NGroups
groups.
COMMON BLOCKS:
SIDE EFFECTS:
Temporarily uses a file unit.
NOTES:
The information contained in GroupInfo is subject to change if
the output format of the group finder is changed.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id: read_group_info.pro,v 1.1 1996/05/29 23:05:04 mcraig Exp mcraig $
$Log: read_group_info.pro,v $
Revision 1.1 1996/05/29 23:05:04 mcraig
Initial revision
RELEASE:
$Name: $
(See /deep0/marc/idlshare/Nbody/io/read_group_info.pro)
NAME:
READ_GROUP_INFO_ASCII
PURPOSE:
Read the information in an ASCII group file output by the
local group finder.
CATEGORY:
specialized file I/O
CALLING SEQUENCE:
GroupInfo = read_group_info_ascii( FileName )
INPUTS:
FileName -- Name of the file to read. in
KEYWORD PARAMETERS:
/HEADERS -- Print a brief description of each
of the items in the GroupInfo array.
/HELP -- Print a help message and exit.
OUTPUTS:
GroupInfo -- A two-dimensional array, out
NGroups X Ncols containing NCols
vectors of information about NGroups
groups.
COMMON BLOCKS:
SIDE EFFECTS:
Temporarily uses a file unit.
NOTES:
Not intended to be used directly by the user.
Provided only for backwards compatibility with old
group finder output format.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id: read_group_info.pro,v 1.1 1996/05/29 23:05:04 mcraig Exp mcraig $
$Log: read_group_info.pro,v $
Revision 1.1 1996/05/29 23:05:04 mcraig
Initial revision
RELEASE:
$Name: $
(See /deep0/marc/idlshare/Nbody/io/read_group_info.pro)
NAME:
READ_P3M_AL_FILE
PURPOSE:
Read in a position/velocity file in the P3MG3A AL output
format.
CATEGORY:
NBody/berk-io
CALLING SEQUENCE:
read_p3m_al_file, file
INPUTS:
file -- Name of the P3MG3A AL file to be read. in
KEYWORD PARAMETERS:
POSITIONS -- Set to named variable to receive the out
positions read in.
/NO_POS -- Set this keyword to prevent reading
of positions. This helps reduce memory
use.
PHYS_POS -- The factor by which the returned out
positions must be multiplied to put
them into physical (NOT comoving)
units (Mpc)
VELOCITIES -- Set to named variable to receive the out
velocities read in.
PHYS_VEL -- The factor by which the returned out
velocities must be multiplied to put
them into physical units (km/sec).
/NO_VEL -- Set this keyword to suppress reading
of positions. This helps reduce memory
use.
SPECIES -- The number of the species to read. in
Default is 1.
PART_MASS -- Set to named variable to receive out
particle mass (M_sun).
REDSHIFT -- Set to named variable to receive the out
redshift for this output.
EXPANSION -- Set to a named variable to receive the out
current value of the expansion relative
to the beginning of the simulation.
TIME -- Set to a named variable to receive the out
time for this output.
HUBBLE -- Set to named variable to receive the out
Hubble constant in code units.
PHYSHUBBLE -- Set to named variable to receive the out
Hubble constant in km/sec/Mpc.
COMOVEBOX -- Set to named variable to receive the out
size of the computational box.
Units are COMOVING Mpc.
BOXSIZE -- Set to named variable to receive the out
size of the computational box.
Units are the same as POSITIONS.
PERIOD -- Set to named variable to receive the out
period of the computational box.
Units are same as POSITIONS.
Period of zero means nonperiodic box.
NPART -- Set to named variable to receive out
number of particles read in.
/HELP -- Set this keyword to read a useful help
message.
OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
NOTES:
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id: read_p3m_al_file.pro,v 1.1 1996/05/22 16:19:49 mcraig Exp mcraig $
$Log: read_p3m_al_file.pro,v $
Revision 1.1 1996/05/22 16:19:49 mcraig
Initial revision
RELEASE:
$Name: $
(See /deep0/marc/idlshare/Nbody/io/read_p3m_al_file.pro)
NAME:
READ_P3M_QUICK
PURPOSE:
Quickly and simply read in positions and velocities from a
p3mg3a file.
CATEGORY:
Nbody/berk_io
CALLING SEQUENCE:
read_p3m_quick, InpFile, X, Y, Z, Vx, Vy, Vz
INPUTS:
InpFile -- Name of file contatining positions.
KEYWORD PARAMETERS:
OUTPUTS:
X, Y, Z -- X, y, z, positions of particles, in
COMOVING units (Mpc).
Vx, Vy, Vz -- X, y, z, proper peculiar velocities, in
PHYSICAL units (km/sec).
COMMON BLOCKS:
SIDE EFFECTS:
NOTES:
Positions are returned in comoving units (Mpc).
Velocities are returned as proper peculiar velocities,
in km/sec.
EXAMPLE:
read_p3m_quick, 'p4m.007', x, y, z, vx, vy, vz
Reads positions and velocities from the file 'p4m.007'.
LIBRARY FUNCTIONS CALLED:
read_p3m_al_file
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/read_p3m_quick.pro)
NAME:
SETUP_INIT_GROUP
PURPOSE:
Set up initial conditions for simple isolated halo runs on the
GRAPE.
CATEGORY:
Nbody/berk_io
CALLING SEQUENCE:
setup_init_group, GrpFile, GrpNum, InitFile, OutFile, InitTime
INPUTS:
GrpFile -- Name of the file containing information about in
the groups found at the end of the simulation.
GrpNum -- Number of the group which is to be resimulated. in
InitFile -- Name of the file containing initial positions in
and velocities of particles in the simulation.
OutFile -- Name of the file to be created containing in
initial conditions.
InitTime -- Set to the inital time to be put into the [in]
initial conditions file. Default is 0.0.
KEYWORD PARAMETERS:
/INIT_SPHERE -- Select all particles within the the sphere
containing all of the particles in the group
initially.
/INIT_NUM -- Select all particles within a sphere of radius
such that the number of particles in the
sphere is the same as that in the final
group.
INIT_GROUP -- Set to named variable to recieve the indices
of the particles which are written into the
intial conditions file.
OUTPUTS:
COMMON BLOCKS:
SIDE EFFECTS:
Makes the file OutFile.
NOTES:
The default bahaviour is to select out all of those particles
which have been identified as being in group GrpNum by the
group finder, as recorded in GrpFile. The /INIT_SPHERE option
allows one to instead select all particle in the sphere which
contains the inital positions of all of the particles which
end up in the group; this is a substantially larger number of
particles.
Units:
Positions are output in physical units.
Velocities are also in physical units, and are the sum of
proper peculiar velocities and Hubble velocity, with the
origin taken to be the center of mass of the initial
positions of the particles in the group GrpNum.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id: setup_init_group.pro,v 1.1 1996/07/30 18:33:47 mcraig Exp mcraig $
$Log: setup_init_group.pro,v $
Revision 1.1 1996/07/30 18:33:47 mcraig
Initial revision
RELEASE:
$Name: $
(See /deep0/marc/idlshare/Nbody/io/setup_init_group.pro)
NAME:
WRITE_GROUP_FILE
PURPOSE:
Read a file containing group information.
CATEGORY:
nbody/berk_io
CALLING SEQUENCE:
GroupInfo = write_group_file( FileName )
INPUTS:
FileName -- Name of the file to write. in
KEYWORD PARAMETERS:
/HELP -- Print a help message and exit.
All of the following keywords should contain the
information described. They are NOT optional.
NGROUPS -- Number of groups. out
NPART -- Number of particles in file from out
which grouops were drawn.
GRPID -- List of group membership for each out
particle. Negative means that
particle is also most bound.
Vector with NPART elements.
POSMB -- Position of most bound particle in out
group. Most bound really means
particle with most negative
potential.
3 X NGROUPS array.
POSCOM -- Center of mass of the group, may out
not include all group member in COM.
3 X NGROUPS array.
COV -- Mean velocity of the group, out
3 X NGROUPS array.
GROUP_MASS -- Mass (in number of particles) of out
each group.
Vecotr with NGROUPS elements.
GROUP_SIZES -- Radial extent of group. May be out
distance of furthest particle from
most bound particle or virial radius
depending on group finder.
Vector with NRGOUPS elements.
ISVIRIAL -- If nonzero, groups were found by out
including all particles within
overdensity ISVIRIAL of center.
Zero means groups not identified this
way.
LINKLEN -- Linking length used if FoF groups. out
Specified as fraction of mean
interparticle spacing.
MIN_GRP_MASS - Minimum mass of a group, in number out
of particles.
SPECIES -- Species number of the particles from out
which the groups were made.
OUTPUTS:
GroupInfo -- A two-dimensional array, out
NGroups X Ncols containing NCols
vectors of information about NGroups
groups.
COMMON BLOCKS:
SIDE EFFECTS:
Temporarily uses a file unit.
NOTES:
Not all of the information you obtain from here is
necessarily useful.
EXAMPLE:
LIBRARY FUNCTIONS CALLED:
MODIFICATION HISTORY:
$Id$
$Log$
RELEASE:
$Name$
(See /deep0/marc/idlshare/Nbody/io/write_group_file.pro)