Input Cards by Function

Normal Program Managment Commands

c

Comment - ignored.

name

parameters

c

[ COMMENT ]

c the parameter settings below make the run more smooth

Comment Card.

COMMENT

is an arbitrary alphanumeric string that is ignored by the code. Note that it must be separated from the c by at least one space.

Other entry:

Useful Input Cards

#

Same as c.

name

parameters

#

[ COMMENT ]

d

Make a restart dump.

name

parameters

d

[ FILENAME ]

d s12g
d #mydump

FILENAME

name of file to which to write a current restart dump

If FILENAME is not provided, the restart dump is written to file name NAMEPROBz where NAMEPROB is the current problem name.

If FILENAME starts with # then the dump is written to file name NAMEPROB#FILENAME.

If FILENAME is # then the dump is written to file name NAMEPROB#NCYC where NCYC is ncyc (q 4).

Changed In Version >16.0.0: Added #FILENAME option.

Changed In Version 17.1.7: Added blank # option.

?

Evaluate expression.

name

parameters

?

EXPRESSION

? p 2 * 2.
? dn(3) * rn(3)**3

EXPRESSION

legal expression that can be evaluated in command files

New In Version 17.0.12.

@

Evaluate logical expression.

name

parameters

@

EXPRESSION

@ p 2 > 2.
@ dn(3) * rn(3)**3 >= dn(4) * rn(4)**3

EXPRESSION

legal expression that can be evaluated in command files

New In Version 17.0.12.

cmddbg

Switch on or off debugging for command file functions.

name

parameters

cmddbg

[ VALUE ]

cmddbg
cmddbg 0

VALUE

switch on if >0, switch off otherwise.

If value is not present, print current value.

New In Version 17.11.7.

Changed In Version 18.0.1: Print current value if no value is provided.

debug

Switch on or off debugging mode.

name

parameters

debug

[ VALUE ]

debug
debug 0

VALUE

switch on if >0

If value is not present, print current value.

New In Version 18.0.1.

p

Edit changable (‘P’) parameters.

name

parameters

p

[ ( PARAMETER [ ( .. PARAMETER ) | ( VALUE [ OPERATION ] ) ] ) | ( LISTVALUE [ list ] ) ]

p
p 1
p 1 1.e-5
p 1 2. *
p 1 * 3.
p 1 .. 3
p 1 .0001 %
p 1 list
p 1.d-14
p *time

PARAMETER

is the name or number of the parameter to be specified. See Changable (‘P’) Parameters for a list of the changeable parameters in the code and their units and default values.

VALUE

is the value to be assigned to this parameter. Note that fixed point parameters must have fixed pointed values specified, and floating point parameters must be given floating point values (i.e., 1 \ne 1.). If VALUE is a string, this cannot be a valid float

OPERATION

add | mul | div | sub | mod | pow | * | - | + | / | % | ^ | **

LISTVALUE

Value for parameter list by value. Integer or float.

Note

If the desired list value is also valid parameter number, then use the “list” keyword, otherwise it may be omitted.

Parameters are internally first set to their default values, but can be overwritten uisng input cards, e.g., in generators or interactively.

For editing parameters one may use either their number or name.

Current parameter values can be querried using the “p command by just specifying their numer or name. A range of parameters can be listed using “-” or “..”. The “*” wildcard can be used at the beginning or the end to list all parmeters with matching names where the usual UNIX shell-type maching is performed, “*” standing for any number of arbitrary characters. Parameters can be listed by matching numerical value using the “list” keyword. If the numeric value is of type float or integer and out of the allowed range of allowed parameter numbers, the “list” keyword may be omitted.

Parameters can be changed by specifying the new value or using one of the operations “*”, “-“, “+”, “/”, “%”, “^”, or “**” on the current value. The operators “^” and , “**” do the same things.

parmetercard ::=  "p" listspec | setspec | vallistspec
listspec     ::=  [ parameter [ rangeop parameter ] ] | wildspec
rangeop      ::=  ".."
wildspec     ::=  "*"string | string"*" | "*"string"*"
setspec      ::=  parameter value [ operation ] | parameter simpleop value
vallistspec  ::=  value [ "list" ]
parameter    ::=  name | number
name         ::=  string
number       ::=  integer
value        ::=  float | integer | string
operation    ::=  simpleop | complexop
simpleop     ::=  "*" | "-" | "+" | "/" | "%" | "^"
complexop    ::=  "add" | "mul" | "div" | "sub" | "mod" | "pow"

Changed In Version >15.0.0: Added matching by wildchard and parameter range.

Changed In Version 16.85.0: procession of p cards by ttycom allows the use of parameter names in generators. Prior to that, only parameter numners were allowed in generators.

Changed In Version 17.0.2: List parameters by value.

Changed In Version 18.1.3: Add “^”, “**”, and pow.

Changed In Version 18.7.1: only allow .. for parameter range selection

Other entry:

Useful Input Cards

newnetb

Generate new BURN network from file FILENAME.

name

parameters

newnetb

FILENAME

FILENAME

Name of file from which to read definition of new network.

Note

This dates back to the early dates before ADAPNET and has not been used much in some time. Maybe use ADAPNET instead.

Map to new (bigger!) network. In contast to the genburn card in generators, only the net and netw cards are use whereas the g, gg, and m cards are not allowed. Other commands are processed as if entered on the command line.

New In Version >16.0.0.

killburn

Turn off and removes the burn co-processing.

name

parameters

killburn

killburn

inburn and imaxb are set to zero.

New In Version >16.0.0.

burnamax

Print the maximum abundances reached in the BURN network.

name

parameters

burnamax

burnamax

Only available if irecb (p 418) is set to 1.

The output contains information about the mass fraction reached and the mass coordinate where it was reached.

New In Version >16.0.0.

burnaclr

Reset the recording of maximum abundances of BURN network.

name

parameters

burnaclr

See also

burnamax

New In Version >16.0.0.

killpist

Reset/terminate piston.

name

parameters

killpist

killpist

mapburn

Map BURN abundances to APPROX.

name

parameters

mapburn

mapburn

Note

If BURN is not active, this card is ignored.

Todo

Implement in KEPLER stuff for ISE and NSE mapping?

New In Version >16.0.0.

Input commads from file FILENAME.

name

parameters

link

FILENAME

link ExplD

FILENAME

Name of file from which to read commands.

o

Obtain/set/define/delete optional user-defined (‘O’) parameters.

name

parameters

o

[ NAME [ VALUE [ OPERATION ] | ( VALUE [ def | dev | @ | & ) | ( del | # ) ] ( OPERATION | @ | &) VALUE ] | VALUE list ]

o i 1 def
o i 1 +
o i
o
o i del

NAME

is the name of the parameter to be specified. By default no parameters are initilazed by KEPLER.

OPERATION

add | mul | div | sub | mod | * | - | + | / | % | ^ | **

These can be used in commad files or to specify other quantities that are useful to analysis later.

The plain form o without any other parameters will list all currently defined parameters.

The form with only NAME specified will return the value of the parameter.

The form with NAME and VALUE will set the parameter to the new value. The VALUE should observe the type of the parameter.

The form with NAME, VALUE, and OPERATION will perfom the operation on the parameter and set it to the resulting value. The operand VALUE should observe the type of the parameter.

The form with NAME, VALUE, and def or @ will define the new parameter and set its value to VALUE. The variable type is inferred from the type of the initial value. An error results if the variable NAME already exists.

The form with NAME, VALUE, and dev or & will define a new parameter and set its value to VALUE if NAME does not yes exits, otherwise NAME remains unchanged. An error results if the variable NAME already exists and has a different type than VALUE.

The form with NAME, ( OPERATION or dev or & ) VALUE is also allowed with the purposes as above, just last two arguments switched.

The form NAME VALUE list prints all parameters with that value.

The form with NAME and del or # will delete the optional parameter.

Note

In contrast to p and q parameters the o parameters cannot be addressed by number. This limitation was imposed as the parameters can be added and removed randomly.

parmetercard ::=  "o" listspec | setspec | defspec | delspec
listspec     ::=  [ parameter ]
setspec      ::=  parameter ( value [ operation ] | operation value )
defspec      ::=  parameter ( value ( "def" | "dev" | "@" | "&" ) ) | ( "@" | "&" ) value )
delspec      ::=  parameter ( "del" | "#" )
parameter    ::=  name
name         ::=  string
number       ::=  integer
value        ::=  float | integer
operation    ::=  "add" | "mul" | "div" | "sub" | "mod" | "*" | "-" | "+" | "/" | "%" | "^" | "**"

New In Version 17.0.2.

Changed In Version 18.1.3: Add “@”, “#”, “^”, “**”, and pow.

Changed In Version 18.2.0: Parameters no longer need to be defined but instead the first assignment will be used as implicit definition if impoparm (p 587) is 1.

Changed In Version 18.7.7: Added dev.

Changed In Version 18.7.20: Add & and option for reverse order of definition operators.

del

Delete optional user-defined (‘O’) parameters.

name

parameters

del

NAME

o i 1 def
o i 1 +
o i
o
del i

NAME

is the name of the parameter to be deleted.

Delete the optional parameter NAME. See o for details.

New In Version 17.11.7.

def

Define optional user-defined (‘O’) parameters.

name

parameters

def

NAME VALUE

def i 1
o i 1 +
o i
o
del i

NAME

is the name of the parameter to be defined.

Define the optional parameter NAME. See o for details.

New In Version 17.11.7.

dev

Default value for optional user-defined (‘O’) parameters.

name

parameters

dev

NAME VALUE

dev i 1
o i 1 +
o i
o
del i

NAME

is the name of the parameter for which to set default value.

Set default value for the optional parameter NAME. See o for details.

New In Version 18.7.7.

q

List edit (‘Q’) parameters.

name

parameters

q

[ PARAMETER [ .. PARAMETER ] ]

q
q 1
q 1 .. 3

Changed In Version 18.7.1: only allow .. for parameter range selection

ed

Force an edit of the current cycle to be written in the ASCII output file.

name

parameters

ed

[ MEDIT ]

ed 10

vi:MEDIT

value to use for medit (p 276).

If MEDIT is specified, make an edit as if medit (p 276) had that value.

edp

Force a parameter edit for the current cycle to be written in the output file.

name

parameters

edp

edp

end

Terminate the problem.

name

parameters

end

end

fin

Same as end.

name

parameters

fin

  fin

.. versionadded:: 15+

exit

Same as end.

name

parameters

exit

  exit

.. versionadded:: 15+

stop

Same as end.

name

parameters

stop

  stop

.. versionadded:: 15+

bye

Same as end.

name

parameters

bye

  bye

.. versionadded:: 15+

quit

Same as end.

name

parameters

quit

  quit

.. versionadded:: 15+

halt

Same as end.

name

parameters

halt

  halt

.. versionadded:: 15+

k

Same as kill.

name

parameters

k

  k

.. versionadded: 16+

kill

Immediately terminate KEPLER without the usual “shutdown procedure.”.

name

parameters

kill

kill

New In Version >15.0.0.

x

Write out dump file then end KEPLER.

name

parameters

x

x

New In Version >16.0.0.

g

Resume normal calculations after a suspension.

name

parameters

g

g

<j>

Make a current edit for zone <j> on the terminal.

name

parameters

<j>

[ (i [ IONSYM ] ) | ( b [ ISOSYM ] ) | q ]

12
.5 i
1.d33 i c12
-5 b c13
0 b

<j>

zone number or mass

IONSYM

symbol of ion from APPROX / NSE / QSE network

ISOSYM

symbol of species from BURN network

The usual range of zones is from 1 to jm (q 2). Zone numbers less than 1 are counted “outward in” from the surface, with 0 corresponsing to the surface zone, i.e., jm (q 2) is added to the spacified number. After this, zone numbers >jm (q 2) are truncated to jm (q 2) and zone numbers (now still) less than 1 are truncated to 1.

If <j> is a float, KEPLER will try to translate it to a zone number. First, if the magnitude of the value is less than 1.e+10 it is assumed the number is in solar masses. Next, values less than 0. are, as above, counted from the surface, i.e., the total mass of the star, totm (q 17)+summ0 (p 61) is added. KEPLER then finds the mass shell with lower boundary mass as close as possible to the provided mass coordinate.

i

make APPROX / NSE / ISE ion edit of all ions with abundances larger than abunlim (p 128)

i ISOSYM

make APPROX / NSE / ISE ion edit of the specified ion

b

make BURN species edit of all species with abundances larger than abunlimb (p 272)

b ISOSYM

make BURN species edit of the specified species

q

Make a NSE / ISE edit on the terminal

sumb

Display an edit of the mass fraction of BURN species.

name

parameters

sumb

[ ( ISOSYM+ [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [ISOSYM+] ) ]

sumb
sumb 1 10
sumb -1. 0 c13
sumb 1 9999
sumb c12
sumb 1 c12
sumb c12 c13
sumb c12 1 1.d33
sumb c12 c13 1 1.d33
sumb 0 -10 c12 c13

ZONE [ ZONE ]

Zone or zone range (inclusive) over which to sum. Similar to <j> command zone numbers out side the usual range of zones from 1 to jm (q 2) are trnasformed. Zone numbers less than 1 are counted “outward in” from the surface, with 0 corresponsing to the surface zone, i.e., jm (q 2) is added to the specified number. After this, zone numbers >jm (q 2) are truncated to jm (q 2) and zone numbers (now still) less than 1 are truncated to 1. Finally, if the first resulting number is larger then the second, the numbers are swapped.

If ZONE is a float, KEPLER will try to translate it to a zone number. First, if the magnitude of the value is less than 1.e+10 it is assumed the number is in solar masses. Next, values less than 0. are, as above, counted from the surface, i.e., the total mass of the star, zm(jm (q 2)) is added. KEPLER then finds the mass shell with lower boundary mass as close as possible to the provided mass coordinate.

If there is an overflow at the upper mass limit (ZONE > jm (q 2) for integer values or ZONE > zm(jm (q 2)) for float values) the mass lost in the wind is added. If a single zone is provided and it is beyond the maximum, only the wind is used.

ISOSYM

BURN species symbol. If supplied, only those species are edited.

If ISOSYM is not supplied, all species with abundances larger than abunlimb (p 272) are printed.

Changed In Version 17.7.5: Adjusted zone range treatment.

sumbg

Display an edit of the mass of BURN species in g.

name

parameters

sumbg

[ ( ISOSYM [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [ISOSYM] ) ]

Same as sumb otherwise.

Changed In Version 17.7.5: Adjusted zone range treatment.

sumbsun

Display an edit of the mass of BURN species in Msun.

name

parameters

sumbsun

[ ( ISOSYM [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [ISOSYM] ) ]

Same as sumb otherwise.

Changed In Version 17.7.5: Adjusted zone range treatment.

sumi

Display an edit of the mass fraction of APPROX / ISE / NSE ions.

name

parameters

sumi

[ ( IONSYM+ [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [IONSYM+] ) ]

sumi
sumi 1 10
sumi -1. 0 n14
sumi 1 9999
sumi c12 o16
sumi c12 1 1.d33

IONSYM

APPROX / ISE / QSE species symbol. If supplied, only those species are edited.

Same as sumb otherwise.

Changed In Version 17.7.5: Adjusted zone range treatment.

sumig

Display an edit of the mass of APPROX / ISE / NSE ions in g.

name

parameters

sumig

[ ( IONSYM [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [ISOSYM] ) ]

Same as sumi otherwise.

Changed In Version 17.7.5: Adjusted zone range treatment.

sumisun

Display an edit of the mass of APPROX / ISE / NSE ions in Msun.

name

parameters

sumisun

[ ( IONSYM [ ZONE [ ZONE ] ] ) | ( ZONE [ ZONE ] [ISOSYM] ) ]

Same as sumi otherwise.

Changed In Version 17.7.5: Adjusted zone range treatment.

s

Suspend execution, or step cycle if suspended.

name

parameters

s

[ N | - ]

s 3

N

Number of cycle to run problems before suspending again.

-

Same as r.

Changed In Version 18.3.5: Added - option.

r

Suspend execution, or resume stepping of cycles if suspended.

name

parameters

r

[ N | - ]

s 100
r
r

N

Same a :c:’s’. Number of cycle to run problems before suspending again.

-

Ignored.

New In Version 18.3.5.

t

Make a current time edit on the terminal.

name

parameters

t

t

ted

Displaya ‘short’ ASCII edit on the terminal.

name

parameters

ted

[ MEDIT ]

ted

vi:MEDIT

value to use for medit (p 276).

If MEDIT is specified, make an edit as if medit (p 276) had that value.

time

Make an edit of computer time usage (sec).

name

parameters

time

time

tn

Make a nuclear reaction rate edit on the terminal (mol/sec - over whole star).

name

parameters

tn

[ REACSYM ]

tn

REACSYM

reaction symbol for which to list

If REACSYM is not provided, all reactions are listed.

tq

Make a combined time and surface edit on the terminal.

name

parameters

tq

Other Terminal Edit Commands

e

Make an energy edit on the terminal.

name

parameters

e

e

editiso

Same as ediso.

name

parameters

editiso

[ JINNER [ JOUTER ] ]

editso 171 417

ediso

Make an edit of the isotopic yields, summed between zones JNNER and JOUTER inclusive.

name

parameters

ediso

[ JINNER [ JOUTER ] ]

ediso 171 417

v:JINNER

Specification of inner zone (or mass coordinate).

v:JOUTER

Specification of outer zone (or mass coordinate).

Output is written to both on the terminal and in a special file with suffix “.yieldJINNER”. If JINNER=1, it is omitted from the suffix. This file overwrites any such existing file and is automatically sent to the laser printer (“lpr”) to be printed.

Processing of zone specification is done similar to the <j> command if only JINNER is suppied, and similar to the sumb command if both both JINNER and JOUTER are supplied. I neither is supplied, the entire star is edited.

The solar abundances are read from the data file solabu.dat and the decay data and branching ratios are read from decay.dat. The yields and production factors are given including the wind and additionally yields and production factors are given for the wind by itself. The data formats of the files decay.dat and solabu.dat are specified at the beginning of the existing sample files.

Changed In Version >16.0.0: Works with arbitrary networks and uses decay data from decay.dat. Include wind.

enucb

Edit the temperature, density, specific energy generation rate (neutrino losses applied), its temperature and density derivatives, the opacity and its temperature and density derivatives.

name

parameters

enucb

ZONE TEMPERATURE DENSITY TIMESTEP

enucb 51 1.d9 1.d6 1.

ZONE

Zone from which to take composition. Processing of zone specification is done similar to the <j> command.

TEMPERATURE

temerature for flow calcualtion (K). Use temperature from zone if set to “-

DENSITY

density for flow calcualtion (g/cc). Use density from zone if set to “-

TIMESTEP

time step for flow calcualtion (sec). Use current new time step dtnew (p 1) if set to “-

New In Version 17.0.1: Implemented by Laurens Keek.

Changed In Version 17.0.2: Added standardized treatment of zone specification

test

Gives a terminal edit of quantity TESTVAR for the materials in zone ZONE, but at the temperature T in K and density D in g/cc specified.

name

parameters

test

TESTVAR ZONE T D

test p 1 3.E+9 2.E+7

TESTVAR

A variable symbol which may be anyone of the following:

value

result

k

Opacity (cm**2/g)

s

(specific) Energy Production Rate (erg/g/sec)

p

Pressure (erg/cc)

e

(specific) Energy (erg/g)

d

degeneracy parameter \eta

ZONE

Zone from which to take composition. Processing of zone specification is done similar to the <j> command.

T

temperature T in K

D

density in g/cc

Changed In Version >16.0.0: added d to print degeneracy

tn

Make an edit of the total rate of nuclear reaction REACSYM on the terminal.

name

parameters

tn

REACSYM

tn he3+he4

REACSYM

Reaction Symbol

Allowed values for REACSYM are given in Zonal Nuclear Reaction Rates. The values edited are the total net rates (forward-back) summed over the whole star (in mol/sec).

v

Make a terminal edit of the zonal edit variable denoted by EDITVAR from zones JMIN to JMAX, inclusive.

name

parameters

v

EDITVAR [ JMIN [ JMAX ] ]

v ionye 1 100

EDITVAR

Edit variable, see Zonal Edit Varlables.

JMIN

Single zone or lower bound of range of zones to be edited.

JMAX

Upper bound zone to be edited.

If only JMIN is specified, JMAX is assumed to be equal to JMIN. If neither JMIN or JMAX is given, then JMIN = 1 and JMAX = jm (q 2), the index of the current outer zone. A detailed list of the allowed edit variables and their corresponiing values of EDITVAR is given in Zonal Edit Varlables.

Processing of zone specification is done similar to the <j> command if only JMIN is supplied, and similar to the sumb command if both both JMIN and JMAX are supplied.

git

Print source git repository sha-1.

name

parameters

git

git

The output looks like this:

Git SHA-1 3a0fba8c1ef49b175c83837c0d95309aa3ba1623

uuid

Print current UUID info.

name

parameters

uuid

uuid

The output looks like this:

--------------------------------------------------
VERS                                170100
SHA   8267afd66f45371c2bbdf493a64804cd50cdb855
PROG  699678ba-f4d8-11e4-927c-606720611230 of Thu May  7 12:45:04 2015
EXEC  729bd3ec-f4d8-11e4-b460-606720611230 of Thu May  7 12:45:20 2015
CYCLE f7deac36-7adb-11e4-a00b-00259058e8e4 of Wed Dec  3 06:03:10 2014
DUMP  75d7ed3e-f4d8-11e4-b460-606720611230 of Thu May  7 12:45:25 2015
CYCLE                               500000
FILE                                  xxxz
USER                                  alex
HOST                 zinc.maths.monash.edu
--------------------------------------------------
VERS                                170100
SHA   8267afd66f45371c2bbdf493a64804cd50cdb855
PROG  7c850138-f4da-11e4-b469-606720611230 of Thu May  7 12:59:55 2015
RUN   07b99f8a-d18b-11e3-a013-00259058e8e4 of Thu May  1 19:48:01 2014
EXEC  2e26bc6a-f4db-11e4-9e46-606720611230 of Thu May  7 13:04:53 2015
PREV  f3784bde-7adb-11e4-a00b-00259058e8e4 of Wed Dec  3 06:03:02 2014
CYCLE f7deac36-7adb-11e4-a00b-00259058e8e4 of Wed Dec  3 06:03:10 2014
USER                                  alex
HOST                 zinc.maths.monash.edu

The first section gives the execution history (if present), the seceond the current UUID information.

The meaning of the lines is as follows:

value

result

PROG

UUID of the current executable

RUN

UUID of the current run

PREV

UUID of the previous cycle

CYCLE

UUID of the current cycle

EXEC

UUID of the current execution

Note

KEPLER uses Type 1 UUIDs that are comopsed of time since start ot Julian Calendar (in 100 ns) and the machine MAC address.

New In Version 16.85.0.

Changed In Version 17.0.4: Added execution UUID. Added execution history.

version

Type out information about the dates on which the current code modules were last modified. (deprecated).

name

parameters

version

Deprecated Since Version 16.85.0: Use uuid instead.

vf

Same as the v command except that edited values are given to 14 decimal places instead of 3.

name

parameters

vf

EDITVAR [ JMIN [ JMAX ] ]

vf ionye 1 100

z

Makes a columnar zonal edit of up to ten EDITVAR arrays.

name

parameters

z

( EDITVAR )+ [ JMIN [ JMAX ] ]

z dn tn sige sigi sigr 1 100

EDITVAR

Edit variable, see Zonal Edit Varlables.

JMIN

Single zone or lower bound of range of zones to be edited.

JMAX

Upper bound zone to be edited.

If only JMIN is specified, JMAX is assumed to be equal to JMIN. If neither JMIN or JMAX is given, then JMIN = 1 and JMAX = jm (q 2), the index of the current outer zone. A detailed list of the allowed edit variables and their corresponiing values of EDITVAR is given in Zonal Edit Varlables.

Processing of zone specification is done similar to the <j> command if only JMIN is supplied, and similar to the sumb command if both both JMIN and JMAX are supplied.

The first column in the edit gives the convection sentinel and the zone number, the second column lists the interior mass in scalem (p 273) units. Values of the requested arrays start in column 3. At least one array must be requested, up to a maximum of 10.

Note

5 array requests fit nicely in an 80 column screen window, and 10 fill a 132 column edit page.

Other ASCII Output-File Edit Commands

core

Show core information on screen.

name

parameters

core

[ COREXLIM [ COREFELM ] ]

COREXLIM

Mass fraction limit for all core composiitons except iron. The defaulf value is 0.01.

COREFELM

Iron mass fraction limit for “iron” core. The defaulf value is 0.1.

The values given are the shell number (j), interior mass (zm), radius (rn), exterior binding energy (ybind), and total entropy at the core boundary (stot). These values are displayed for the center of the star, the Y_\mathrm{e}-jump (Y_\mathrm{e} drops below 0.49), the boundary of the APPROX network, the $\mathrm{O}$ shell (maximum in energy generation by $\mathrm{O}$ burning), the “iron” core (defined by the mass fraction of heavy elements with mass number > 46 exceeding 1/2), the $\mathrm{Si}$ core ($\mathrm{Si}$ mass fraction > COREFELM and $\mathrm{Si}$ mass fraction bigger than $\mathrm{O}$ mass fraction), the $\mathrm{Ne}$/$\mathrm{Mg}$/$\mathrm{O}$ core ($\mathrm{C}$ mass fraction first drops below COREXLIM and “iron” is more abundant than COREFELM), the $\mathrm{C}$/$\mathrm{O}$ core ($\mathrm{He}$ mass fraction first drops below COREXLIM and “iron” is more abundant than COREFELM), and the helium core ($\mathrm{H}$ mass fraction first drops below COREXLIM and iron is more abundant than COREFELM).

New In Version >15.0.0.

eostable

Write out table for EOS and opacities.

name

parameters

eostable

ZONE TLOW THI NTEMP DLOW DHI NRHO

eostable 1 1.E+6 1.E+9 20 1. 1.E+6 30

ZONE

Zone from which to take composition. Processing of zone specification is done similar to the <j> command.

TLOW

starting temperature of table in K

THI

ending temperature of table in K

NTEMP

number of temperature steps

DLOW

starting density of table in g/cc

DHI

ending density of table in g/cc

NRHO

number of density steps

Using the composition from zone ZONE, a table of EOS and opacity information is written into the normal ASCII output file for a logarithmic grid of temperatures (from TLOW to THI with NTEMP + 1 grid points) and densities (from DLOW to DHI with NRRO + 1 grid points). Here TLOW and THI are in K and DLOW and DHI are in g/cc.

The information written is \log(T), \log(\rho), \log(P_\mathrm{tot}), \log(P_\mathrm{e}), \log(e_\mathrm{tot}), \log(e_\mathrm{e}), and \log(\kappa), all in cgs units.

Changed In Version 17.0.2: Fixed bug in output of \log(e_\mathrm{e}).

eostab2

Write out table for EOS with derivatives and opacities.

name

parameters

eostab2

ZONE TLOW THI NTEMP DLOW DHI NRHO

eostab2 1 1.E+6 1.E+9 20 1. 1.E+6 30

Parameters are the same as for eostable but the output is \log(T), \log(\rho), \log(P), (\mathrm{d\,ln\,}P/\mathrm{d\,ln\,}T), (\mathrm{d\,ln\,}P/\mathrm{d\,ln\,}\rho), \log(e), (\mathrm{d\,ln\,}e/\mathrm{d\,ln\,}T), (\mathrm{d\,ln\,}e/\mathrm{d\,ln\,}\rho), \log(\kappa), all in cgs units, and S in kb/baryon.

New In Version >16.0.0.

Changed In Version 17.0.2: use to have \log(\mathrm{d}P/\mathrm{d}T), \log(\mathrm{d}P/\mathrm{d}\rho), \log(\mathrm{d}e/\mathrm{d}T), and \log(\mathrm{d}e/\mathrm{d}\rho).

Changed In Version 17.0.2: added treatment of specification of ZONE similar to <j>.

eostrans

Add TRANSMULT times the energy in nuclear excited states to all zonal specific energies.

name

parameters

eostrans

transmult

eostrans 1.

Useful in certain EOS transitions.

eoswrite

Deprecated. (See source code.).

name

parameters

eoswrite

JTAB ZONE NTEMP NRRO NEOSM

Deprecated Since Version >15.0.0.

Note

The original documentation was:

EOSWRITE JTAB ZONE NTEMP NRRO NEOSM

eoswrite 626 1 20 30 10

This command writes an EOS table identified by EOS # JTAB based on the composition of zone Jl, and having NTEMP temperature points and NRHO density points. This file is written after the last entry in ASCII file EOSKEP. If file EOSKEP does not exist, it is created with a sufficiently large size to contain NEOSM table sets. Before the EOSWRITE command is used, the TZ array must be set by the TV AL command so that it contains the NTEMP temperature points (in ke V), immediately followed by the NRRO density points (in g/cc). NRHO and NTEMP can sum to at most NTEMPZ (a parameter in KEPCOMS currently set to 60).

Warning

This command is no longer supported. See version .tw:kepn:kepn3/25 for the old coding if you want to try to revive it, but see eostable flfst.

flowb

Edit BURN nuclear reaction flow data.

name

parameters

flowb

ZONE ( TEMPERATURE | - ) ( DENSITY : - ) ( TIMESTEP | - ) [ RADIUS | + ] [ ( FILENAME | - | matrix ) ]

flowb 300 - - - + -

ZONE

Zone from which to take composition. Processing of zone specification is done similar to the <j> command.

TEMPERATURE

temerature for flow calcualtion (K). Use temperature from zone if set to “-

DENSITY

density for flow calcualtion (g/cc). Use density from zone if set to “-

TIMESTEP

time step for flow calcualtion (sec). Use current new time step dtnew (p 1) if set to “-

RADIUS

radius for flow calcualtion (cm). Use radius from zone if set to “+

FILENAME

Name of output file.

  • If omitted, data is printed on the screen.

  • If the filename is “-” is specified, then the output tis written to a file with a name of the form nameprob+ncyc (q 4)+ZONE

  • If the filename is matrix a diagnostic of non-zero matrix elements is printed to the screen.

Edit the BURN flows, abundances, partition functions, and reaction rates of zone ZONE for temperature TEMPERATURE (K), density DENSITY (g/cc), and time step TIMESTEP. For neutrino exposure the radius RADIUS (cm) is used or 1.e+99 cm if omitted (no neutrino flux).

If TEMPERATURE or DENSITY are set to “-“, the current values of zone ZONE are used.

If TIMESTEP is set to “-“, the current new time-step dtnew (p 1) is used.

If RADIUS is set to “+”, the current value of zone ZONE is used.

New In Version >16.0.0.

Changed In Version 17.0.2: Add handling of zones similar to the <j> command.

Todo

Add explanation of flow output

kapedit

Write out table for EOS and opacities.

name

parameters

kapedit

ZONE TLOW THI NTEMP DLOW DHI NRHO EPS

kapedit 1 1.E+6 1.E+9 20 1. 1.E+6 30 1.d-8

ZONE

Zone from which to take composition. Processing of zone specification is done similar to the <j> command.

TLOW

starting temperature of table in K

THI

ending temperature of table in K

NTEMP

number of temperature steps

DLOW

starting density of table in g/cc

DHI

ending density of table in g/cc

NRHO

number of density steps

EPS

relative change in temperature and density used for numerical derivatives

Using the composition from zone ZONE, a table of opacity information is written to the screen for a logarithmic grid of temperatures (from TLOW to THI with NTEMP + 1 grid points) and densities (from DLOW to DHI with NRRO + 1 grid points). Here TLOW and THI are in K and DLOW and DHI are in g/cc.

The output is a list of temperature, density, opacity, analytical derivative of the opacity for temperature and density, respectively, numerical derivative of opacity for temperature and density, respectively, using EPS and, finally, the deviations between the numerical and analytical determinations of the derivatives. Numerical derivatives are computed by varying temperature and density by (1+eps).

Changed In Version 17.0.2: added treatment of specification of ZONE similar to <j>.

Changed In Version 17.0.11: corrected to call EOS to update quantities needed in opacity routine.

linkedit

Make an ASCII file containing terse information on structure and composition, e.g., for linking a presupemova model to Wilson (or others).

name

parameters

linkedit

linkedit

Filename will be in the form nameprob@ncyc (q 4).

Deprecated Since Version >15.0.0: This is now done with external commands from the dump files using IDL or Python.

tval

Deprecated. (See source code.).

name

parameters

tval

N ( VALUE ) +

Deprecated Since Version >15.0.0.

Note

The original documentation was:

TVAL N VALl [ VAL2 VAL3 … VALl0 ]

tval 1 .1.3 1. 3. 10. 30. 100.

This command sets values in the temporary array TZ such that TZ(N), TZ(N + 1), …, etc. are respectively reset to VAL1, VAL2,…etc. At least one, and up to 10 values may be specified on each line. This command can be used (repeatedly if necessary) to set or change the TZ array so that it contains the NTEMP EOS table temperature points (in keV), immediately followed by the NRHO density points (in g/cc) required to specify EOS tables. (See the eoswrite command). Attempts to write beyond TZ(NTEMPZ), where NTEMPZ is a parameter currently set to 60, will generate an error message.

Note

This information is not saved in the restart dump.

Warning

This command is no longer supported. See version .tw:kepn:kepn3/25 for the old coding if you want to try to revive it, but see eostable flfst.

rateb

Edit the BURN reaction rates.

name

parameters

rateb

TEMPERATURE DENSITY

rateb 1.d9 1.d5

TEMPERATURE

desired temperature (K)

DENSITY

desired density (g/cc)

Print a table with the content of the sig array for temperature TEMPERATURE (K) and density DENSITY (g/cc).

New In Version >16.0.0.

ratenub

Edit the BURN neutrino reaction rates.

name

parameters

ratenub

R9 TIME

ratenub 10. 1.

R9

radius location (1.e+9 cm)

TIME

time after bounce for evaluation (sec)

Print a table with the signun (neutral current) and signuc (charged current) arrays, and some special reaction rates) for radius R9 (1.e+9 cm) at time TIME (sec) after bounce. If TIME is omitted, 0. is assumed.

Note

Flux goes like 1/r^2 and neutrinot flux decays with time.

ved

Make a ASCII-output-file edit of the zonal edit variable denoted by EDJIVAR from zones JMIN to JMAX, inclusive, similar to z command.

name

parameters

ved

EDITVAR [ JMIN [ JMAX ] ]

ved ionye 1 100

Identical to v command except data is written to file and not to terminal.

vfed

Same as the ved command except that edited values are given to 14 decimal places instead of 3.

name

parameters

vfed

EDITVAR [ JMIN [ JMAX ] ]

vfed ionye 1 100

weightb

Print the BURN statistical weights.

name

parameters

weightb

TEMPERATURE

weightb 1.d8

TEMPERATURE

temperature for evaluation (K)

The g and w arrays are evaluated and printed for temperature TEMPERATURE (K).

New In Version >16.0.0.

wind

Print the APPROX wind information to the screen.

name

parameters

wind

wind

New In Version >15.0.0.

windb

Print the BURN wind information to the screen.

name

parameters

windb

windb

New In Version >16.0.0.

zed

Makes a columnar zonal edit of up to ten EDITVAR arrays and write to ASCII file. Same as z command otherwise.

name

parameters

zed

( EDITVAR )+ [ JMIN [ JMAX ] ]

zed dn tn sige sigi sigr 1 100

zedit

Initiate that a special multiple column ASCII edit of the specified zonal edit variables (EDITVAR+ )to be written every NCYCZED cycles.

name

parameters

zedit

IZED NCYCZED ( EDITVAR )+ [ ZEDMASSl [ ZEDMASS2 ] ]

zedit 1 50 dn tn sige sigi sigr 0. 2.

IZED

Edit variable index number (max nzedz).

NCYCZED

Cycle frequency. Set to 0 to terminate edits.

EDITVAR

Edit variable, see Zonal Edit Varlables.

ZEDMASSl

Lower bound of mass range in scalem (p 273) units or mass coordinate (\pm1\,\%) for which edits are made.

ZEDMASS2

Uper bound of mass range in scalem (p 273) units for which edit is made.

This command causes a special multiple column ASCII edit of the specified zonal edit variables (EDITVAR+) to be written every NCYCZED cycles. Here lZED is an index number (maximum of NZEDZ, which currently is 30, see kepcom) that distinguishes separate zedit requests, and ZEDMASSl and ZEDMASS2 specify an optional interior mass range (in scalem (p 273) units) to be edited. If only ZEDMASSl is specified, a \pm1\,\% range around it is edited, and if no masses are specified, an edit of the whole star is made. Previously specified edits can be changed or terminated by overwriting them with a new zedit command with the same index number.

Note

Setting NCYCZED = 0 ternlinates the edit.

Note

This command is especially useful in generators.

Deprecated Since Version >15.0.0.

Other entry:

Useful Input Cards

Graphics Edit Commands

addiso

Add the detailed isotopic abundances listed to those to be plotted by the “plot 6” or “look 6” commands.

name

parameters

addiso

( ISOSYM ) +

addiso hI he4 c12 o16 mg25 al26

ISOSYM

BURN species symbol

At least 1 and no more than 50 isotopic symbols are to be specified.

arange

Set the mass number range for BURN isotope plots.

name

parameters

arange

NSTART NEND

arange 1 100

NSTART

lower limit of new mass number range

NEND

upper limit of new mass number range

The edit parameters minapro (p 400) and maxapro (p 401) are set to the given values. If no values are specified they are set to their default values (-1000).

burnaplt

Plot the maximum abundances reached in the BURN network.

name

parameters

burnaplt

burnaplt

New In Version >16.0.0.

burnmplt

name

parameters

burnmplt

plot the mass coordinate where maximum abundances reached in the BURN network

burnmplt

New In Version 17.7.3.

burncplt

name

parameters

burncplt

plot the cycle number when maximum abundances reached in the BURN network

burncplt

New In Version 17.7.3.

closewin

Close the graphics window.

name

parameters

closewin

New In Version >15.0.0.

listiso

List the current set of BURN species to be plotted as set by the setiso command.

name

parameters

listiso

l

Same as look.

name

parameters

l

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ]

Deprecated Since Version >15.0.0.

look

Make a movie (deprecated).

name

parameters

look

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ]

look 31 10000 15000 1000

NPLOT

plot type

NCYCL0

start cycle

NCYCL1

end cycle

NDELCYCL

cycle step (delta)

This command makes a movie of plot type NPLOT starting as closely as possible to cycle NCYCL0 and ending as closely as possible to cycle NCYCL1 at intervals as close as possible to NDELCYCL using information from the qq-files specified by setq or (by default) those available for the current problem. Plot types and output modes are as specified in the plot command and by the values of itvstart (p 127). Plot limits are assumed the same as those displayed for the current cycle by plot for this plot type, and can be adjusted using the usual graphics parameters (ipixtype (p 113)). If not specified, NCYCL1 is assumed to be equal to NCYCL0, and NDELCYCL is assumed to be the cycle interval between post-processor dump writes multiplied by idtlook (p 302).

Deprecated Since Version >15.0.0.

lprintl

Same as lpl.

name

parameters

lprintl

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ] [ FILENAME ]

Deprecated Since Version >15.0.0.

lpl

Make a PostScript plot of plot-type NPLOT at cycle NCYCL0 in landscape orientation on the local laser printer.

name

parameters

lpl

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ] [ FILENAME ]

lpl 3 10000 15000 1000 s25n2a.abun

NPLOT

plot type

NCYCL0

start cycle

NCYCL0

end cycle

NDELCYCL

cycle step (delta)

FILENAME

base for filenames for output

NPLOT is as defined in the plot command and use is made of infonnation from the qq-files specified by setq or (by default) those available for the current problem. If a FILENAME is specified, then the picture is also saved in a Postscript file with that name. If NCYCL1, or both NCYCL1 and NDELCYCL, are given (before FILENAME, if any is specified), then a series of prints will be produced starting at “look” cycle NCYCL0 and continuing to “look” cycle NCYCL1 at intervals of NDELCYCL. A ‘:’ followed by the current “look” cycle number will be appended to the FILENAME specified (but limited to a total of 16 characters).

Deprecated Since Version >15.0.0.

lprintp

Same as lpp.

name

parameters

lprintp

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ] [ FILENAME ]

Deprecated Since Version >15.0.0.

lpp

Make a PostScript plot of plot-type NPLOT at cycle NCYCL0 in portrait orientation on the local laser printer.

name

parameters

lpp

NPLOT NCYCL0 [ NCYCL1 [ NDELCYCL ] ] [ FILENAME ]

lpp 3 10000 15000 1000 s25n2a.abun

Same as lpl except paper orientation.

Deprecated Since Version >15.0.0.

maplim

Defines the limits of the timemap variables.

name

parameters

maplim

[ VMINMAP YMAXMAP [ VRATMAP ] ]

maplim 7. 9. 1.e-5 '

VMINMAP

new value for vminmap (p 328)

YMAXMAP

new value for vmaxmap (p 329)

VRATMAP

new value for vratmap (p 330)

This command defines the limits of the timemap variables by setting the values of parameters vminmap (p 328), vmaxmap (p 329), and vratmap (p 330). If no arguments are given, the entire range of the variable is mapped. If the specified values of VMINMAP and VMAXMAP are equal, they are reset to 1.e+99 and -1.e+99, respectively, resulting in the actual range of the variable being limited only by vratmap (p 330) (see vminmap (p 328) - vratmap (p 330)).

Deprecated Since Version >15.0.0: timemaps/look no longer functional

mlim

Set lower and upper limits on the relative mass coordinate used in making plots and timemaps to YMLOW and YMHI (in units of Msun).

name

parameters

mlim

[ ( [ YMLOW ] YMHI ) | old ]

mlim 2.1 10.
mlim old

YMLOW

lower limit for plot relative mass coordinate

YMHI

upper limit for plot relative mass coordinate

old

restore previous values

This is accomplished by resetting yplotmin (p 134) to YMLOW \times Msun/zm(jm (q 2)) and yplotmax (p 135) to YMHI \times Msun/zm(jm (q 2)). If only YMHI is provided then yplotmin (p 134) is set to zm(0)/zm(jm (q 2)). If no arguments are given, or if YMLOW = YMHI, then yplotmin (p 134) is set to zm(0) and yplotmax (p 135) is set to 1.. If the second argument is the flag “old” then the previous values of yplotmin (p 134) and yplotmax (p 135) are restored.

Changed In Version >16.0.0: Normalization relative to mass coordinate at surface, zm(jm (q 2)) which is totm (q 17) + summ0 (p 61). Previously, normalization was with respect to total mass on grid, totm (q 17), only. Added option to call with single mass coordinate YMHI (upper limit). If no arguments were provided, yplotmin (p 134) used to be set to 0.

m

Same as mon command except that mongo is quit immediately after making the plot.

name

parameters

m

( EDITVAR )+ [ AXISYL [ AXISYR ] ]

mongo

Same as mon.

name

parameters

mongo

( EDITVAR )+ [ AXISYL [ AXISYR ] ]

mon

Make an X-Window MONGO plot.

name

parameters

mon

( EDITVAR )+ [ AXISYL [ AXISYR ] ]

mon dn tn log lin

EDITVAR

Edit variable, see Zonal Edit Varlables. Up to 7 may be provided.

AXISYL

layout of LHS y-axix, “log”, “lin”, or “same

AXISYR

layout of RHS y-axix, “log”, “lin”, or “same” if AXISYL is not , “same

This command makes an X-Window MONGO plot of the first two zonal edit variables listed (EDITVAR+) vs. the mass coordinate specified by the value of parameter irtype (p 132). It leaves the user in interactive MONGO, where the graph may be modified or printed before typing “end” to return to KEPLER.

Note

Either itvstart (p 127) must be set to 1 or an X Graphics Window for KEPLER must already be open (e.g., as a result of the PLOT conunand) for this command to have any effect.

The mass coordinate is loaded into MONGO data column 1, and the corresponding values of each zonal edit variable, EDITAR, is loaded into MONGO subsequent data columns. At least one, and no more than seven zonal edit variables (EDllVAR+) must be specified. On entry into MONGO, graphs of the first one or two (if specified) variables are made automatically vs. the specified mass coordinate. The range of mass coordinate plotted is controlled by yplotmin (p 134) and yplotmax (p 135) which are the innermost and outermost relative mass coordinates to plot.

For most quantities, the ordinate is logarithmic by default (with negative data values, or a small range of values, defaulting the plot instead to be linear), but can be set explicitly by setting AXISYL and/or AXISYR to “lin” or “log”. The code assumes that one “lin” or “log” value appended to the command line (after at least one EDITVAR) refers to AXISYL, the flag for plotting the first EDITVAR. If two “lin” or “log” values are appended, they are interpreted as AXISYL and AXISYR, the flags for plotting the first EDITVAR and second EDITVAR, respectively.

The flag “same” can also be used as the last word on the command line in order to set the axis type for plotting the second EDITVAR to be the same as for the first EDITAR, except that the axis limits are expanded to cover the extremes of both variables. “same” flag can be proceeded by at most one “lin” or “log” flag specifying the common axis type. If an axis type is not given, a default value is chosen according to the character of the data.

moncard    ::=  "mon" varlist yscalespec
varlist    ::=  editvar+
yscalespec ::=  [ yscale ] [ yscale | "same" ]
yscale     ::=  "lin" | "log"

Once in interactive MONGO, you can (among other things):

  • Type:

    curses
    

    to get mouse coordinate display, corresponding to the values of the last-defined axes.

  • Type:

    help
    

    to get a list of interactive MONGO commands.

  • Type the command sequence:

    psland FILENAME
    play
    hard
    

    get a PostScript file named “FILENAME” containing the currently displayed plot. File “FILENAME” must not already exist.

  • Type:

    end
    

    to quit interactive MONGO.

monpl

MONGO plot is printed in landscape mode on the local laser printer.

name

parameters

monpl

( EDITVAR )+ [ AXISYL [ AXISYR ] ]

Like the mon command, except that the requested plot is printed in landscape mode on the local laser printer and MONGO quits, instead of the plot being displayed in an x-window and MONGO left in interactive mode.

monpp

MONGO plot is printed in portrait mode on the local laser printer.

name

parameters

monpp

( EDITVAR )+ [ AXISYL [ AXISYR ] ]

Like the mon command, except that the requested plot is printed in portrait mode on the local laser printer and MONGO quits, instead of the plot being displayed in an x-window and MONGO left in interactive mode.

pt

Sampe as plot.

name

parameters

pt

[ NPLOT ]

plot

Make an X-Window plot of the status of the current problem of the type specified by plot number NPLOT.

name

parameters

plot

[ NPLOT ]

plot 31

NPLOT

numerical plot layout (see ipixtype (p 113))

Note

Either itvstart (p 127) must be set to 1 or an X Graphics Window for KEPLER must already be open (e.g., as a result a previous plot command) for this command to have any effect.

Currently allowed values of NPLOT are the same as those allowed for parameter ipixtype (p 113) and produce the same types of plots.

printl

Same as pl command.

name

parameters

printl

[ NPLOT ] [ FILENAME ]

pl

Make a PostScript plot of the current problem status in landscape orientation.

name

parameters

pl

[ NPLOT ] [ FILENAME ]

pl
pl 31
pl myplot.ps
pl 31 myplot.ps
pl myplot.ps 31

NPLOT

numerical plot layout (see ipixtype (p 113))

FILENAME

filename to which the plot is made

NPLOT is the plot type defined in the same way as in the plot command. If NPLOT is not specified, it is taken to be ipixtype (p 113).

If FILENAME is specified, the picture is saved in a PostScript file with that name, if omitted, it is printed on the local laser printer instead.

Changed In Version >15.0.0: Removed automatic printing and file name generation.

Changed In Version 17.0.2: FILENAME can be specified without specifying NPLOT

Note

The original documentation states:

If 'ok' is given for FILENAME, a new file-name is generated
automatically in the form NAMEPROB:NCYC, where NAMEPROB is
the current problem name and NCYC is the current cycle.

pp

Samme as printp.

name

parameters

pp

[ NPLOT ] [ FILENAME ]

printp

Make a PostScript plot of the current problem status in portrait orientation.

name

parameters

printp

[ NPLOT ] [ FILENAME ]

pp 31 myplot.ps

Same as pl excpet orientation.

setiso

Sets the detailed isotopic abundances to be plotted by the “plot 6” or “look 6” commands.

name

parameters

setiso

ISOSYM{1,50}

setiso h1 he4 c12 016 mg25 a126

ISOSYM

symbol of species from BURN network

At least 1 and no more than 50 isotopic symbols must be specified from the set of current BURN isotopic symbols.

setlib

Set the dump library file and associated parameters to be used in making time-plots.

name

parameters

setlib

[ NAMETLIB [ NCYCT0 [ NCYCT1 [ NCYCTDEL [ NCYCQQT [ LENTDMPT [ NIYMAXT ] ] ] ] ] ] ]

setlib s25s2a.lib 0 18345 10 5 384 20000

NAMETLIB

Name of desired dump library file. The default is the one for the current job.

NCYCT0

First dump cycle to be read and plotted. Default is 0.

NCYCT1

Last dump cycle to be read and plotted. Default is last cycle in dump library.

NCYCTDEL

The interval in dump cycles between dump library reads. Default is ncycqq (p 299).

NCYCQQT

Number of cycles between dump library dumps. Default is ncycqq (p 299).

LENDMPT

Length of each time dump in NAMETLIB. Default is 384.

NIYMAXT

Maximum number of IY coordinate values in NAMETLIB. Default is 20000.

If setlib is not called, the default values are set when timeplot or tp is first called. Calling setlib without arguments resets all these variables to their default values if they have previously been changed by a setlib command.

Deprecated Since Version >15.0.0.

setq

Set the names of the qq-files to be post-processed by other commands such as look, lprintl, etc.

name

parameters

setq

[ NAMEQQL0 [ NAMEQQLl ] ]

setq s25s2a.qa s25s2a.qk

NAMEQQL0

first member of the sequence of qq-files to be read

NAMEQQL1

last member of the sequence of qq-files to be read

When used without arguments, setq implies that all the qq files for the current problem in the current working directory are to be used.

Note

This is the default situation for most post-processing commands and that setq only has to be used in this mode to restore the specified qq-files to this default.

If only NAMEQQL0 is specified, all available qq-files in the sequence starting with NAMEQQL0 will be read.

Note

qq-file names can be up to 16 characters long (at least on UNIX machines) and need not be those generated by the current problem.

Deprecated Since Version >15.0.0.

tm

Same as timemap.

name

parameters

tm

NAMEVAR [ LOGFLAG [ NCYCL0 [ NCYCL1 [ NDELCYCL ] ] ] ]

Deprecated Since Version >15.0.0.

timemap

Makes a space-time map for zonal edit variable NAMEVAR starting as closely as possible to cycle NCYCL0 and ending as closely as possible to cycle NCYCL1.

name

parameters

timemap

NAMEVAR [ LOGFLAG [ NCYCL0 [ NCYCL1 [ NDELCYCL ] ] ] ]

timemap convect lin 0 18750 1

NAMEVAR

name of plot variable from qq file

LOGFLAG

specify the desired scaling for the variable being displayed, “log” or “lin

NCYCL0

start cycle

NCYCL1

end cycle

NDELCYCL

cycle step (delta)

Uses information from the qq-files specified by setq or (by default) those available for the current problem.

The mass coordinate axis type and limits is set by the same parameters as for normal KEPLER plots. For details, see the comments for the timemap routine for other relevant input parameters.

If not specified, NCYCLl, is assumed to be the last cycle for which infonnation is available in the qq-files specified by setq, and NDELCYCL is assumed to be the cycle interval between post-processor dump writes multiplied by idtlook (p 302). If a colormap whose name is in the form, NAMEVAR.map (e.g., “convect.map”), is available in the local directory (or as a second alternative, is in the directory “/usr/local/map”), it will be used to make the plot. Otherwise a simple default rainbow-style map, “usr/local/map/spectral.map”, will be used. After the plot is made, the user can manipulate it further (including changing to a new variable and/or color map) by using the menus displayed when the right mouse button is depressed. Depressing the left mouse button displays an overlay rectangle that can be positioned and/or stretched to indicate a time-space region to zoom into and replot.

Warning

This command currently only works on a Silicon Graphics terminal.

Deprecated Since Version >15.0.0.

tp

Same as timeplot.

name

parameters

tp

( TIMEVAR )+ [ AXISYL AXISYR ]

Deprecated Since Version >15.0.0.

timeplot

Make an X-Window plot of the first two time-edit variables listed (TIMEVAR+) vs. the time coordinate specified by the value of maptime (p 327).

name

parameters

timeplot

( TIMEVAR )+ [ AXISYL AXISYR ]

timeplot eni enk enp log same

TIMEVAR

Name of plot variable from qq file. Up to 7 may be provided.

AXISYL

layout of LHS y-axix, “log”, “lin”, or “same

AXISYR

layout of RHS y-axix, “log”, “lin”, or “same” if AXISYL is not , “same

Leaves the user in interactive MONGO, where the graph may be modify or printed before typing “end” to return to KEPLER.

Note

Either itvstart (p 127) must be set to 1 or an X Graphics Window for KEPLER must already be open (e.g., as a result of the plot command) for this command to have any effect.

Unless a setlib command has previously been issued to the contrary, the time histories for these variables are read from the “.lib” file for the current problem for the entire range of available cycles. The time coordinate is loaded into MONGO data column 1, and the corresponding time sequence for each timeplot variable, TIMEVAR, is loaded into subsequent MONGO data columns. At least one, and no more than seven time-edit variables (TIMEVAR) must be specified.

The range of the time coordinates plotted is controlled by timecmin (p 321) and timecmax (p 322) and defaults to the entire available range. For most quantities, the ordinate is logarithmic by default (with negative data values or a small range of values defaulting the plot instead to linear), but axis type can be set explicitly by setting AXISYL and/or AXISYR to “lin” or “log”. The code assumes that one “lin” or “log” value appended to the command line (after at least one TIMEVAR) refers to AXISYL, the flag for plotting the first TIMEVAR. If two “lin” and/or “log” values are appended, they are interpreted as belonging to the first and second TIMEVAR, respectively. The flag “same” can also be used as the last word on the command line in order to set the axis type for plotting the second TIMEVAR to be the same as for the first TIMEVAR, except that the axis limits are expanded to cover the extremes of both variables. The “same” flag can be proceeded by at most one “lin” or “log” flag specifying the common axis type. If an axis type is not given, a default value is chosen according to the character of the data.

timeplotcard ::=  "timeplot" varlist yscalespec
varlist      ::=  timevar+
yscalespec   ::=  [ yscale ] [ yscale | "same" ]
yscale       ::=  "lin" | "log"

Once in interactive MONGO, you can (among other things):

  • Type:

    curses
    

    to get mouse coordinate display, corresponding to the values of the last-defined axes.

  • Type:

    help
    

    to get a list of interactive mongo commands.

  • Type the command sequence::

    psland FILENAME
    play
    hard
    

    to get a PostScript file named FILENAME containing the currently displayed plot. File FILENAME must not already exist.

  • Type:

    end
    

    to quit interactive MONGO.

Deprecated Since Version >15.0.0.

tppl

Like the timeplot command, except that the requested plot is printed in landscape mode on the local laser printer and MONGO quits, instead of the plot being displayed in an x-window and MONGO left in interactive mode.

name

parameters

tppl

( TIMEVAR )+ [ AXISYL AXISYR ]

Deprecated Since Version >15.0.0.

tppp

Like the timeplot command, except that the requested plot is printed in portrait mode on the local laser printer and MONGO quits, instead of the plot being displayed in an x-window and MONGO left in interactive mode.

name

parameters

tppp

( TIMEVAR )+ [ AXISYL AXISYR ]

Deprecated Since Version >15.0.0.

tlim

Set limits on the time coordinate used in making timeplots and timemaps by resetting the values of TIMECMIN and TIMECMAX to the specified values.

name

parameters

tlim

[ ( TIMECMIN TIMECMAX ) | old ]

tlim -15.3 -10.
tlim old

TIMECMIN

lower limit for time coordinate used in time plots

TIMECMAX

upper limit for time coordinate used in time plots

old

restore previous values

If no arguments are given or if TIMECMIN = TIMECMAX, then all available time points are plotted.

Note

Time-coordinate units are specified by maptime (p 327) and must be floating point numbers.

If the second argument is the flag “old” then the previous values of timecmin (p 321) and timecmax (p 322) are restored.

Deprecated Since Version >15.0.0: No longer used/needed.

ylim

Sets the y-axes limits on MONGO plots.

name

parameters

ylim

[ YLLOWMON YLHIMON [ same | ( YRLOWMON YRHIMON ) ] ]

ylim 3. 5.
ylim 3. 5. same
ylim 3. 5. 0.44 0.5

YLLOWMON

lower limit for the variable plotted on the left-hand y-axis

YLHIMON

upper limit for the variable plotted on the left-hand y-axis

YRLOWMON

lower limit for the variable plotted on the right-hand y-axis

YRHIMON

upper limit for the variable plotted on the right-hand y-axis

same

if specified in place of the right-hand y-axis limits, those will be set to be the same as for the left-hand y-axis

If no arguments are specified for a given axis, or if their high and low values are equal, then the entire range of the corresponding variable will be plotted.

Abundance and Production Factor Plots

pf

Plot production factor of all stable isotopes relative to solar after decay.

name

parameters

pf

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

pf
pf wind
pf 1 9999

approx

everything in the APPROX network plus the wind is summed up

burn

everything that is processed by the BURN network, i.e., that has a mass coordinate at the base of the zone bigger than bmasslow (p 419), plus the wind is summed up

wind

only the wind is summed up

ZSTART

Single zone or lower bound of range of zones to be summed.

ZEND

Upper bound zone to be summed.

If only ZSTART is specified, ZEND is assumed to be equal to ZSTART. If neither ZSTART or ZEND is given, then ZSTART = 1 and ZEND = jm (q 2), the index of the current outer zone.

If only ZSTART is supplied, processing of zone specification is done similar to the <j> command. If the resulting zone is beyond the outer boundary of the star, the wind “zone” is summed up. 0 corresponds to just the surface zone.

If both both ZSTART and ZEND are supplied, processing is similar to the sumb command. If there is an “overflow” (one of the processed zone specifications is beyond the outer boundary of the star), the wind is included. That is, to include everything in star above a given shell number but excluding the wind, 0 (zero) should be chosen as upper boundary. If both ZSTART and ZEND are beyon the upper edge of the star, then only the wind shown.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

YD

Plot mass of all stable isotopes after decay (Msun).

name

parameters

YD

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

YD
YD approx
YD 1 0

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

yd

Plot mass fraction of all stable isotopes after decay.

name

parameters

yd

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

yd
yd approx
yd 1 0

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

Y

Plot mass of all isotopes (Msun).

name

parameters

Y

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

Y wind

Stable isotopes are indicated by filled circles, unstable isotopes are shown as hollow circles.

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

y

Plot mass fraction of all isotopes.

name

parameters

y

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

y wind

Same as y otherwise.

pfe

Plot production factor of all elements relative to solar after decay.

name

parameters

pfe

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

pfe
pfe burn

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

pfa

Plot production factor of all isobars relative to solar after decay.

name

parameters

pfa

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

pfa
pfa burn

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

ya

Plot yield of all isobars.

name

parameters

ya

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

ya
ya burn

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

yda

Plot yield of all isobars relative after decay.

name

parameters

yda

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

yda
yda burn

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

YE

Plot mass of all elements (Msun).

name

parameters

YE

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

YE

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

YA

Plot decayed mass of all isobars (Msun).

name

parameters

YA

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

YA

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

YDE

Plot mass of all elements after decay (Msun).

name

parameters

YDE

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

YDE

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

YDA

Plot mass of all isobars after decay (Msun).

name

parameters

YDA

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

YDA

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: Genral processing of zone specifications

Ye

Plot decayed mass of all elements (Msun).

name

parameters

Ye

[ approx | burn | wind | ( ZSTART [ ZEND ] ) ]

Ye

Same as pf otherwise.

New In Version >16.0.0.

Changed In Version 17.0.2: The command was renamed form ye to Ye a name clash with the ye cards.

Added general processing of zone specifications.

Special Purpose Commands

null

Do nothing.

name

parameters

null

*

Execute special section from command file.

name

parameters

*

SENTINEL

* t9

SENTINEL

sentinel of special section to execute

If a the command file contains a specila section, e.g.,

* t9
d #t9
end

this would be executed with the sample command given above.

Note

If the special section does not exits, nothing happens and no error is issued.

New In Version 17.0.2.

/

Add command after “/” at the end of command file.

name

parameters

/

COMMAND

/ *
/ @tn(1)>1.d9
/ d #tc9
/ end

COMMAND

string to add to command file

See the page on command files for command file name resolution rules.

New In Version 17.0.2.

Other entry:

Useful Input Cards

!

Re-execute previous command from history.

name

parameters

!

[ NUMBER ]

! 3

NUMBER

Number of how many command back to re-execute. The default is 1.

A better way of doing this including editing of previous commands is to use rlwrap, e.g., staring KEPLER using

rlwrap kepler s12#presn s

New In Version >16.0.0.

!!

Lists the last commands, last command last, and their number in the list.

name

parameters

!!

This is useful in combination the ! command.

New In Version >16.0.0.

adapnet

Manually call subroutine adapnet to adapt network.

name

parameters

adapnet

New In Version >16.0.0.

addatmos

Add an isothermal, exponential atmosphere to the surface of the star.

name

parameters

addatmos

NATMOS RHOATM1 [ TEMPATM ]

addatmos 10 3.e-12

NATMOS

number of atmosphere zones

RHOATM1

cut-off sensity for atmosphere

TEMPATM

temperature of atmosphere

The atmosphere consists of NATMOS zones and extending out to a density of RHOATM1 (g/cc). The atmospheric conditions are scaled from the surface gravity, density, temperature and radius of the outer zone. The atmosphere is assumed to be thin (slab-like) compared to the star’s radius and its composition is taken to be the same as that of the outer zone. If TEMPATM (K) is specified, it is used instead of the temperature of the outer zone in constructing the atmosphere.

addlook

Add zonal edit variable EDlTVAR to the list of “look” variables that subroutine READQ reads from the qq dump files.

name

parameters

addlook

EDITVAR [ delete ]

addlook sneut delete

EDITVAR

Edit variable, see Zonal Edit Varlables.

delete

EDITVAR is deleted from the list of look variables instead of added.

Note

All current commands such as plot automatically load their own ‘look’ lists and then return the list to its original state when they are finished. Future commands, however, may require the use of addlook.

Deprecated Since Version >15.0.0.

addsurf

Add isothermal surface zones with specified properties.

name

parameters

addsurf

[ MSURF | ( NSURF TMSURF TEMPSURF RHOSURF VELSURF [ [ AWSURFX AWSURFY ] AWSURFZ ] ) ]

addsurf 10 1.E+32 1.E+4 1.E-11 0.

MSURF

Amount of mass to add as a single zone (g)

NSURF

number of zones to be added

TMSURF

total mass of zones to be added (g)

TEMPSURF

temerature of zones

RHOSURF

density of zones

VELSURF

velocity of zones

AWSURFX

angular velocity of zones in x-direction

AWSURFY

angular velocity of zones in y-direction

AWSURFZ

angular velocity of zones in z-direction

Add NSURF zones of equal mass totaling TMSURF total mass (g) with temperature, TSURF (K), density, RHOSURF (g/cc), velocity, VELSURF (cm/sec), and the composition last specified by the compsurf command.

If (only) MSURF is specified, zone of this mass (g) will be accreted and xmacrete (p 212) will be reduced by this amount or set to 0 if MSURF > xmacrete (p 212).

If no parameter is given, the mass of the current “phantom zone” xmacrete (p 212) is added as a new zone to the grid and xmacrete (p 212) is set to zero.

If AWSURFX, AWSURFY, AWSURFZ are not provided, the angular velocity value from the outermost zone is used; if only AWSURFZ is provided, the other two are set to 0..

Note

Each time addsurf is called, the sum of the mass fractions in the compsurf array is normalized to unity.

Changed In Version >16.0.0: Add MSURF and call variant without options.

Changed In Version 17.11.7: Add AWSURFX AWSURFY AWSURFZ

alias

Define alias.

name

parameters

alias

NAMEA COMMAND-STRING

alias tl "tq, 1, 1 i"

NAMEA

name of alias to (re)define

COMMAND-STRING

command sting, less than 71 characters long

Note

COMMAND-STRING must be enclosed in double quotes

Define alias NAMEA to invoke the command string COMMAND-STRING. COMMAND-STRING must be enclosed in double quotes and be less than 71 characters long. The command string may be a series of comma-delimited TTY commands. Note that the entire alias command may not exceed 80 characters and may not, itself, be comma-delimited. There is a limit of 200 (ncsavedz) total aliases.

adzone

Manually adzone zones ZONE-ZONE+1 to zones ZONE-ZONE+2.

name

parameters

adzone

ZONE

adzone 2
adzone -1

ZONE

Zone where to insert new zones. Processing of zone specification is done similar to the <j> command.

New In Version >16.0.0.

Changed In Version 17.0.2: Added general zone processing similar to the <j> card.

dezone

Manulally dezone zones ZONE-ZONE+2 to zones ZONE-ZONE+1.

name

parameters

dezone

ZONE [ - ]

dezone 2
dezone -2

ZONE

Zone where to insert new zones. Processing of zone specification is done similar to the <j> command.

-

ignore gradient constraints on rejecting “dezoning”

New In Version >16.0.0.

Changed In Version 17.0.2: Added general zone processing similar to the <j> card.

alliso

Generate a BURN network that contains all isotopes from the bdat file (plus p, n, he4).

name

parameters

alliso

alliso

Useful for debugging purposes. For real simulations use the adaptive network instead.

New In Version >16.0.0.

box

Change the output box number to BOX#.

name

parameters

box

BOX#

box v9S

BOX#

new output box numer, three character symbol

Deprecated Since Version >15.0.0.

bstat

Print out current BURN statistics and timing information.

name

parameters

bstat

bstat

New In Version >16.0.0.

burn

Do BURN processing of zone 1 according to provided history file.

name

parameters

burn

DATAFILE

burn burndata.dat

DATAFILE

file with burn history data

Note

Not yet implemented.

addwind

Add wind surface zones.

name

parameters

addwind

NWIND WINDMASS RATEWIND VELWIND [ VESCMULT [ TEFFWIND [RADPWIND [ [ AWWINDXAWWINDY] AWWIND ] ] ] ] ]

addwind 5 1.0e-5 1.e-4 10. 1. 3.098e+3 3.443e+13

NWIND

number fo wind zones to add

WINDMASS

total mass of wind (Msun)

RATEWIND

mass-loss rate (Msun/yr)

VELWIND

wind terminal velocity (km/sec)

VESCMULT

escape-velocity multiplier

TEFFWIND

effective photospheric temperature (K)

RADPWIND

radius used (cm)

AWWINDX

angular x-velocity of wind zones (rad/sec)

AWWINDY

angular y-velocity of wind zones (rad/sec)

AWWINDZ

angular z-velocity of wind zones (rad/sec)

Add NWIND zones of equal mass totaling WINDMASS (Msun) with mass-loss rate RATEWIND (Msun/yr), terminal velocity VELWIND (km/sec). Optional inputs are the escape-velocity multiplier, VESCMULT (default 1.) and the effective photospheric temperature TEFFWIND (K) and radius RADPWIND (cm) used in generating the wind profile. The mass-loss rate is assumed to stay constant at RATEWIND during the time these zones “took” to leave the surface of the star, and the velocity at any point is the sum of the local escape velocity times VESCMULT and the wind’s terminal velocity, VELWIND. The wind’s local temperature is calculated by assuming that it is in LTE with the photosphere specified by TEFFWIND and RADPWIND. If no explicit values of these photospheric variables are given, they default to the existing photospheric temperature (teff (q 48)) and radius (radius (q 47)). The composition of the wind is taken to be the same as that of the outer zone.

If AWWINDX, AWWINDY, AWWINDZ are not provided, the angular velocity value from the outermost zone is used; if only AWWINDZ is provided, the other two are set to 0..

Note

Several addwind commands can be used in succession to build up a wind with a time-dependent mass-loss rate, or to achieve non-constant-mass zoning.

Changed In Version 17.11.7: Add AWWINDX AWWINDY AWWINDZ

check

Type out the number of errors (NIOERR) the code has encountered sending out ASCII output files since the last restart.

name

parameters

check

Warning

This command is only meaningful on a CRAY computer.

Deprecated Since Version >15.0.0.

chngcomp

Change the composition in zones JMIN through JMAX.

name

parameters

chngcomp

ZONE ZONE [ ZONEORG | ( FIRSTION# ( MFRAC )+ ) | ( MFRAC ION )+ ]

chngcomp 10 20 1 0. 0. 0. 0. 0. .5 0. .5
chngcomp 0 -10 -11
chngcomp 0. 1. 0.

JMIN JMAX

Zone range (inclusive) in which to change composition. Processing of the zone specifications is done the same way as for the sumb command.

ZONEORG

Zone from which to copy composition. Processing of the zone specifications is done the same way as for the <j> command.

FIRSTION#

number of first ion in APPROX network

MFRAC

new mass fraction of ion

ION

name of ion from APPROX network

Change the composition in zones JMIN through JMAX to the ion mass fractions specified. At least one and up to eight mass fractions can be given on the command line. The compositions changed begin with that of the ion corresponding to APPROX ion number FIRSTION# and continue on in ion number order. All other mass fractions are set to 0..

Alternatively, ions can be specified ion-by-ion giving pairs of mass fraction, MFRAC, and the APPROX ion name, ION.

If an orgin zone, ZONEORG is specified, the composiiton information from that zone is copied.

If no ions are specified, the information currently stored in the xnwcomp array is used to set the composition of the zones. The information in that array can be changed using the setcomp and copycomp commands and be viewed using the prncomp command.

setcomp clear
setcomp 6 .5
setcomp 8 .5
prncomp
chngcomp 10 20

Mass fractions will be renonnalized to sum to unity, and the equation of state will be recomputed for the new composition. All old abundance information from these zones is disregarded. Check zonal compositions afterwards using the “<j> i” command.

Warning

Radically altering the composition in any zone may cause discontinuous changes in its internal energy, pressure, etc. and lead to convergence problems. Take special care in degenerate cases. The newe command may be useful here.

Note

The user takes full responsibility for any misleading and/or unphysical results that may be produced due to the use of this command.

Warning

BURN abuncaes are not copied in the present version. Hence this command should not be used with lburn (p 434) = 1, with iburnye (p 357) = 1, or just with BURN in general.

Changed In Version 17.0.2: Added generalized zone specification. Added automatic resetting of xnwcomp if mass fractions are specified.

Note

The command description used to state:

::

Non-specified abundances are given whatever garbage values may have initially been in xnwcomp and multiple use of this command is complicated by the fact that the mass fractions of the current contents of the xnwcomp array are renormalized to unity after each use.

Repeated use of this command can set all the elements in the XNWCOMP array in subroutine TTYCOM (which is then used to change the zonal abundances).

compsurf

Set the mass fraction values in the compsurf array.

name

parameters

compsurf

[ ( FIRSTION# ( MFRAC )+ ) | ( MFRAC ION )+ | ZONEORG | clear | show ]

compsurf
compsurf -1
compsurf -1.
compsurf clear
compsurf 1 0. .7 0. 0. .28 0. .02
compsurf show


number of first ion in |APPROX| :ref:`network <ion>`

MFRAC

new mass fraction of ion

ION

name of ion from APPROX network

ZONEORG

Zone from which to copy composition. Processing of the zone specifications is done the same way as for the <j> command.

clear

reset compsurf array to all 0.

show

show current content of compsurf array

These compositions are used to set the composition of the surface zones added by the addsurf command.

Starting with its FIRSTION#th entry, set the values of subsequent entries of the compsurf array in kepcom equal to the list of MFRAC+ vlaues given. At least one, and up to 10 such values can be given on each command line. Repeated use of this command can thus set all the elements of the compsurf array. The compositions are numbered corresponding to APPROX ion number.

Alternatively, ions can be specified ion-by-ion giving pairs of mass fraction, MFRAC, and the APPROX ion name, ION.

If just ZONEORG is given, the composition of that zone is used to initialize the compsurf array.

If no parameter is specified, the composition of the outermost zone is used to initialize the compsurf array.

Warning

It is quite useful to use the clear option to reset the compsurf array before setting values. If that has not been done before, the content of the array may be undefined.

Note

This array is stored in the restart dump for later use.

Note

Note that by default the abundances of the outermost zone are copied in the surface composition vectors on problem generation so that, if this is desired, no additional compsurf or compsurb commands are required.

New In Version >16.0.0.

Changed In Version 17.0.2: Added to allow multiple ion abundances simialr to the generator m card.

Changed In Version 17.0.2: The undocumented behavior that compsurf without argumnets also does the same operation for compsurfb has been discontinued.

cpzone

Copy composition from zone ZONE_FROM to zone range specified by ZONE_TO_LOW and ZONE_TO_HIGH.

name

parameters

cpzone

ZONE_FROM ZONE_TO_LOW ZONE_TO_HIGH [ MODE ]

cpzone 107 1 106 ltg

ZONE_FROM

Zone from which to copy composition and thermodynamic properties (if requested). Processing of the zone specifications is done the same way as for the <j> command.

ZONE_TO_LOW ZONE_TO_HIGH

Zone range (inclusive) in which to change composition and thermodynamic properties (if requested). Processing of the zone specifications is done the same way as for the sumb command.

MODE

Specifies the adjustment of thermodynamics on the copied zone. If omitted, the zone temperatures is not changed.

Currently all modes by default keep the zone density. Otherwise zone radii in the entire star would have to be adjusted.

The following values for temperature extrapolation are implemented:

value

result

(none)

keep temperature

ct

copy temperature of ZONE_FROM

ita

ideal gas temperature extrapolation adiabatic (\gamma=5/3)

rta

relativistic gas temperature extrapolation adiabatic (\gamma=4/3)

ltg

local gradient temperature extrapolation

tpn

temperature exponent to fit pn(ZONE_TO_LOW)

h

adjust temperature to get same pressure and density

New In Version >16.0.0.

Note

Useful to convert a last bit of fuel in the center if a low-mass star to the compostion of the layers above.

cnviso

Convert fraction FRACTIO of BURN isotope ISO_FROM to BURN isotope ISO_TO in zones ZONE_START to ZONE_END.

name

parameters

cnviso

ISO_FROM ISO_TO FRACTION ZONE_START ZONE_END

conviso c13 c12 1. 1 0

ISO_FROM

source isotope symbol

ISO_TO

target isotope symbol

FRACTION

fraction of isotope to convert

ZONE_START ZONE_END

Zone range (inclusive) in which to change composition. Processing of the zone specifications is done the same way as for the sumb command.

Warning

At this time, this is all that happens; APPROX is not updates, neither are any thermodynamic quantities. Therefore you should use this command only with small mass fractions.

New In Version >16.0.0.

Changed In Version 17.0.2: Added general processing of zone specifications.

clampvel

Limit magnitude of velocity.

name

parameters

clampvel

VELOCVITY

clampvel 1.d9

VELOCITY

maximum magnitude of allowed velocity

All velocties with larger absolute value are truncated.

New In Version >15.0.0.

compsurb

Set the mass fraction values in the compsurfb array.

name

parameters

compsurb

[ ( FIRSTION# ( MFRAC )+ ) | ( MFRAC ION )+ | ZONEORG | clear | show ]

compsurb .02 n14 .7 he4 .28 he4

Same behaviour as compsurf but for the BURN isotope array compsurfb.

New In Version >16.0.0.

mapsurfb

Map compsurfb array to compsurf array.

name

parameters

mapsurfb

mapsurfb

This command is useful to first set up detailed isotopic abunances in compsurfb using the compsurb command, then mapping these to compsurf instead of specifying the values for the compsurf array separately using the compsurf command.

New In Version >16.0.0.

copycomp

Setup xnwcomp array by copying the composition information from ZONEORG.

name

parameters

copycomp

ZONEORG

copycomp 1

ZONEORG

Zone from which to copy composition. Processing of the zone specifications is done the same way as for the <j> command.

The xnwcomp array is used in the chngcomp command.

See also

setcomp

Note

setcomp does the same and more…

New In Version >16.0.0.

scalewnd

Scale wind array.

name

parameters

scalewnd

scalewnd

Help procedure to correct a bug in versions before 15.23. Both, wind and windb arrays are updated.

New In Version 15.23.0.

Deprecated Since Version >15.23.0.

Note

may be removed if no longer needed

addwnd

Add mass to wind array.

name

parameters

addwnd

IONSYM MASS

addwnd c12 1.37d33

IONSYM

symbol of ion to which mass is added in wind array

MASS

amount of mass to add.

Help procedure to correct a bug in versions before 15.23

New In Version 15.23.0.

Deprecated Since Version >15.23.0.

Note

may be removed if no longer needed

addwndb

Add mass to windb array.

name

parameters

addwndb

IONSYM MASS

addwnd c12 1.37d33

IONSYM

symbol of ion to which mass is added in wind array

MASS

amount of mass to add.

Help procedure to correct a bug in versions before 15.23

New In Version 15.23.0.

Deprecated Since Version >15.23.0.

Note

may be removed if no longer needed

cutbin

Manually truncate binary output files to current cycle.

name

parameters

cutbin

cutbin

Note

The use of this command should rarely be necessary in current KEPLER as the binary output files (e.g., nameprob.cnv) are truncated to the current cycle automatically on restart of the problem.

In the past, all records were kept and removing the duplicate and superfluous ones was left to the reading routine or external tools.

newbin

Delete all output files (*.cnv, etc.) and reset all convection plot and wind parameters and version numbers to current default values.

name

parameters

newbin

pulsar

Print the estimated pulsar rotation rate.

name

parameters

pulsar

PSRMB

PSRMB

the pulsar baryonic mass (Msun). If not specified, a value of 1.7 Msun is assumed.

It is assumed all angular momentum is conserved during collapse and that the neutron star has a gravitational mass of 1.4 Msun, a radius of 12 km, and a moment of inertia of 0.36 M\,R^2.

prncomp

Print the content of the xnwcomp array.

name

parameters

prncomp

See also

setcomp

New In Version >16.0.0.

qset

Overwrite value of q parameter.

name

parameters

qset

QPARM VALUE

setq 1 1.

QPARM

Name or number of q parameter to change.

VALUE

New value of parameter. Must be of correct type.

Warning

You should not have to use this.

New In Version 17.0.2.

setcomp

Set the mass fraction values in the xnwcomp array.

name

parameters

setcomp

( FIRSTION# ( MFRAC )+ ) | ( MFRAC ION )+ | ZONEORG | clear | show

setcomp -1
setcomp -1.
setcomp clear
setcomp 1 0. .7 0. 0. .28 0. .02
setcomp show


number of first ion in |APPROX| :ref:`network <ion>`

MFRAC

new mass fraction of ion

ION

name of ion from APPROX network

ZONEORG

Zone from which to copy composition. Processing of the zone specifications is done the same way as for the <j> command.

clear

reset xnwcomp array to all 0.

show

show current content of xnwcomp array. Same as prncomp.

These compositions are used to set the composition of the surface zones added by the addsurf command.

Starting with its FIRSTION#th entry, set the values of subsequent entries of the xnwcomp array in kepcom equal to the list of MFRAC+ vlaues given. At least one, and up to 10 such values can be given on each command line. Repeated use of this command can thus set all the elements of the xnwcomp array. The compositions are numbered corresponding to APPROX ion number.

Alternatively, ions can be specified ion-by-ion giving pairs of mass fraction, MFRAC, and the APPROX ion name, ION.

If just ZONEORG is given, the composition of that zone is used to initialize the xnwcomp array in the same was as copycomp.

Warning

It is quite useful to use the clear option to reset the xnwcomp array before setting values. If that has not been done before, the content of the array may be undefined.

Note

This array is stored in the restart dump for later use.

New In Version >16.0.0.

Changed In Version 17.0.2: Add isotopes by ion name.

setcycle

Change the cycle number stored in ncyc (q 4).

name

parameters

setcycle

NCYC

setcycle 1000

NCYC

new value for ncyc (q 4)

Was introduced for managment of cnv files. Now used to reset problems, e.g., after an XRB simulation si brough into equilibrium.

New In Version >15.0.0.

cutsurf

Remove zones outside ZSURF from the surface of the star.

name

parameters

cutsurf

[ ZSURF ] [ - | + ]

cutsurf -
cutsurf -3 -
cutsurf 511

ZSURF

zone above which to cut surface layers

+

keep tbound (p 68) unchanged but update pbound (p 69)

-

keep both tbound (p 68) and pbound (p 69) unchanged

pbound (p 69) and tbound (p 68) are automatically reset to correspond to the innermost zone removed unless the flag - or + are specified. When + is specified, only pbound (p 69) is updated whereas tbound (p 68) remians unchanged. Processing of zone specification ZSURF is done similar to the <j> command. If ZSURF is not specified, one zone is cut from the surface.

This option is sometimes useful in removing essentially “frozen” outer layers of the star so that available zones can be concentrated on core processing or to remove high velocity surface zones that are trying to form a stellar wind.

The APPROX and BURN abuncanes in the truncated zones are added to the wind and windb arrays.

Changed In Version 16.0.0: Truncated mass is added to wind and windb arrays.

Changed In Version >16.0.0: Added - and + and specification of absolute zone numbers.

Changed In Version 16.85.0: cutsurf for link files and generators is processed by ttycom

Changed In Version 17.0.2: Zone specification was brought in line with other functions. Allow “plain” cutsurf command without ZSURF to cut just one zone. Proviosly positive values of ZSURF specified the number of zones to be truncated and negative numbers an absolute zone numer; float values were not allowed.

Warning

The change in zone specification introduced with 17.00.02 requires to use “negative zone mumer” where previously a positive number was provided. On the positive side, one can just specity the number of the last zone to keep on the grid as parameter - something that happened often in practice.

Todo

add cutting by density, radius, velocity, temperature, or spacing criterium.

decayni

Convert all APPROX ni56 to fe54 in such a way as to conserve mass, but with no energy generation.

name

parameters

decayni

det

Simulate the passage of a detonation wave.

name

parameters

det

JDET0 JDET1 ENDET

det 1 30 7.867E+17

Same as edep but also change detonated zones to ni56.

Warning

This command should be used only for zones using the APPROX network, and is normally used in conjunction with setting timex0 (p 38) to the current problem time, time (p 2), so that the decay energy from this “newly formed” $^{56}\mathrm{Ni}$ is appropriately deposited in the star (see timex0 (p 38)).

edep

Add specific energy to specified zones.

name

parameters

edep

JDET0 [ JDET1 ] ENDET

edep 0. .02 1.d17

JDET0

Single zone or lower bound of range of zones to be edited.

JDET1

Upper bound zone to be edited.

ENDET

specific energy to add to zones (erg/g)

Add ENDET erg/g to the specific energies of the specified zones range, inclusive.

Processing of zone specification is done similar to the <j> command if only JDET0 is supplied, and similar to the sumb command if both both JDET0 and JDET1 are supplied.

dump

Add dump variable DUMPVAR to the list of variables to be dumped to the qq post-processor dump file or change its dump parameters if it is already in the dump list.

name

parameters

dump

DUMPVAR RATZDUMP RATIODEZ RATIOADZ

dump convect .l -1. 0.

DUMPVAR

may be any zonal edit variable, and in addition it may take the values:

value

result

parm

to dump the values of the changeable (‘p’) parameters

qparm

to dump the values of the edit (‘q’) parameters

RATZDUMP

the maximum allowed fractional change between dumps of the specified zonal

RATIODEZ

the minimum fractional change of this zonal dump variable allowed between two adjacent dump grid points before the dump grid for the variable is dezoned

RATIOADZ

the maximum fractional change of this zonal dump variable allowed between two adjacent dump grid points before the dump grid for the variable is adzoned

The associated dump parameters must be given for each variable. In the case of parm and qparm the values of RATIOADZ and RATIODEZ are ignored but dummy values must still be given.

Note

Note that the dump command for new variables is usually given in the problem generator file.

Note

This command may be useful in generators

Deprecated Since Version >15.0.0.

Other entry:

Useful Input Cards

datapath

Set or enquire path to data files.

name

parameters

datapath

[ PATH | clear ]

datapath /home/alex/kepler/local_data/

PATH

path to data files.

clear

reset the data path.

Set the data path if PATH is specified. Delete the content of datapath of “clear” is specifies. Display the current data path otherwise.

The datapath variable is where KEPLER looks for data files if they cannot be found in the local directory.

If the environment variable KEPLER_DATA is set, KEPLER will also look in the path specified in the variable for data file if they cannot be found in the local directory or the directory specified in datapath (if set). This allows for a machine-dependent setting of the data path and is probably the better way in most cases when general/global files are to be used. The use of datapath allows. however, to give the location of specialized files (maybe as relative path). In both cases, datapath and KEPLER_DATA, the character “~” (tilde) is replaced by the value of the system variable “HOME”, allowing for machine-independent specification of paths.

Note

It is more portable to use environment variables or keep the data files or links to them in the local directory.

New In Version >15.0.0.

Todo

Check whether this is not already in ttycom

Other entry:

Useful Input Cards

genburn

name

parameters

genburn

[NAMEBG]

genburn sol160bg

NAMEBG

name of generator file to read

Read BURN generator, NAMEBG, and begin BURN co-processing.

If NAMEBG is omitted, NAMEPROBbg will be assumed as burn generator filename. This is particularly useful for embedded burn generators.

Note

This command is usually given in the problem generator file.

link

Read and execute the LINK file.

name

parameters

link

namelink

link linkwlsn

Read and execute the LINK file named NAMELINK. The link file may contain the information needed to link the results of specialized core collapse calculations or parameterized models back to KEPLER in order to follow the subsequent explosion and nuclear processing. See the link subroutine.

Changed In Version 16.85.0: The link file may contain any TTY command and any command that used to be in the LINK files is now accesssible, though not always useful, as interactive command.

lista

List all aliases, including those not yet defined (which are denoted by “null”). ‘.

name

parameters

lista

mix

Simulate mixing due to RT instabilities.

name

parameters

mix

[ NZMIN NZMAX ] DLTMASS [ TERMINATE ]

mix 293 507 0.5 0

NZMIN NZMAX

Zone range (inclusive) in which to mix. Processing of the zone specifications is done the same way as for the sumb command. If omitted, all zones are mixed.

DLTMASS

Mass of mixing window (Msun)

TERMINATE

Terminate KEPLER if mixing fails and TERMINATE is 1 but continue otherwise, which can be dangerous and will not produce useful results in general. Default value is 1

Mix composition outwards starting with zone NZMIN and ending with zone NZMAX in mass increments of DLTMASS (Msun). Reset the equation of state in mixed zones. Used for light-curve calculations to simulate Rayleigh-Taylor mixing.

Changed In Version 17.0.2: Generalized zone range specification.

Changed In Version 17.6.1: Default value for TERMINATE changed from 0 to 1.

Changed In Version 17.6.2: Make NZMIN and NZMAX optional.

mixdiff

Simulate mixing due to RT instabilities using diffusion approach.

name

parameters

mixdiff

[ NZMIN NZMAX ] DLTMASS [ TERMINATE ]

mixdiff 293 507 0.5

NZMIN NZMAX

Zone range (inclusive) in which to mix. Processing of the zone specifications is done the same way as for the sumb command. If omitted, all zones are mixed.

DLTMASS

Mass of mixing width. (Msun)

TERMINATE

Terminate KEPLER if mixing fails and TERMINATE is 1 but continue otherwise, which can be dangerous and will not produce useful results in general. Default value is 1

Mix composition using one-step implicit diffusion solver with a DLTMASS=\sqrt{D\,\mathrm{d}t} (Msun) diffusion-like approach with diffusion relative to mass coordinate (diffusion is constant relative to mass coordinate). Mixing is done in the zone range starting with zone NZMIN and ending with zone NZMAX.

Reset the equation of state in mixed zones. Used for light-curve calculations to simulate Rayleigh-Taylor mixing.

New In Version 17.6.2.

mixcycle

Perform mixing/diffusion operation using current coefficients.

name

parameters

mixcycle

[ IZERO ]

mixcyle 1

IZERO

if set to 1 the diffusion coefficiients are zeroed after operation. This is also default. Set to 0 to prevent erasing of diffusion coefficients.

If mixcycl (p 433) is 1 the new time step dtnew (p 1) is used, otherwise the old time step is used.

Note

If mixcycl (p 433) is 0 the mixing operation has already been performed at the end of the cycle and the routine returns with an error message.

New In Version >16.0.0.

mode

Echos whether KEPLER is in interactive mode or not.

name

parameters

mode

mode

This was used for an IDL interface I wrote.

newdumps

Reset all dump-file names and delete all old dump variables.

name

parameters

newdumps

Deprecated Since Version >15.0.0.

newe

Calculate new internal energies from current densities and temperatures.

name

parameters

newe

This is usually wise when changing EOS’s in the middle of a problem via code modifications or changing EOS parameter settings.

Note

Note that total energies are also readjusted so that the resulting “virtual” energy nonconservation is not reflected in the energy edits.

newt

Calculate new temperature current internal energies and densities.

name

parameters

newt

This may be useful when depositing energy to fix EOS issues.

New In Version 17.0.13.

newqname

Reset the names of the expected qq-file and qlib-file to reflect the current problem name.

name

parameters

newqname

Deprecated Since Version >15.0.0.

newstart

Reinitialize the problem by making an edit and restart dump of the current status of the problem, putting out output files, and storing dumps.

name

parameters

newstart

Warning

This command is obsolescent and should not be used on UNIX machines without careful checking of the coding involved.

Deprecated Since Version >15.0.0.

novamix

Mixing for nova test scenario.

name

parameters

novamix

DELTAM

novamix 1.d8

DELTAM

mass over which to mix (g)

Replace “ramp” of core composition in $\mathrm{H}$ layer. The core compositon is taken from zone 1 and the edge of of the ($\mathrm{C}$/$\mathrm{O}$) core is defined by $\mathrm{H}$ exceeding 0.0001.

New In Version >15.0.0.

resetvnm

Reset velnegm (q 97) to 0..

name

parameters

resetvnm

resetvnm

New In Version >16.0.0.

setspin

Change total angular momentum of star.

name

parameters

setspin

VALX | ( VALX VALY VALZ ) [ mult | div | w | k | K | V ]

setspin 3. mult
setspin 1.e-5 2.e-5 0. w

VALUE

new value of total angular momentum of star (erg*sec)

VALX VALX VALX

new x-, y-, and z-components of total angular momentum of star (erg*sec)

mult, div

multiply or divide current rotation rate by VALUE

w

set local specific angular velocity (rad/sec)

k

set local fraction of Keplerian angular velocity (cm**2/sec)

K

set surface fraction of Keplerian angular velocity and make star rigidly rotating.

V

set surface rotation velocity (cm/sec) and make star rigidly rotating.

If only VALUE is provided, scale total angular momentum, J, of star to the new value. If mult or div are provided, the new angular momentum is multiplied or divided by VALUE, respectively, instead. If w or j are specified, set the local value of angular velocity or specific angular momentum, repectively, to VALUE. For the latter case, beware that the central zone may spin quite fast in case it is located at zero radius.

Note

To enforce rigid rotation afterwards, use the solidrot command.

If thee values VALX VALY VALZ are provided, set the total angular momentum of the star to that value, assuming solid body rotation (in the 3D case scaling from one vector to another is not generally possible). If w or j are specified, set the local value of angular velocity or specific angular momentum, repectively, to the (VALX, VALY, VALZ) vector. For the latter case, beware that the central zone may spin quite fast in case it is located at zero radius.

New In Version >15.0.0.

Changed In Version 17.10.0: Added 3D functionality. Remove j option. Added k, K, and V options.

solidrot

Bring the star to solid body rotation.

name

parameters

solidrot

solidrot

New In Version >15.0.0.

store

Set the directory into which ASCII output files and labeled restart dumps will be written to NSDIRECT.

name

parameters

store

NSDIRECT

store lusrneo/weaverls25s2a'

NSDIRECT

If NSDIRECT is set to no-store” (the default), output files will be placed in the current working directory. The name of NSDIRECT may be up to 48 characters long.

Deprecated Since Version >15.0.0.

system

Execute the system command COMMAND-STRING.

name

parameters

system

COMMAND-STRING

system "cd lusrneo/weaver"

COMMAND-STRING

command sting, less than 72 characters long

Note

COMMAND-STRING must be enclosed in double quotes

Note

The entire system command may not exceed 80 characters and may not, itself, be comma-delimited.

unalias

Remove the previously defined alias NAMEA.

name

parameters

unalias

NAMEA | all

unalias tl

NAMEA

name of alias to delete

all

remove all aliases, including those defined in the generator

reset

If BURN co-processing is being done, reset the timen array and take a small time step by setting dtimen to dtfrac (p 230) \times dtnew (p 1).

name

parameters

reset

resetacc

Reset accretion parameter xmacc (q 124) to 0..

name

parameters

resetacc

New In Version 16.82.0.

resetdec

Reset deretion parameters xmdec (q 129) and decmass (q 130) to 0..

name

parameters

resetdec

New In Version 16.85.0.

zerotime

Set the problem time, time (p 2), to 0..

name

parameters

zerotime

Add the old value of time (p 2) to toffset (p 315). Also reset the timen array and take a small time step as descrived in reset if BURN co-processing is being done.