Home
Manual
Packages
Global Index
Keywords
Quick Reference

all functions  e
edit_times

edit_times, file
or edit_times, file, keep_list
or edit_times, file, keep_list, new_times, new_ncycs
edits the records for FILE. The KEEP_LIST is a 0origin index list
of records to be kept, or nil to keep all records. The NEW_TIMES
array is the list of new time values for the (kept) records, and
the NEW_NCYCS array is the list of new cycle number values for the
(kept) records. Either NEW_TIMES, or NEW_NCYCS, or both, may be
nil to leave the corresponding values unchanged. If nonnil,
NEW_TIMES and NEW_NCYCS must have the same length as KEEP_LIST,
or, if KEEP_LIST is nil, as the original number of records in
the file. If KEEP_LIST, NEW_TIME, and NEW_NCYCS are all omitted
or nil, then edit_times removes records as necessary to ensure
that the remaining records have monotonically increasing times,
or, if no times are present, monotonically increasing ncycs.
(The latest record at any given time/ncyc is retained, and earlier
records are removed.)
In no case does edit_times change the FILE itself; only Yorick's
inmemory model of the file is altered.
builtin function, documented at i0/std.i line 2412

SEE ALSO:

get_times,
get_ncycs,
jt,
jc

ell_am

ell_am(u)
or ell_am(u,m)
returns the "amplitude" (an angle in radians) for the Jacobi
elliptic functions at U, with parameter M. That is,
phi = ell_am(u,m)
means that
u = integral[0 to phi]( dt / sqrt(1m*sin(t)^2) )
Thus ell_am is the inverse of the incomplete elliptic function
of the first kind ell_f. See help,elliptic for more.
interpreted function, defined at i/elliptic.i line 93

SEE ALSO:

elliptic

ell_e

ell_e(phi,m)
returns the incomplete elliptic integral of the second kind E(phiM).
That is,
u = ell_e(phi,m)
means that
u = integral[0 to phi]( dt * sqrt(1m*sin(t)^2) )
See help,elliptic for more.
interpreted function, defined at i/elliptic.i line 240

SEE ALSO:

elliptic,
ell_f

ell_f

ell_f(phi,m)
returns the incomplete elliptic integral of the first kind F(phiM).
That is,
u = ell_f(phi,m)
means that
u = integral[0 to phi]( dt / sqrt(1m*sin(t)^2) )
See help,elliptic for more.
interpreted function, defined at i/elliptic.i line 180

SEE ALSO:

elliptic,
ell_e

ellip2_e

ellip2_e(m)
returns the complete elliptic integral of the second kind E(M):
E(M) = integral[0 to pi/2]( dt * sqrt(1M*sin(t)^2) )
accurate to 2e8 for 0<=M<=1
interpreted function, defined at i/elliptic.i line 408

SEE ALSO:

elliptic,
ellip_k,
ell_e

ellip2_k

ellip2_k(m)
returns the complete elliptic integral of the first kind K(M):
K(M) = integral[0 to pi/2]( dt / sqrt(1M*sin(t)^2) )
accurate to 2e8 for 0<=M<1
interpreted function, defined at i/elliptic.i line 391

SEE ALSO:

elliptic,
ellip_e,
ell_f

ellip_e

ellip_e(m)
returns the complete elliptic integral of the second kind E(M):
E(M) = integral[0 to pi/2]( dt * sqrt(1M*sin(t)^2) )
See help,elliptic for more.
interpreted function, defined at i/elliptic.i line 341

SEE ALSO:

elliptic,
ellip_k,
ell_e

ellip_k

ellip_k(m)
returns the complete elliptic integral of the first kind K(M):
K(M) = integral[0 to pi/2]( dt / sqrt(1M*sin(t)^2) )
See help,elliptic for more.
interpreted function, defined at i/elliptic.i line 303

SEE ALSO:

elliptic,
ellip_e,
ell_f

eps

eps, name
writes the picture in the current graphics window to the Encapsulated
PostScript file NAME+".epsi" (i.e. the suffix .epsi is added to NAME).
The eps function requires the ps2epsi utility which comes with the
project GNU Ghostscript program. Any hardcopy file associated with
the current window is first closed, but the default hardcopy file is
unaffected. As a side effect, legends are turned off and color table
dumping is turned on for the current window.
The external variable PS2EPSI_FORMAT contains the format for the
command to start the ps2epsi program.
interpreted function, defined at i0/graph.i line 177

SEE ALSO:

hcps,
window,
fma,
hcp,
hcp_finish,
plg

eq_nocopy

eq_nocopy, y, x
is the same as
y= x
except that if x is an array, it is not copied, even if it is
not a temporary (i.e. an expression). Having multiple variables
reference the same data can be confusing, which is why the default
= operation copies the array. The most important use of eq_nocopy
involves pointers or lists:
y= *py
z= _car(list)
always causes the data pointed to by py to be copied, while
eq_nocopy, y, *py
eq_nocopy, z, _car(list)
does not copy the data  often more nearly what you wanted.
Note that scalar int, long, and double variables are always copied,
so you cannot count on eq_nocopy setting up an "equivalence"
between variables.
builtin function, documented at i0/std.i line 287

erf

erf(x)
return erf(x), 2./sqrt(pi) * integral[0 to x](exp(t^2)*dt)
interpreted function, defined at i/dawson.i line 50

SEE ALSO:

erfc,
dawson

erfc

erfc(x)
returns the complementary error function 1erf with fractional
error less than 1.2e7 everywhere.

erfc

erfc(x)
return erfc(x), 2./sqrt(pi) * integral[x to infinity](exp(t^2)*dt)

SEE ALSO:

erf,
dawson

error

exit, msg
error, msg
Exits the current interpreted *main* program, printing the MSG.
(MSG can be omitted to print a default.)
In the case of exit, the result is equivalent to an immediate
return from every function in the current calling chain.
In the case of error, the result is the same as if an error had
occurred in a compiled routine.
builtin function, documented at i0/std.i line 2535

SEE ALSO:

print,
write,
batch,
catch

evolve

evolve, time1
or evolve, time1, time0
Step the hydro calculation forward to TIME1,
starting with the initial conditions in the
RT, z, and v arrays at time TIME0 (default 0.0
if omitted). The calculation also depends on
the constants M (mass/area/zone) and gammaM1
(gamma1 for the gammalaw equation of state).
The pressure array p is updated in addition to
the primary state arrays RT, z, and v.
Boundary conditions are specified by setting
either a boundary pressure or a boundary
velocity at each end of the fluid column.
bc0_v  Boundary velocity at z(0), or []
if z(0) has pressure BC.
bc0_p  Boundary pressure beyond z(0).
bc0_time  If bc0_v or bc0_p is an array,
bc0_time is an array of the same
length specifying the corresponding
times for time dependent BCs.
bc0_Z  Acoustic impedance at z(0) if bc0_v
is nil (default is 0).
bcN_v, bcN_p, bcN_time, and bcN_Z have the same
meanings for the z(n_zones) boundary.
The worker routines OutputResults and
TakeStep must be supplied.
interpreted function, defined at i/demo1.i line 119

expm1

expm1(x)
or expm1(x, yp)
return exp(x)1 if abs(x)>1.e4, otherwise x
in the second form, returns exp(x) to the second argument
builtin function, documented at i0/hex.i line 505

SEE ALSO:

exp

