section h of routines in global.i

all functions - h

h_array


    name_array = h_array(f, ublk, name)  
 or pname_arrays = h_array(f, ublk, [name1,name2,...,nameN])  
    eq_nocopy, name_array1, *pname_arrays(1)  
    ...  
    eq_nocopy, name_arrayN, *pname_arrays(N)  


reads variable array NAME for user block UBLK from the hydra file F.    
If NAME=="matlist", you get the "Materials_matlist" array.  
Coordinates can be obtained using the names x, y or z.  
Ublk numbering starts at 0.  You can omit the UBLK argument and it  
will default to zero, which is useful for problems with only a single  
user block.  
Note that here zone centered arrays are given using the hydra convention  
so that i=imax, j=jmax, k=kmax are missing.  Thus in order to use the   
Yorick plc and plf functions correctly you should index the plotted  
variable i.e. for a 2D array.  
plf, den(1:-1,1:-1), y, x  
Interpreted function, defined at i/hydra.i   line 879

SEE ALSO: hydra_xyz, h_data, h_mix, h_show, h_collect

h_blocks


    gnblk = h_blocks(f, mdims, mlens)  


returns number of blocks GNBLK, block dimensions MDIMS, and  
block lengths MLENS for the hydra mesh in file F.  
MDIMS is 3-by-NBLK, MLENS is GNBLK elements.  
Interpreted function, defined at i/hydra.i   line 1191

SEE ALSO: window, fma, hcp, plg

hcp_finish


    filename= hcp_finish()  
 or filename= hcp_finish(n)  


closes the current hardcopy file and returns the filename.  
If N is specified, closes the hcp file associated with window N  
and returns its name; use hcp_finish(-1) to close the default  
hardcopy file.  
Builtin function, documented at i0/graph.i   line 132

SEE ALSO: window, fma, hcp, hcp_out, plg

hcp_out


    hcp_out  
 or hcp_out, n  


finishes the current hardcopy file and sends it to the printer.  
If N is specified, prints the hcp file associated with window N;  
use hcp_out,-1 to print the default hardcopy file.  
Unless the KEEP keyword is supplied and non-zero, the file will  
be deleted after it is processed by gist and sent to lpr.  
Interpreted function, defined at i0/graph.i   line 142

SEE ALSO: window, fma, hcp, hcp_finish, plg

hcpoff


    hcpoff  


Builtin function, documented at i0/graph.i   line 318

SEE hcp

hcpon


    hcpon  


Builtin function, documented at i0/graph.i   line 318

SEE hcp

hcps


    hcps, name  


writes the picture in the current graphics window to the  
PostScript file NAME+".ps" (i.e.- the suffix .ps is added to NAME).  
Legends are not written, but the palette is always dumped.  
Interpreted function, defined at i0/graph.i   line 163

SEE ALSO: hcps, window, fma, hcp, hcp_finish, plg

help


    help, topic  
 or help  


Prints DOCUMENT comment from include file in which the variable  
TOPIC was defined, followed by the line number and filename.  
By opening the file with a text editor, you may be able to find  
out more, especially if no DOCUMENT comment was found.  
Examples:  
  help, set_path  
prints the documentation for the set_path function.  
  help  
prints the DOCUMENT comment you are reading.  
This copy of Yorick was launched from the directory:  
**** Y_LAUNCH (computed at runtime) ****  
Yorick's "site directory" at this site is:  
**** Y_SITE (computed at runtime) ****  
You can find out a great deal more about Yorick by browsing  
through these directories.  Begin with the site directory,  
and pay careful attention to the subdirectories doc/ (which  
contains documentation relating to Yorick), and i/ and  
contrib/ (which contain many examples of Yorick programs).  
Look for files called README (or something similar) in any  
of these directories -- they are intended to assist browsers.  
The site directory itself contains std.i and graph.i, which  
are worth reading.  
Type:  
  help, dbexit  
for help on debug mode.  If your prompt is "dbug>" instead of  
">", dbexit will return you to normal mode.  
Type:  
  quit  
to quit Yorick.  
Builtin function, documented at i0/std.i   line 33

SEE ALSO: quit, info, print, copyright, warranty, legal

help_worker


    help_worker  


  
     Interpreted function, defined at i0/std.i   line 99

hex24b_track


    hex24b_track  


Builtin function, documented at i0/hex.i   line 40

SEE hex5_track

hex24f_track


    hex24f_track  


Builtin function, documented at i0/hex.i   line 40

SEE hex5_track

hex5_track


    c= hex5_track(mesh, rays, s)  
    c= hex24f_track(mesh, rays, s)  
    c= hex24b_track(mesh, rays, s)  


track 3 x Nrays x 2 RAYS through the 3D MESH.  RAYS(,,1) are  
points on the rays, while RAYS(,,2) are normalized ray directions.  
The c return value and the S parameter are a long and double  
array respectively, with number of elements equal to the total  
number of intersections of all the RAYS with faces of the MESH,  
plus one for any RAY which misses MESH entirely.  The values of  
c are:  
  [#hits,cell1,cell2,cell3,..., #hits,cell1,cell2,cell3,..., ...]  
where each #hits is followed by the list of cell indices (assuming  
i=1, j=1, and k=1 are present but meaningless in cell arrays --  
that is, assuming zone centered arrays have the same dimensions  
as XYZ rather than one less in each direction).  Rays which miss  
the mesh entirely have #hits=1, all others have #hits>=2 since they  
must exit.  #hits<0 means a ray reentered the mesh for abs(#hits)  
more face crossings, but this currently cannot happen.  The values  
of S correspond to c:  
  [s0,s1,s2,s3,..., s0,s1,s2,s3,..., ...]  
which are the distances along the ray measured from RAYS(,,1) in  
the direction of RAYS(,,2) where the ray pierces a cell face.  For  
rays which miss the mesh, the value of s0 is a diagnostic telling  
why they missed (see compiled code).  
Function hex5_track uses the 5-tet decomposition for hexes,  
which is not unique when the quad faces are non-planar.  You may  
be able to get an idea of this effect by setting hex_triang the  
opposite way and redoing the trace.  
Functions hex24f_track and hex24b_track use the face and body  
centered 24-tet decompositions for hexes.  These are unique;  
however, hex_triang may in rare cases change the trace slightly,  
since the entry search algorithm still involves triangulating  
the surface quads.  
Builtin function, documented at i0/hex.i   line 40

SEE ALSO: hydra_mesh, hex_triang, reg_track, track_reduce, c_adjust, pic3_rays,
conv3_rays

hex_mesh


    mesh= hex_mesh(xyz, bound, nbnds, &mbnds, nblk, &blks, start)  


create a 3D mesh object from the multiblock mesh parameters  
XYZ   is NBLK 3 x Ni x Nj x Nk coordinate arrays packed together  
BOUND is NBLK 3 x Ni x Nj x Nk face boundary markers packed  
NBNDS is length of MBNDS  
MBNDS is HX_blkbnd describing each internal block boundary face  
NBLK  is number of blocks  
BLKS  is NBLK HX_block objects describing the block structure  
START is 0-origin 6*cell+face index of first boundary face/cell  
       or -1-cell to trace from centroid of that cell to point  
       p on ray to begin tracking  
Builtin function, documented at i0/hex.i   line 12

SEE ALSO: hex5_track, hydra_mesh, hex_startflag

hex_mesh2


    mesh= hex_mesh2(xyz, bounds)  


old interface for hex_mesh  
create a 3D mesh object from the 3 x Ni x Nj x Nk coordinate  
array XYZ and the list of 6 BOUNDS:  
  BOUNDS(1), BOUNDS(2)  for the i=1,Ni boundaries  
  BOUNDS(3), BOUNDS(4)  for the j=1,Nj boundaries  
  BOUNDS(5), BOUNDS(6)  for the k=1,Nk boundaries  
The BOUNDS values are:  
  1   if this is a problem boundary  
  2   if this is a reflecting boundary  
  3   if this is a periodic boundary  
Interpreted function, defined at i0/hex.i   line 692