Version History


Version 18.12.4

Bugfix for BURN nucleus determining time step.


Version 18.12.3

Bugfix o18(a,n)ne21 NACRE99 rate was missing thermal correction factor.

Regression for Iliadis rates (bdat Formulae 21 and 22): code:t9m23g=t913g*t913g replaced by t9m23g=t9m13g**2. from of 23 April 2017.


Version 18.12.2

Regression from F90 refactor: cnv files were wrongly written with version number set to when actually writing . When exception :code:`Exception: File <name>.cnv is

System Message: WARNING/2 (/home/alex/kepler/source/doc/History.rst, line 18); backlink

Inline interpreted text or phrase reference start-string without end-string.

System Message: ERROR/3 (/home/alex/kepler/source/doc/History.rst, line 21)

Unexpected indentation.

corrupt.` is encountered, you may try nvers=10600 for

System Message: WARNING/2 (/home/alex/kepler/source/doc/History.rst, line 22)

Block quote ends without a blank line; unexpected unindent.

the Python read script.


Version 18.12.1

Bugfix in wind output, was flagging records as version 20100 despite writing version 20200.

Bugfix set wind loss parameters to 0. if there is not mass loss, e.g., when :q`jloss`:math:<=0 (xmlossr (q 82), delmass (q 128), dvloss (q 136)).


Version 18.12.0

Add luminosity at affective radius (xlumteff (q 0)). Effective temperature teff (q 48) is now using this luminosity instead of xlum (q 46) at the outermost zone. Effective opacity capeff (q 87) is now just the value of the zone in which radius (q 47) lies, previously-used interpolation was incorrect.

Additions:

xlumeff

Luminosity at effective radius.

name

number

type

unit

xlumeff

161

float

erg/sec

New In Version 18.12.0.

Original entry:

Evolution-Related Parameters

Changes:

teff

Effective surface temperature at radius (q 47).

name

number

type

unit

teff

48

float

K

Changed In Version 18.12.0: now use xlumeff (q 161) instead of xlum (q 46).

Original entry:

Evolution-Related Parameters

capeff

Opacity at effective radius.

name

number

type

unit

capeff

87

float

cm**2/g

Changed In Version 18.12.0: Replaces (incorrect) interpolation by zone value of radius (q 47).

Original entry:

Other Surfarce Properties


Version 18.11.11

Bugfix for high-T branch of NACRE o17(p,g)f18 rate.


Version 18.11.10

Add literature weights to C12ag rate from NACRE to specl0. A few rates in specl1 have had constants promoted to double precision.


Version 18.11.9

Bugfix for NACRE rates - used to limit T9 beyond scope of specl1 in workdef.


Version 18.11.8

Bugfix to screening to (n,p) in subroutine bwrit.


Version 18.11.7

Minor bugfix to ADAPNET diagnostic output.


Version 18.11.6

Add sorted zonal BURN edit B and APPROX edit I.

Changes:

<j>

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

name

parameters

<j>

[ (i [ IONSYM ] ) | ( ( b | 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

same as i but sort by decreasing mass fraction

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

same as b but sort by decreasing mass fraction

b ISOSYM

make BURN species edit of the specified species

q

Make a NSE / ISE edit on the terminal

Changed In Version 18.11.6: Added B and I.

Original entry:

Normal Program Managment Commands


Version 18.11.5

Update lburndtc (p 596) now consistently also enables BURN abundances for abundance backups in sdot. [SDOT] abundance change backup vales are now mass fractions and no longer parts per nucleon.


Version 18.11.4

Changes:

ipnuc

Do nuclear burning/energy generation.

name

number

type

default

unit

ipnuc

525

integer

1

-

Same use of jshell0 (p 93) and jshell1 (p 94) as ipup (p 28).

New In Version 16.85.0.

Changed In Version 18.11.4: add bmasslow (p 419)

Original entry:

Nuclear Reaction Parameters

ipnu

Do neutrino losses.

name

number

type

default

unit

ipnu

526

integer

1

-

Same use of jshell0 (p 93) and jshell1 (p 94) as ipup (p 28).

New In Version 16.85.0.

Changed In Version 18.11.4: add bmasslow (p 419)

Original entry:

Nuclear Reaction Parameters


Version 18.11.3

Re-adjust convectively-bound flame code.


Version 18.11.2

Fix iplotb (p 443)=2 for LBURN.


Version 18.11.1

Convectively bound flame speed switched to smooth curve.


Version 18.11.0

Update convective bound flame temperature scaling to be continuous.

Make zones below flame non-convective for cbfkapm (p 594)>0..

Add ncbfmult (p 595) for number of zones to be modified.

Add lburndtc (p 596) to enable tracking BURN isotopes for time step (default for new runs).

Additions:

ncbfmult

name

number

type

default

unit

ncbfmult

595

integer

15

-

Number of zones to be modified by flame using cbfkapm (p 594).

New In Version 18.11.0.

Original entry:

Flame Model

lburndtc

name

number

type

default

unit

lburndtc

596

integer

1

-

If set to 1 track BURN species for time step rather than APPROX species.

New In Version 18.11.0.

Original entry:

BURN full Processing


Version 18.10.5

Add neutrino loss for $^{180}\mathrm{Ta}$ decay.


Version 18.10.4

Big fix for cbflame in kappa.


Version 18.10.3

Historic bug fix for use of Fuller weak rate nu loss even if not computed because of being outside range. Outside range, neutrino energy losses for those rates, hence, were not included. This would affect runs using BURN network for energy generation (lburn (p 434)=1.).

Changes:

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 18.10.2

Regression for cbflame.


Version 18.10.1

Regression for cbflame1.


Version 18.10.0

Add parameter for convectively bound flame effective opacity. Regression for cbflame1.

Additions:

cbfkapm

name

number

type

default

unit

cbfkapm

594

float

0.

-

Multiplier used to generate artificially thickened flame for inward propagation of off center oxygen and silicon burning that generates an abar inversion

Note

Thermohaline convection (alpth (p 425)) should be turned off when using this flame model.

New In Version 18.10.0.

Original entry:

Flame Model


Version 18.9.2

Dissolve kepoz and kepou modules, fix kepdef fur current numpy, rearrange Makefile.make.


Version 18.9.1

Add update convective flame model that modifies opacity.


Version 18.9.0

Add limeb for isomers (that was overlooked before.) More clean-up of modules and Makefile.


Version 18.8.11

Complete conversion to modules. Had to resort to use submodule (Fortran2008) feature to allow recursive dependence of ttycom/execute with cmd. A few minor interface inconsistencies that could potentially have led to crashes or data corruption were removed.


Version 18.8.10

Bugfix for Python integration (regression from conversion of stacklib/stackl90 to a module).


Version 18.8.9

Historical bugfix for na23(p,g)mg24 in specl0 for T_9>2.


Version 18.8.8

Some numerical updates for hstatym (p 386).


Version 18.8.7

Minor bugfix in mapb2a (undefined variables). Fix type mismatch in invert. Bugfix in invert call to minv.


Version 18.8.6

Enable cf88 C12ag rate as ivrate (p 422)=0 in specl0 t0 _actually_ use cf188. This rate includes e1mltc12 (p 227) and e1mltc12 (p 227).

Changes:

ivrate

Version of the APPROX network rate subroutine to use.

name

number

type

default

unit

ivrate

422

integer

1

-

Currently:

value

result

0

WW95 rate set

1

use the rath00 rate set including the $^{12}\mathrm{C}$(\alpha, \gamma) rate form Buchmann et al. (2000) and Buchmann, priv. comm. (Jul 2000).

2

uses the NACRE c12ag rate.

3

use the rath00 rate set and the adopted values of Kunz et al.(2002, ApJ).

4

use the rath00 rate set and the low values of Kunz et al.(2002, ApJ).

5

use the rath00 rate set and the high values of Kunz et al.(2002, ApJ).

6

use the rath00 rate set and the REACLIB implementation of Kunz et al.(2002, ApJ).

On restart of older programs a value of 0 is initialized.

ivrate (p 422) values of 3, 4, and 5 also selects these rates in the rath00 rate set BURN co-processing “special” subroutine specl0 (see specl.f and specl0.f.)

New In Version 16.10.0.

Changed In Version 17.1.3: Added Option 6.

Changed In Version 18.8.6: Now Option 1 _actually_ uses NACRE c12ag rate, and Iotion 0 _actually_ uses the cf88 c12ag rate.

Original entry:

BURN Physics Parameters


Version 18.8.5

Historic bugfix for li7(h3,2n)2a reverse rate in specl0.


Version 18.8.4

(isomer regress) Bugfix for subroutine compress for array over-run.


Version 18.8.3

Numerical refinement for flame thickness in convectively-bound flame model. (cancelled)


Version 18.8.2

(isomer regress) Bugfix for adapnet isotope tracking.


Version 18.8.1

(isomer regress) Bugfix for subroutine restart for loading dumps.


Version 18.8.0

Add isomers, mostly internal use for now, update binary file, no reactions for them yet available.

Isomers are coded using energy level -1 for the generic isotope (thermally excited), 0 for the ground state (g), 1 for the first excited state (m), 2 for the second excited state (m2), and so forth.


Version 18.7.21

Small bugfix to BDAT formula 13.


Version 18.7.20

Add optional parameter default operator &. Add reversed operators for optional parameter definition, @ and &.

o x &= 3.

Changes:

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.

Original entry:

Normal Program Managment Commands


Version 18.7.19

Disallow duplicate parameter names (p, q, and o), checked in subroutine checkpq.

Changes:

Special Variables

Special variables are cputime, which returns the CPU time used since start of the current execution, and timeused, which returns the CPU time since start of the problem, both as float and in sec.

Changed In Version 18.7.19: Renamed cpu_time to cputime.


Version 18.7.18

Bugfix for nested brackets in mathematical expressions in cmd files.


Version 18.7.17

Bugfix for definition of and assignment to optional parameters on input cards.


Version 18.7.16

Replace fuldef?.f90 variants by fuldef.f90 that reads data from data file fuldat. Original data has been copied to data files fuldef?. The make links now makes a symbolic link to the default data set in fuldat1. Ordering of Q values and nfulnot have been adjusted/fixed. Data from files provides higher accuracy. The link options fuldef or fuldat are now obsolete.

Changes:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 18.7.15

Python: extract kepcom from kepdef.f90 by script instead.


Version 18.7.14

Tweaked version separating our kepcom again to work Python interface.


Version 18.7.13

Now all KEPLER code is F90.


Version 18.7.12

Bugfix for p(ng)2d in rate2.f90 (NACRE rates).


Version 18.7.11

Transition from common block with include files to FORTRAN modules requires now python code. Python code to be updates to deal with f90 modules.

Changes:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 18.7.10

A regression from refactoring, weak rates in xnuwtot, xnuwbm, xnuwbp, xnuwec, and xnuwpc were not properly linked.


Version 18.7.9

dev echo fixed.


Version 18.7.8

Bugfix for swapped def / dev for optional parameters.


Version 18.7.7

Additions:

The simpleq flag switches to simple, single-level “if” statement evaluation (default).

% simpleq

New In Version 18.7.7.

The nestedq flag switches to simple, single-level “if” statement evaluation.

% nestedq

New In Version 18.7.7.

? [ EXPRESSION ]

If EXPRESSION evaluates evaluates to .TRUE., then the commands following up to the next ? or ?? command are executed (if statement) and if it evaluates to .FALSE. they are skipped. Removal is independent of whether they are executed or skipped, but is only governed whether on is in a @ or : section. If EXPRESSION is not provided, this serves as a marker for the end of the if statement (endif).

In simpleq mode, any new ? ends the previous section and starts a new one, code after a ? without an EXPRESSION is executed unconditionally.

In nestedq mode, any new ? with an EXPRESSION introduces a new level that is only ended by a final ? without an EXPRESSION.

% simpleq

*
:
dev xl 0.
xl = 1.e8
? (xmlossr > 1.e20)
xl = 5.e7
? (xmlossr > 1.e21)
x = 2.e7
? (xmlossr > 1.e22)
xl = 1.e7
? (xl < 0.99 * xmlossr) | (xl > 1.01 * xmlossr)
dtmax = {xl}

New In Version 18.7.7.

?? [ EXPRESSION ]

If EXPRESSION evaluates evaluates to .TRUE. or is missing and the previous section was not executed, then the commands following up to the next ? or ?? command are executed (elseif/else statements) and otherwise they are skipped. Removal is independent of whether they are executed or skipped, but is only governed whether on is in a @ or : section.

% nestedq

*
:
dev xl {pie}
? (xmlossr > 1.e22)
xl = 1.e7
?? (xmlossr > 1.e21)
x = 2.e7
?? (xmlossr > 1.e20)
xl = 5.e7
??
xl = 1.e8
?
? (xl < 0.99 * xmlossr) | (xl > 1.01 * xmlossr)
dtmax = {xl}

New In Version 18.7.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.

Original entry:

Normal Program Managment Commands

Changes:

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.

Original entry:

Normal Program Managment Commands


Version 18.7.6

Revise flame model to allow flame to propagate to centre.


Version 18.7.5

Add min and max functions.

Changes:

Arithmetic Expressions

In arithmetic expressions integer and float numbers can be used. Arithmetic operations permitted are +, -, * , / , % (modulo), ** (power), and brackets, ( and ), however, the operands must be of same type (integer or float).

Additionally, the abs, log (logarithm base 10), ln (logarithm base e), exp, sqrt, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, asinh, acosh, atanh, erf, erfc, and erfcs (erfc_scaled), function have been defined.

The type conversion functions aint (truncate to integer - returns float), int (truncate to integer - returns integer), nint (nearest integer - returns integer), floor (nearest integer below - returns integer), ceil (nearest integer above - returns integer), and real (returns float) are defined as well.

The min and max functions return the lower or larger of the two arguments, separated by , or ;. Both arguments need to have same type, which is also type returned.

Changed In Version 17.0.12.

Changed In Version 18.7.4: Removed ^ (now used for xor).

Changed In Version 18.7.5: Add min and max functions.


Version 18.7.4

Change ^ from arithmetic power operator to logical xor operator. Some bug fixes in precedence.

Changes:

Arithmetic Expressions

In arithmetic expressions integer and float numbers can be used. Arithmetic operations permitted are +, -, * , / , % (modulo), ** (power), and brackets, ( and ), however, the operands must be of same type (integer or float).

Additionally, the abs, log (logarithm base 10), ln (logarithm base e), exp, sqrt, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, asinh, acosh, atanh, erf, erfc, and erfcs (erfc_scaled), function have been defined.

The type conversion functions aint (truncate to integer - returns float), int (truncate to integer - returns integer), nint (nearest integer - returns integer), floor (nearest integer below - returns integer), ceil (nearest integer above - returns integer), and real (returns float) are defined as well.

The min and max functions return the lower or larger of the two arguments, separated by , or ;. Both arguments need to have same type, which is also type returned.

Changed In Version 17.0.12.

Changed In Version 18.7.4: Removed ^ (now used for xor).

Changed In Version 18.7.5: Add min and max functions.

Command Expressions

Command expressions consist of a logical expression that use the comparison operators >, <, >=, <=, ==, = (same as ==), /=, and != (same as /=) to compare arithmetic expressions. More complex expression can be composed using and brackets, ( and ), ~ (not), & (and), or ^ (xor), and | (or), in that order of precedence. You may use logical values .TRUE., .True., .true., T, .FALSE., .False., .false., or F in or as logical expressions. Use cases may be limited.

Changed In Version 17.11.7: Added logical values and logical not (~).

Changed In Version 18.7.2: Added /= and !=.

Changed In Version 18.7.4: Added ^ (removed as allowed symbol for power).

Special Variables

Special variables are cputime, which returns the CPU time used since start of the current execution, and timeused, which returns the CPU time since start of the problem, both as float and in sec.

Changed In Version 18.7.19: Renamed cpu_time to cputime.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.


Version 18.7.3

Allow convectively bound flame (cbfmult (p 593)) in QSE regions.


Version 18.7.2

Changes:

Command Expressions

Command expressions consist of a logical expression that use the comparison operators >, <, >=, <=, ==, = (same as ==), /=, and != (same as /=) to compare arithmetic expressions. More complex expression can be composed using and brackets, ( and ), ~ (not), & (and), or ^ (xor), and | (or), in that order of precedence. You may use logical values .TRUE., .True., .true., T, .FALSE., .False., .false., or F in or as logical expressions. Use cases may be limited.

Changed In Version 17.11.7: Added logical values and logical not (~).

Changed In Version 18.7.2: Added /= and !=.

Changed In Version 18.7.4: Added ^ (removed as allowed symbol for power).

Special Variables

Special variables are cputime, which returns the CPU time used since start of the current execution, and timeused, which returns the CPU time since start of the problem, both as float and in sec.

Changed In Version 18.7.19: Renamed cpu_time to cputime.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.


Version 18.7.1

Changes:

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

Original entry:

Normal Program Managment Commands

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

Original entry:

Normal Program Managment Commands


Version 18.7.0

Additions:

cbfmult

Multiplier for convectively bound flame for O burning flame.

name

number

type

default

unit

cbfmult

593

float

0.

-

Note

Thermohaline convection (alpth (p 425)) should be turned off when using this flame model.

New In Version 18.7.0.

Original entry:

Flame Model


Version 18.6.0

Mass loss was re-organised. Parameter xmlossrf (p 592) now limits mass loss rate change. Langer mass loss now is treated the same as other mass loss rates and does not overwrite binary mass loss. Binary mass loss is now additive rather than using the maximum of binary and wind mass loss rates.

Additions:

xmlossrf

Maximum allowed relative change in mass loss rate.

name

number

type

default

unit

xmlossrf

592

float

-0.2

-

If set to negative value, only limit wind mass loss not binary (by absolute value).

Set to 1.e+99 to disable.

New In Version 18.6.0.

Original entry:

Mass Loss Parameters


Version 18.5.4

Small refactor of git/uuid to use modules.


Version 18.5.3

Fixed base name separation for # and added multi-digit automatic z backups for restart.


Version 18.5.2

Bugfix in core edit command.


Version 18.5.1

Bugfix to angwcst edit.


Version 18.5.0

Add updated binary module from Stan (ibintype (p 591))

Additions:

Binary Mass Loss Parameters

ibintype

Binary interaction type.

name

number

type

default

unit

ibintype

591

integer

4

-

value

result

1

Mass loss in a detached binary due to wind. The separation and the period will always increase

2

Conservative mass transfer. Total angular momentum and mass do no change.

3

Non-conservative mass transfer with mass with the angular momentum of the secondary (e.g., for super-Eddington accretion on neutron stars)

4

Non-conservative transfer with a specified fraction of accretion and angular momentum loss

New In Version 18.5.0.

binm10

The initial mass of the star being evolved (primary).

name

number

type

default

unit

binm10

348

float

:p:`totm0`

Msun

It is used in calculating the possibility of mass loss to a binary companion, following the formalism of [PJH92].

The star loses mass when its radius exceeds its Roche radius, with a power-law cutoff to avoid numerical discontinuities. The formalism also involves parameters binm20 (p 349) - rocher (p 354), defined below, See subroutine cycle.

New In Version 14.0.0.

binm20

The initial mass of the binary companion star.

name

number

type

default

unit

binm20

349

float

0.

Msun

Used in calculating the possibility of binary mass transfer. No mass transfer is performed if binm20 (p 349) \le 0.

See binm10 (p 348).

New In Version 14.0.0.

binalp

[PJH92]‘s alpha parameter, related to the angular momentum of the mass lost in binary transfer.

name

number

type

default

unit

binalp

350

float

1.

-

New In Version 14.0.0.

binbet

[PJH92]‘s beta parameter.

name

number

type

default

unit

binbet

351

float

1.

-

Fraction of the total mass spilling over from the Roche lobe of the primary that is transferred to the secondary rather than being lost from the system. binbet (p 351) equals 1. for conservative binary mass transfer.

New In Version 14.0.0.

bina0

Initial binary separation.

name

number

type

default

unit

bina0

352

float

2.

AU

Used in calculating the possibility of binary mass transfer. See binm10 (p 348).

New In Version 14.0.0.

binmdt

Mass loss rate due to binary mass transfer assumed when the primary stars exceeds its Roche radius.

name

number

type

default

unit

binmdt

353

float

0.001

Msun/yr

New In Version 14.0.0.

rocher

Current Roche radius.

name

number

type

default

unit

rocher

354

float

1.e+99

cm

This is a calculated quantity and should normally not be changed by the user. See binm10 (p 348).

New In Version 14.0.0.

Changes:

rloss

Maximum radius beyond which zones are removed from star, similar to vloss (p 271).

name

number

type

default

unit

rloss

409

float

1.e+99

-

Use rn ( jm -1) as reference radius.

Isotope masses are added to the “wind” arrays, wind and windb.

New In Version 15.28.0.

Changed In Version 18.5.0: Used to use rn (jm ) as reference radius.

Original entry:

Mass Loss Parameters


Version 18.4.1

Various updates to make files for compatibility to M1/ARM64/MacOSX.


Version 18.4.0

Change ioparm to int32 for compatibility with F18 standard.


Version 18.3.10

Fix adapnet - historic bug on network decay chains.

Adds updated bdat and matching adapnet.cfg, the current variant set as default in Makefile.make is variant “burn”, Version 10.1. This includes some “phoney” alpha decay rates for network closure (unstable things can decay) and, in particular, missing decays for $^{204}\mathrm{Pt}$ and $^{217}\mathrm{Po}$. adapnet.cfg now truncates the network at A=229.


Version 18.3.9

Update mongo plot labels to use exponents.


Version 18.3.8

Rename angwn etc. to angwa etc.


Version 18.3.7

Update rotout output.


Version 18.3.6

Replace external C library function uuid_compare with built-in uuid__compare in libgfortran.


Version 18.3.5

Add r command to resume running.

Additions:

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.

Original entry:

Normal Program Managment Commands

Changes:

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.

Original entry:

Normal Program Managment Commands


Version 18.3.4

Add rossby to rotout and change version number to 10200.


Version 18.3.3

Change error code abortion from mode to iexec in ttycom.


Version 18.3.0

Additions:

rossbyf

Multiplier on Rossby reference rotation profile.

name

number

type

default

unit

rossbyf

588

float

0.

-

Set to non-zero value to enable.

We use

\displaystyle{R\!o=\frac{v_{\mathrm{conv}}}{\omega\,l}=\frac{3\,D}{\alpha_{\omega\,\mathrm{c}}^2\,H_{\mathrm{P}}^2}}

where

l=\alpha_{\mathrm{c}}\,H_{\mathrm{P}},

R\!o is the Rossby number,

v_{\mathrm{conv}} is the convective velocity,

H_{\mathrm{P}} is the pressure scale height \displaystyle{\frac{-\mathrm{d}\,r}{\mathrm{d}\,\ln\,P}=\frac{P\,r^2}{G\,m\,\rho}}\;,

D is the diffusion coefficient,

\alpha_{\mathrm{c}} is the convective mixing length parameter xmlen (p 19).

The reference rotation background profile,

\omega_{\mathrm{ref}} is then computed from by

\displaystyle{\frac{\mathrm{d}\,\omega_{\mathrm{ref}}}{\mathrm{d}\,r}=\frac{\omega}{r}\,f\,\min\left(R\!o_{\mathrm{max}},R\!o^p\right)}

where

the scaling pre-factor f is rossbyf (p 588),

the maximum Rossby number R\!o_{\mathrm{max}} is rossbym (p 589), and

the power of the scaling scaling p is rossbyp (p 590).

The reference state is integrated from the outside in and stored in angwros.

Note

A combination of rossbyf (p 588) and rossbym (p 589) allows to move the location of the break.

New In Version 18.3.0.

Original entry:

Rotation Parameters

rossbym

Maximum value of gradient in Rossby reference rotation profile.

name

number

type

default

unit

rossbym

589

float

0.333333

-

Set to non-zero value to enable.

See rossbyf (p 588) for details.

New In Version 18.3.0.

Original entry:

Rotation Parameters

rossbyp

Power of Rossby number (Ro) in gradient of Rossby reference rotation profile.

name

number

type

default

unit

rossbyp

590

float

0.6

-

See rossbyf (p 588) for details.

New In Version 18.3.0.

Original entry:

Rotation Parameters

Changes:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 18.2.3

Add IEEEVALS option to Makefile.

Changes:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 18.2.2

Fix loadbuf dr value.


Version 18.2.1

Fix action of ipnuc (p 525).


Version 18.2.0

Additions:

impoparm

When set to 1, optional parameters can be defined implicitly.

name

number

type

default

unit

impoparm

587

integer

1

-

New In Version 18.2.0.

Original entry:

Parameter-Change Parameters

Changes:

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.

Original entry:

Normal Program Managment Commands


Version 18.1.3

Changes:

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

Original entry:

Normal Program Managment 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.

Original entry:

Normal Program Managment Commands


Version 18.1.2

Initialize noparm in gener to not rely on memory being zero as well as being an advance toward Python module restarts.


Version 18.1.1

Improve BURN network backups for Python tools.


Version 18.1.0

Implement complex formula for 3D dynamical instability.

Additions:

angfjdyn

General efficiency multiplier for generalised dynamical instability.

name

number

type

default

unit

angfjdyn

585

float

0.

-

New In Version 18.1.0.

Original entry:

Rotation Parameters

angfsh

Relative weighing of Solberg-Hoiland instability contribution for generalised dynamical instability (angfjdyn (p 585)).

name

number

type

default

unit

angfsh

586

float

1.

-

New In Version 18.1.0.

Original entry:

Rotation Parameters


Version 18.0.1

Additions:

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.

Original entry:

Normal Program Managment Commands

Changes:

(optional) is a set of one or more space delimited words in arbitrary order chosen from among the following possibilities:

Option

Meaning

s

To suspend the code after starting.

k

do not load BURN data and kill burning, similar to the killburn command.

d

To destroy the ASCII output files after sending them to the microfiche printer (not currently implemented – see also the discussion of parameter iautoout (p 159).

h

To automatically make a paper copy of the ASCII output files (not currently implemented).

c

write out stored command file (overwrite existing).

a

append stored command file.

p

make plot on start-up.

n

suppress graphical output, e.g., for batch mode.

x

DEBUG mode. Allow running without proper git hash.

X

Extended DEBUG mode. Could be used to enable internal debugging code. Adds 2 to internal idebug variable.

Changed In Version >15.0.0: Added k option.

Changed In Version 17.1.0: Added c and a options.

Changed In Version 17.6.0: Added x option.

Changed In Version 17.11.7: Added p and n options.

Changed In Version 18.0.1: Added X option.

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.

Original entry:

Normal Program Managment Commands


Version 18.0.0

Official version with 3D angular momentum.

Update default doc path to doc.

Bug fix in weak rates (used undefined variable as index).

Additions:

nonormb

Do not normalise mapped BURN abundances.

name

parameters

nonormb

nonormb

Note

This is for debugging purposes.

Note

If BURN is not active, this card is ignored.

New In Version 18.0.0.

Original entry:

Optional Cards

dweakmin

Minimum density for weak rates.

name

number

type

default

unit

dweakmin

584

float

100000.

g/cc

For some problems, e.g., XRB, this should be set to a lower value.

New In Version 18.0.0.

Original entry:

BURN Physics Parameters


Version 17.11.7

Bug fix to gener for addition of BURN file.

Bug fix to Itoh08 opacities, regress from refactor.

Bug fix to add radconv (q 89) calculation to subroutine gener.

Bug fix advection energy calculation for case of combined loss and accretion.

Bug fix to neutrino losses when lburn (p 434) is used: now use updated abundances.

All common block in separate files to assure identical variable names.

Bug fix to minzone (p 444) updates relevant to decretion.

Bug fix to disable rezone across bmasslow (p 419) domain boundary.

Add dr zonal edit variable.

Stop on generator errors if not in interactive mode. Experimental.

Todo

Add option to activate/deactivate this.

Add {} expression evaluation to generator.

dvacc (q 137) now stored correctly.

Set APPROX accretion composition after mapburn.

Additions:

~

Similar to : command but always evaluates to .FALSE.. This can be used, e.g., to store “subroutine” code sections that are retained unconditionally. Really the same as

: F

New In Version 17.11.7.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

dr

Zone thickness.

name

type

unit

centering

storage

dr

float

cm

center

loadbuf

New In Version 17.11.7.

Original entry:

Miscellaneous

//b

The following lines will be appended to BURN generator file until \\ command or end of file.

name

parameters

//b

If genburn has not been called before, this BURN section will be ignored. This allows to just comment out the genburn command and not worrying to remove //b section.

New In Version 17.11.7.

Original entry:

Optional Cards

//b*

Same as //b but delete old BURN generator file.

name

parameters

//b*

Note

This is done only once during generation, the first time it is encountered.

New In Version 17.11.7.

Original entry:

Optional Cards

uuid

Set UUID of generator.

name

parameters

uuid

UUID

This may be used to better track connections between runs and generators used.

uuid 3f856e9e-b45b-11ea-b3f3-2cfda1c73a9c

New In Version 17.11.7.

Original entry:

Optional Cards

sha

Set sha hash of generator.

name

parameters

sha

SHA

This may be used to better track connections between runs and generators used.

sha 1ebc0705ced3e43cfbdb219314da7cdf3bc0e6f8

New In Version 17.11.7.

Original entry:

Optional Cards

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

Changes:

% OPTIONS

Options/flags/directives to the command file interpreter. The number of spaces between % and the command may be 0 or larger.

The debug flag allows debugging of expression interpretation.

% debug

New In Version 17.0.2.

The nodebug flag switches debugging off (default).

% nodebug

New In Version 17.0.12.

The simpleq flag switches to simple, single-level “if” statement evaluation (default).

% simpleq

New In Version 18.7.7.

The nestedq flag switches to simple, single-level “if” statement evaluation.

% nestedq

New In Version 18.7.7.

The noecho flag disables printout of expression tests to console.

% noecho

New In Version 17.0.12.

The echo flag enables printout of expression tests to console (possibly misguided default).

% echo

New In Version 17.0.12.

The xsave flag enables saving of command file before each command execution. This is to prevent loss of changes to command file in case KEPLER terminates during execution, e.g., for a end command.

% xsave

New In Version 17.0.13.

The noxsave flag disables saving of command file before each command execution. This save a lot of write operations, however, changes to command file may be lost in case KEPLER terminates during execution, e.g., for a end command.

% noxsave

New In Version 17.0.13.

The end flag end KEPLER in a save way, also saving the command file properly before termination.

% end

New In Version 17.0.13.

The delete directive deletes the command file and terminates its execution.

% delete

New In Version 17.0.13.

The delsec directive deletes the current section and skips to the next section.

*
: tn(1) > 1.d8
p 1 1.
@ dn(1) > 1.d6
% delsec

New In Version 17.0.13.

Changed In Version 17.11.7: Replace # by % to distinguish from comment lines for the off chance of an accidental collision.

Command Expressions

Command expressions consist of a logical expression that use the comparison operators >, <, >=, <=, ==, = (same as ==), /=, and != (same as /=) to compare arithmetic expressions. More complex expression can be composed using and brackets, ( and ), ~ (not), & (and), or ^ (xor), and | (or), in that order of precedence. You may use logical values .TRUE., .True., .true., T, .FALSE., .False., .false., or F in or as logical expressions. Use cases may be limited.

Changed In Version 17.11.7: Added logical values and logical not (~).

Changed In Version 18.7.2: Added /= and !=.

Changed In Version 18.7.4: Added ^ (removed as allowed symbol for power).

Special Variables

Special variables are cputime, which returns the CPU time used since start of the current execution, and timeused, which returns the CPU time since start of the problem, both as float and in sec.

Changed In Version 18.7.19: Renamed cpu_time to cputime.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

(optional) is a set of one or more space delimited words in arbitrary order chosen from among the following possibilities:

Option

Meaning

s

To suspend the code after starting.

k

do not load BURN data and kill burning, similar to the killburn command.

d

To destroy the ASCII output files after sending them to the microfiche printer (not currently implemented – see also the discussion of parameter iautoout (p 159).

h

To automatically make a paper copy of the ASCII output files (not currently implemented).

c

write out stored command file (overwrite existing).

a

append stored command file.

p

make plot on start-up.

n

suppress graphical output, e.g., for batch mode.

x

DEBUG mode. Allow running without proper git hash.

X

Extended DEBUG mode. Could be used to enable internal debugging code. Adds 2 to internal idebug variable.

Changed In Version >15.0.0: Added k option.

Changed In Version 17.1.0: Added c and a options.

Changed In Version 17.6.0: Added x option.

Changed In Version 17.11.7: Added p and n options.

Changed In Version 18.0.1: Added X option.

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

Original entry:

Special Purpose Commands

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

Original entry:

Special Purpose Commands

drmultlo

Semiconvective mixing will be slower than thermal transport by at least drmultlo (p 325) (about 0.1) in zones where the mean atomic weight, abar, is below abarsemi (p 324).

name

number

type

default

unit

drmultlo

325

float

-1.

-

See subroutine update and discussion of drmult (p 24), woversht (p 148), and woverslo (p 326).

If drmultlo (p 325) = 0 no semiconvective mixing is done.

If drmultlo (p 325) < 0 then drmult (p 24) will be used.

New In Version 9.0.0.

Changed In Version 17.11.7: Default -1. will use drmult (p 24).

Original entry:

Semiconvection And Overshoot Parameters

woverslo

The semiconvective test parameter, W, is taken to be W = woverslo (p 326) * abs ( log(T1/T0)) for the special overshoot semiconvective zones where W would otherwise be less than 0 and when \bar{A} < abarsemi (p 324).

name

number

type

default

unit

woverslo

326

float

-1.

-

Overshoot mixing occurs at a rate calculated from this value of W, but is limited by the thermal diffusion timescale as in normal semiconvection.

See subroutine update and [WZW78].

If woverslo (p 326) = 0 no overshoot mixing is done.

If woverslo (p 326) < 0 then woversht (p 148) will be used.

Also see woversht (p 148).

New In Version 9.0.0.

Changed In Version 17.11.7: Default -1. will use woversht (p 148).

Original entry:

Semiconvection And Overshoot Parameters

iflagye

The electron EOS is implicitly coupled to nuclear burning-induced changes in the electron abundance, Y_\mathrm{e}, provided iflagye (p 167) flag 1 is set and the ISE or NSE network is being used; or iflagye (p 167) flag 2 is set and the APPROX network is being used.

name

number

type

default

unit

iflagye

167

integer

1

-

value

result

flag 0

coupling disabled

flag 1

couple Y_\mathrm{e} from ISE and QSE

flag 2

couple Y_\mathrm{e} from APPROX

Changed In Version 17.11.7: Added flag 2

Original entry:

ISE Network Physics Parameters

nadapb

Enable Adaptive BURN network adjustment.

name

number

type

default

unit

nadapb

137

integer

0

-

value

result

0

off

1

on

2

(flag) reload ADAPNET and clear flag.

See ADAPNET for details on use and data files.

The bit 2 is a flag to reload ADAPNET configuration file and then clear the flag. The value 2 itself makes not too much sense. It reloads the configuration file, adopts the network once, but then switches ADAPNET off. Choose 3 to reload configuration file and continue using ADAPNET.

New In Version 16.9.0.

Changed In Version 17.11.7: Add reload flag.

Note

p 137 was changed to from bethemt to nadapb (p 137) around version 16.09. Since also the type was changed from integer to float there should be little confusion in generators.

bethemt had the following description:

Multiplier on fudged Co63 electron decay rate as suggested by
Gerry Brown and Hans Bethe (11/89).

KEPLER uses updated weak rates (from Langanke & Martinez (2000) as of the time of this writing).

Original entry:

BURN Coprocessing Control Parameters


Version 17.11.6

Add tag and time to termination message.

Add generator to history.

Minor changes for compatibility with gfortran 10.1.1.


Version 17.11.5

Fix iron abundances used for mass loss rate formula. Bug reported by Stan Woosley on 20200105. Old formula overestimated iron by 56/54.


Version 17.11.4

Another fix on optical depth-based rezoning.


Version 17.11.3

Fix dated bug in optical depth-based rezoning.

Warning

taurat (p 571) was effectively 4 times its value.


Version 17.11.2

More refactoring to remove implicit type definitions.

Warning

Fixed: in es the variable eionz was not defined. Replaced by eioniz.


Version 17.11.1

More refactoring to remove implicit type definitions.

Fixed iterbar (q 160) stored in common block and actually saved.

Fixed variable name yo160 vs. yo16o in qseedit.


Version 17.11.0

More refactoring to remove implicit type definitions.

iterbar (q 160) now stores iteration counter for problem termination to have better reproducible execution behaviour.

Warning

Fixed updating rotation energies if mixcycl (p 433) > 0 (cycle).

Fixed bug (undefined variable) in C14EC rate in burn.

Todo

rocher (p 354) should not be parm but in qparm.

Additions:

iterbar

Current iteration counter for problem termination.

name

number

type

unit

iterbar

160

integer

-

New In Version 17.11.0.

Original entry:

Time Step-Related Parameters


Version 17.10.0

Include 3D components of angular momentum. This implies various updates to data files. 3D interpretation of angular momentum is non-trivial: for example, the total angular momentum of two shells rotating in opposite directions can be zero.

x-, y-, and z-components of angj (\vec{j}) and angw (\vec\omega) can be accessed adding the respective component character, whereas internally they are implemented as vectors. The magnitude (norm) cam be accessed adding the n character to the base variable name. The default direction, including mapping from older dumps and 1D generators is z-direction.

Vast refactoring to remove many implicit variable type definitions.

Warning

In remapl, remapa, (mass loss and accretion remapping of all physical quantities) and transport1 (rotationally induced mixing) the maximum array size was hard-coded to 4096, so old high-resolution runs may have suffered from memory overwriting as that was uses in common block definitions to store mapping data. This has now been fixed to scale with JMZ.

Record of angular momentum lost by wind, anglwnd was not updated correctly due to wrong variable name in cycle.

The cut command may have messed up angular velocity.

Fixed convection change timescale for flame problems (flamerad (p 214)).

Fixed bad indices in specl0 for $^{6}\mathrm{Li}$, $^{6}\mathrm{He}$.

Fixed missing to store rate for $^{2}\mathrm{H}$ + $^{2}\mathrm{H}$ \rightleftharpoons $^{4}\mathrm{He}$ (resulting in undefined variable where used).

Fixed rprox definition of t954 missing.

Fixed rate0 definition of fivesixths and OneThird missing. (cf88 $^{12}\mathrm{C}$ + $^{12}\mathrm{C}$ rate).

Fixed (not) overwriting beta decay rate for Formula 28 in rateb.

Fixes in regess to advection and boundary derivatives.

Note

Renamed angjacc (p 512) to angjaccz (p 512).

Renamed angw0 (p 510) to angw0z (p 510).

Renamed awcorot0 (p 430) to awcorotz (p 430). A negative or 0 value no longer disables co-rotation. Exclusively use ymcorot (p 431)<0. instead. The defaults have been updated accordingly.

Todo

need to fix cutsurf – zm, summ, …

Set rotation of core if ymcorot (p 431)=0.

Additions:

angjx

Specific angular momentum x-component.

name

type

unit

centering

storage

angjx

float

cm**2/sec

center

dump

New In Version 17.10.0.

Original entry:

Saved Arrays Evaluated at Zone Centers

angjy

Specific angular momentum y-component.

name

type

unit

centering

storage

angjy

float

cm**2/sec

center

dump

New In Version 17.10.0.

Original entry:

Saved Arrays Evaluated at Zone Centers

angjz

Specific angular momentum z-component.

name

type

unit

centering

storage

angjz

float

cm**2/sec

center

dump

New In Version 17.10.0.

Original entry:

Saved Arrays Evaluated at Zone Centers

angja

Specific angular momentum magnitude.

name

type

unit

centering

storage

angja

float

cm**2/sec

center

loadbuf

currently same as angj

New In Version 17.10.0.

Original entry:

Rotation

angwa

Angular velocity magnitude.

name

type

unit

centering

storage

angwa

float

rad/sec

center

cycle

currently same as angw

New In Version 17.10.0.

Original entry:

Rotation

angwx

Angular velocity x-component.

name

type

unit

centering

storage

angwx

float

rad/sec

center

cycle

New In Version 17.10.0.

Original entry:

Rotation

angwy

Angular velocity y-component.

name

type

unit

centering

storage

angwy

float

rad/sec

center

cycle

New In Version 17.10.0.

Original entry:

Rotation

angwz

Angular velocity z-component.

name

type

unit

centering

storage

angwz

float

rad/sec

center

cycle

New In Version 17.10.0.

Original entry:

Rotation

angwcsta

Rotation constant magnitude.

name

type

unit

centering

storage

angwcsta

float

?

center

loadbuf

Same as angwcst

New In Version 17.10.0.

Original entry:

Rotation

angwcstx

Rotation constant x-component.

name

type

unit

centering

storage

angwcstx

float

?

center

loadbuf

See angwcst.

New In Version 17.10.0.

Original entry:

Rotation

angwcsty

Rotation constant y-component.

name

type

unit

centering

storage

angwcsty

float

?

center

loadbuf

See angwcst.

New In Version 17.10.0.

Original entry:

Rotation

angwcstz

Rotation constant z-component.

name

type

unit

centering

storage

angwcstz

float

?

center

loadbuf

See angwcst.

New In Version 17.10.0.

Original entry:

Rotation

angr

Zone gyration-average radius.

name

type

unit

centering

storage

angr

float

cm

center

loadbuf

\sqrt{1.5\,i}

New In Version 17.10.0.

Original entry:

Rotation

angva

Equatorial rotational velocity magnitude.

name

type

unit

centering

storage

angva

float

cm/sec

center

loadbuf

currently same as angv

New In Version 17.10.0.

Original entry:

Rotation

angvx

Equatorial rotational velocity x-component.

name

type

unit

centering

storage

angvx

float

cm/sec

center

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angvy

Equatorial rotational velocity y-component.

name

type

unit

centering

storage

angvy

float

cm/sec

center

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angvz

Equatorial rotational velocity z-component.

name

type

unit

centering

storage

angvz

float

cm/sec

center

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angjta

Magnitude integrated angular momentum.

name

type

unit

centering

storage

angjta

float

erg*sec

boundary

loadbuf

Same as angjt

New In Version 17.10.0.

Original entry:

Rotation

angjtx

Integrated angular momentum x-component.

name

type

unit

centering

storage

angjtx

float

erg*sec

boundary

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angjty

Integrated angular momentum y-component.

name

type

unit

centering

storage

angjty

float

erg*sec

boundary

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angjtz

Integrated angular momentum z-component.

name

type

unit

centering

storage

angjtz

float

erg*sec

boundary

loadbuf

New In Version 17.10.0.

Original entry:

Rotation

angw0x

x-component of angular velocity of the inner angw0m (p 511) mass.

name

number

type

default

unit

angw0x

579

float

0.

rad/sec

New In Version 17.10.0.

Original entry:

Rotation Parameters

angw0y

y-component of angular velocity of the inner angw0m (p 511) mass.

name

number

type

default

unit

angw0y

580

float

0.

rad/sec

New In Version 17.10.0.

Original entry:

Rotation Parameters

angjaccx

x-component of specific angular momentum of newly accreted material.

name

number

type

default

unit

angjaccx

577

float

0.

cm/sec**2

New In Version 17.10.0.

Original entry:

Rotation Parameters

angjaccy

y-component of specific angular momentum of newly accreted material.

name

number

type

default

unit

angjaccy

578

float

0.

cm/sec**2

New In Version 17.10.0.

Original entry:

Rotation Parameters

nang3d

Switch on 3D angular momentum.

name

number

type

default

unit

nang3d

576

integer

0

-

value

result

0

off

1

on

New In Version 17.10.0.

Original entry:

Rotation Parameters

nrotout

Write out rotation data file.

name

number

type

default

unit

nrotout

583

integer

0

-

value

result

0

off

1+

write out data every nrotout (p 583) cycles.

New In Version 17.10.0.

Original entry:

Rotation Parameters

angltx

X-component of current total angular momentum.

name

number

type

unit

angltx

151

float

erg*sec

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

anglty

Y-component of current total angular momentum.

name

number

type

unit

anglty

152

float

erg*sec

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

angltz

Z-component of current total angular momentum.

name

number

type

unit

angltz

153

float

erg*sec

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

anglwndx

X-component of angular momentum lost due to wind.

name

number

type

unit

anglwndx

157

float

-

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

anglwndy

Y-component of angular momentum lost due to wind.

name

number

type

unit

anglwndy

158

float

-

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

anglwndz

Z-component of angular momentum lost due to wind.

name

number

type

unit

anglwndz

159

float

-

New In Version 17.10.0.

Original entry:

Rotation-Related Parameters

anglossx

X-component of angular momentum removed from problems by cutsurf.

name

number

type

unit

anglossx

154

float

erg*sec

New In Version 17.10.0.

Original entry:

Cutsurf-Parameters

anglossy

Y-component of angular momentum removed from problems by cutsurf.

name

number

type

unit

anglossy

155

float

erg*sec

New In Version 17.10.0.

Original entry:

Cutsurf-Parameters

anglossz

Z-component of angular momentum removed from problems by cutsurf.

name

number

type

unit

anglossz

156

float

erg*sec

New In Version 17.10.0.

Original entry:

Cutsurf-Parameters

Changes:

angj

Specific angular momentum magnitude.

name

type

unit

centering

storage

angj

float

cm**2/sec

center

loadbuf

New In Version 15.2.0.

Changed In Version 17.10.0: now derived quantity, components are stored as primary data instead.

Original entry:

Rotation

angwcst

Rotation constant magnitude \bar{\omega}\,\bar{\rho}^{-2/3}.

name

type

unit

centering

storage

angwcst

float

?

center

loadbuf

where

\bar{\rho}=\frac{3\,m}{4\pi r^3(m)}

\bar{\omega}=J(m)/I(m)

J(m) = \int_0^m j(m^\prime)\,\mathrm{d}m^\prime

I(m) = \int_0^m i(m^\prime)\,\mathrm{d}m^\prime

i: specific moment of inertia (cm**2)

j: specific angular momentum (cm**2/sec)

Changed In Version 17.10.0: renamed from angwx to angwcst

Original entry:

Rotation

g

Grid Cards. (At least 2 required).

name

parameters

g

ZONENUM MASS NETNUM MIXNAME TEMP DENSITY [ [ OMEGAX OMEGAY ] OMEGAY ] OMEGAZ [ VELOCITY ] ]

g 0 4.e+34 1 solcomp 1.le+7 0.9 0.
ZONENUM

is the number of the zonal interface being described (j). This should always be 0 for the first g card and be equal to the total number of zones desired for the last g card. For intermediate g cards, j should increase monotonically between these values. Not every interface need be specified, and conditions at intermediate interfaces will be calculated as described below.

MASS

is the mass coordinate for the grid. Without other modification cards, this is the mass (in grams) exterior to the zonal interface being specified. (ym(j)). Specified values must increase monotonically with zonal interface number (j). Exterior masses for zonal interfaces between those specified will be interpolated from the specified values by minimizing the sum of the squares of the fractional changes in zone mass across each interface (See subroutine XXX zonit).

Changed In Version >15.0.0: When the generator cards rescalem or zonemass are used, the mass values will be interpreted differently, for ease of use and adaptability.

NETNUM

is the number of the nuclear-burning network to be used between this zonal interface and the next one specified. (netnum(j)). Currently it must be 1 (see net card(s)).

MIXNAME

is name of the material (as specified by the appropriate m cards) that lies between this zonal interface and the next one specified. (imsen(j)).

TEMP

is the temperature (K) of the zones that lie between this interface and the next one specified. (tn(j)).

DENSITY

is the density (g/cc) of the zones that lie between this interface and the next one specified. (dn(j)).

OMEGAX OMEGAY OMEGAZ

are the angular velocity components (rad/sec) of the zone. If not specified, they are assumed to be 0. Angular velocities for zones between those where they are specified are determined by interpolating linearly. For example, to generate an initial model with constant gradient in the rotational velocity in z-direction (or a rigidly rotating model), only for the innermost and the outermost zone values for OMEGAZ have to be supplied.

VELOCITY

is the radial velocity (cm/sec) of this zonal interface. (un(j)). If not specified, it is assumed to be 0. Velocities for zonal interfaces between those specified are determined by interpolating linearly with radius.

grid     ::=  ( gridcard ){2,}
gridcard ::=  "g" ...

Changed In Version >15.0.0: The generator card g has been enhanced in order to allow for the addition of rotation on generation of the problem.

Changed In Version 17.10.0: Added x and y components.

Original entry:

Required Cards

rigidl

Set angular momentum of star.

name

parameters

rigidl

[ VALUEX VALUEY ] VALUEZ

rigidl 1.d52
VALUEX VALUEY VALUEZ

components of new total angular momentum of star (units erg*sec)

This card allows to give the star an angular momentum (units erg*sec) at start-up and distributes it such that the star is rigidly rotating. The rotation value on the grid cards is ignored. Components not specified are assumed to be 0..

New In Version >15.0.0.

Changed In Version 17.10.0: Added 3D components.

Original entry:

Optional Cards

rigidv

Set surface rotation velocity of star.

name

parameters

rigidv

[ VALUEX VALUEY ] VALUEZ

rigidv 1.e6
VALUEX VALUEY VALUEZ

equatorial surface rotation velocity of star (units cm/sec)

This card allows to give the star a surface rotation velocity (unit cm/sec) at start-up such that the star is rigidly rotating. The rotation value on the grid cards is ignored. Components not specified are assumed to be 0..

New In Version >15.0.0.

Changed In Version 17.10.0: Added 3D components.

Original entry:

Optional Cards

rigidw

Set surface angular velocity of star.

name

parameters

rigidw

[ VALUEX VALUEY ] VALUEZ

rigidw 1.e-6
VALUEX VALUEY VALUEZ

surface angular velocity of star (units rad/sec)

This card allows to give the star an angular velocity (unit rad/sec) at start-up such that the star is rigidly rotating. The rotation value on the grid cards is ignored. Components not specified are assumed to be 0..

New In Version >15.0.0.

Changed In Version 17.10.0: Added 3D components.

Original entry:

Optional Cards

rigidk

Set surface angular velocity of star as fraction of Keplerian rotation velocity.

name

parameters

rigidk

[ VALUEX VALUEY ] VALUEZ

rigidk 0.2
VALUEX VALUEY VALUEZ

surface angular velocity of star as fraction of Keplerian rotation velocity.

This card allows to give the star a fraction of Keplerian velocity at the surface at the equator at startup such that the star is rigidly rotating. The rotation value on the grid cards is ignored. Components not specified are assumed to be 0..

New In Version >15.0.0.

Changed In Version 17.10.0: Added 3D components.

Original entry:

Optional Cards

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.

Original entry:

Special Purpose Commands

awcorotz

z-component of co-rotation angular velocity.

name

number

type

default

unit

awcorotz

430

float

0.

-

Enabled using ymcorot (p 431).

New In Version 16.19.0.

Changed In Version 17.10.0: Renamed awcorot to awcorotx. Is no longer used as switch to enable co-rotation. Exclusively use ymcorot (p 431) instead.

Note

old text:

Make the outermost ymcorot (p 431) rotate with angular velocity awcorot. Off if < 0..

Todo

TODO: Add case ymcorot (p 431)=0. to enforce surface co-rotate with large (infinite) reservoir.

Original entry:

Rotation Parameters

ymcorot

Make the outermost ymcorot (p 431) rotate with angular velocity (awcorotx (p 581), awcoroty (p 582), awcorotz (p 430)). Off if < 0..

name

number

type

default

unit

ymcorot

431

float

-1.

-

New In Version 16.19.0.

Changed In Version 17.10.0: Now sets 3D vector.

Original entry:

Rotation Parameters

angw0z

z-component of angular velocity of the inner angw0m (p 511) mass.

name

number

type

default

unit

angw0z

510

float

0.

rad/sec

New In Version 16.77.0.

Changed In Version 17.10.0: changed from aligned angular velocity to z-component.

Original entry:

Rotation Parameters

angjaccz

z-component of specific angular momentum of newly accreted material.

name

number

type

default

unit

angjaccz

512

float

0.

cm/sec**2

New In Version 16.77.0.

Changed In Version 17.10.0: Renamed angjacc to angjaccz.

Note

old text:

Specific angular momentum of newly accreted material.

Original entry:

Rotation Parameters


Version 17.9.2

Additions:

abu

Raw Abundance Card.

name

parameters

abu

NETNUMB FIRSTZONE LASTZONE

c raw ppnb data (as needed in ppnb)
c                       n                       h1                      he4                       h2  ...
abu 1 1 1713
  2.57199570952878836e-20  2.92276504318083022e-16  3.31377377797058176e-12  1.40307534576345442e-29  ...
  2.57184753469350309e-20  2.92290502426432282e-16  3.31376675886689560e-12  1.40302102413998302e-29  ...
  2.57167107546864701e-20  2.92307166187862983e-16  3.31375834491020226e-12  3.90094496874634242e-30  ...
  2.57139085053964132e-20  2.92333613611938494e-16  3.31374485630051391e-12  0.00000000000000000e+00  ...
...

NETNUMB

the number of the BURN nuclear-burning network to be used. Currently it must be 1 (see net and netw).

FIRSTZONE

first zone for which abundance data is provided (needs to be \ge 1).

LASTZONE

last zone for which abundance data is provided (needs to be \le jm (q 2)).

Set the mol fractions of all species for the specified zones range for the given network. The isotopes need to be sorted according to BURN convention, in ascending order except $^{4}\mathrm{He}$ needs to be the third isotope. Subsequent lines contain the data, one zone per line, and for each species, format is E25.17.

New In Version 17.9.2.

Original entry:

Required Cards


Version 17.9.1

Changes:

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 17.9.0

Update boundary conditions for full implementation. Fix an omission in the derivatives for GR and streamline implementation.

Additions:

frsurf

Multiplier on centrifugal force use for atmosphere boundary pressure.

name

number

type

default

unit

frsurf

574

float

0.

-

See isurf (p 523)

New In Version 17.9.0.

Original entry:

Physics Parameters

psurfmlt

Multiplier atmosphere boundary pressure.

name

number

type

default

unit

psurfmlt

575

float

1.

-

See isurf (p 523)

New In Version 17.9.0.

Original entry:

Physics Parameters

Changes:

isurf

Choose atmosphere model for added boundary pressure 0.

name

number

type

default

unit

isurf

523

integer

0

-

value

result

1

flag to switch on use of electron scattering opacity (fully ionised) rather than using opacity of surface zone

2

Use full (corrected) equation from Cox & Giuli (1968), \frac{2}{3\,\kappa}\left(\frac{GM}{R^2}-f\frac{j_\mathrm{surf}^2}{R^3}\right)

4

Flag to add pressure from radiation flux at infinity, \frac{L}{6\pi R^2 c}

8

Similar to 4 but use formilation based on temperature of outermost zone, \frac16a\,T^4

Note

4 and 8 are exclusive

Adding 2 and 4 (for a value for 6) is the same as neglecting the factor (1-\Gamma) for effective gravity reduction due to radiation pressure gradient. Usually you may want to pick one of 2, 3, and 4. Adding 1 switched to the use of electron scattering opacity.

In the formula above, f is multiplier frsurf (p 574) on centrifugal force based on the specific angular momentum of the surface layer, j_\mathrm{surf}, which us angj(jm). To use the centrifugal force at the equator, use a value of 2.25, but 1. may be a better choice for a value representing the average.

The boundary pressure computed from the model is multiplied by psurfmlt (p 575) and then added to the surface boundary pressure from pbound (p 69) and from accretion mass, xmacrete (p 212).

Warning

Hence, if you do not have an accretion model and want to use the atmosphere model only, you need to set pbound (p 69) to 0..

Note

Surface boundary temperature is not modified.

New In Version 16.84.0.

Changed In Version 17.9.0: The use of the numerical values has been re-defined, and this is also the first actually working version.

Original entry:

Physics Parameters


Version 17.8.7

Fix abar/zbar bug in bburn.f that affected neutrino loss. Bad bug from 2002.


Version 17.8.6

Some bug fixes for qset and cmd files.


Version 17.8.5

Changes:

xfracml

Subtract any “surface” mass loss specified by xmlossm (p 220) or xmloss0 (p 221) from the zone closest to the surface that still has more than fracs grams of material overlying it.

name

number

type

default

unit

xfracml

225

float

0.01

-

fracs is computed based on xfracml (p 225) according to

value

result

xfracml (p 225) < 0.

fracs = -xfracml (p 225) * totm (q 17)

0. < xfracml (p 225) <= 1.

fracs = xfracml (p 225) * totm0 (p 222)

xfracml (p 225) > 1.

fracs = xfracml (p 225)

This should be set so that mass is not extracted from zones too near the surface in order to avoid excessive dezoning, small timesteps, and luminosity fluctuations.

Changed In Version 17.8.5.

Todo

TODO: Rewrite to add/note new schemes.

Original entry:

Mass Loss Parameters


Version 17.8.3

Another fix heating for simultaneous accretion and mass loss.


Version 17.8.2

Fix low-temperature fit for Tumino+2018 carbon burning rate (contributed by Projjwal Banerjee).


Version 17.8.1

Fix heating for simultaneous accretion and mass loss, e.g., as in the case of super-Eddington XRBs and superbursts.


Version 17.8.0

Additions:

ir1212

$^{12}\mathrm{C}$+$^{12}\mathrm{C}$ rate to use.

name

number

type

default

unit

ir1212

573

integer

0

-

Is used in both APPROX and BURN networks.

Specail values:

value

result

0

use CF88.

1

use Tumino+ 2018 rate. Fit by Projjwal Banerjee.

New In Version 17.8.0.

Original entry:

Nuclear Reaction Parameters


Version 17.7.5

sumb and sumi family of commands, and plot 9 (y etc.) will now exclude zones below bmasslow (p 419).

Changes:

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

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.

Original entry:

Normal Program Managment Commands

iproyld

Determines the BURN abundance plot type (plot 9).

name

number

type

default

unit

iproyld

399

integer

0

-

The following plot types are currently supported:

value

result

0

Total decayed mass fractions relative to solar (“production factors”). See profmin (p 413) and profmax (p 414).

1

Decayed isotope masses in solar masse (yield). See proymin (p 402) and proymax (p 403).

2

Decayed isotope mass fraction. See proamin (p 415) and proamax (p 416).

3

Undecayed isotope masses in solar masses (yield). See proymin (p 402) and proymax (p 403).

4

Undecayed isotope mass fraction. See proamin (p 415) and proamax (p 416).

5

Elemental decayed production factor relative to solar. See profmin (p 413) and profmax (p 414).

6

Decayed mass of all elements in solar masses (yield). See proymin (p 402) and proymax (p 403).

7

Decayed mass fraction of all elements. See proamin (p 415) and proamax (p 416).

8

undecayed elemental yield (solar masses) See proymin (p 402) and proymax (p 403).

9

undecayed elemental yield (mass fraction) See proamin (p 415) and proamax (p 416).

10

decayed isobaric production factor (solar) See profmin (p 413) and profmax (p 414).

11

decayed isobaric yield (solar masses) See proymin (p 402) and proymax (p 403).

12

decayed isobaric yield (mass fraction) See proamin (p 415) and proamax (p 416).

13

undecayed isobaric yield (solar masses) See proymin (p 402) and proymax (p 403).

14

undecayed isobaric yield (mass fraction) See proamin (p 415) and proamax (p 416).

101

Values in burnamax, undecayed isotope mass fraction.

102

Values in burnmmax, mass coordinates.

103

Values in ibcmax, cycle numbers.

Stable isotopes are drawn as filled dots, unstable ones a circles.

New In Version 15.22.0.

Changed In Version 17.7.4: Updated limits.

Changed In Version 17.7.5: Switched plot types 2 and 3 for consistency of ordering with other plot types.

Original entry:

Abundance Plot Parameters


Version 17.7.4

Changes:

iproyld

Determines the BURN abundance plot type (plot 9).

name

number

type

default

unit

iproyld

399

integer

0

-

The following plot types are currently supported:

value

result

0

Total decayed mass fractions relative to solar (“production factors”). See profmin (p 413) and profmax (p 414).

1

Decayed isotope masses in solar masse (yield). See proymin (p 402) and proymax (p 403).

2

Decayed isotope mass fraction. See proamin (p 415) and proamax (p 416).

3

Undecayed isotope masses in solar masses (yield). See proymin (p 402) and proymax (p 403).

4

Undecayed isotope mass fraction. See proamin (p 415) and proamax (p 416).

5

Elemental decayed production factor relative to solar. See profmin (p 413) and profmax (p 414).

6

Decayed mass of all elements in solar masses (yield). See proymin (p 402) and proymax (p 403).

7

Decayed mass fraction of all elements. See proamin (p 415) and proamax (p 416).

8

undecayed elemental yield (solar masses) See proymin (p 402) and proymax (p 403).

9

undecayed elemental yield (mass fraction) See proamin (p 415) and proamax (p 416).

10

decayed isobaric production factor (solar) See profmin (p 413) and profmax (p 414).

11

decayed isobaric yield (solar masses) See proymin (p 402) and proymax (p 403).

12

decayed isobaric yield (mass fraction) See proamin (p 415) and proamax (p 416).

13

undecayed isobaric yield (solar masses) See proymin (p 402) and proymax (p 403).

14

undecayed isobaric yield (mass fraction) See proamin (p 415) and proamax (p 416).

101

Values in burnamax, undecayed isotope mass fraction.

102

Values in burnmmax, mass coordinates.

103

Values in ibcmax, cycle numbers.

Stable isotopes are drawn as filled dots, unstable ones a circles.

New In Version 15.22.0.

Changed In Version 17.7.4: Updated limits.

Changed In Version 17.7.5: Switched plot types 2 and 3 for consistency of ordering with other plot types.

Original entry:

Abundance Plot Parameters

proymin

Minimum value for yield in BURN plot types 1, 2, 6, 8, 11, and 13 (iproyld (p 399)).

name

number

type

default

unit

proymin

402

float

1.e-10

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 15.22.0.

Changed In Version 17.7.4: Added 8, 11, and 13.

Original entry:

Abundance Plot Parameters

proymax

Maximum value for yield in BURN plot types 1, 2, 6, 8, 11, and 13 (iproyld (p 399)).

name

number

type

default

unit

proymax

403

float

1000.

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 15.22.0.

Changed In Version 17.7.4: Added 8, 11, and 13.

Original entry:

Abundance Plot Parameters

profmin

Minimum value for production factor in BURN plot types 0, 5, and 10 (iproyld (p 399)).

name

number

type

default

unit

profmin

413

float

0.0001

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 16.1.0.

Changed In Version 17.7.4: Added 10.

Original entry:

Abundance Plot Parameters

profmax

Maximum value for production factor in BURN plot types:n:0, 5, and 10 (iproyld (p 399)).

name

number

type

default

unit

profmax

414

float

1000.

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 16.1.0.

Changed In Version 17.7.4: Added 10.

Original entry:

Abundance Plot Parameters

proamin

Minimum value for the mass fraction BURN plot types 3, 4, 7, 9, 12, and 14 (iproyld (p 399)).

name

number

type

default

unit

proamin

415

float

1.e-12

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 16.2.0.

Changed In Version 17.7.4: Added 9, 12, and 14.

Original entry:

Abundance Plot Parameters

proamax

Maximum value for the mass fraction BURN plot types 3, 4 7, 9, 12, and 14 (iproyld (p 399)).

name

number

type

default

unit

proamax

416

float

1000.

-

Automatic determination if set to 0.. If set to a negative value it forces (negated) this value, even if not required to show the data.

New In Version 16.2.0.

Changed In Version 17.7.4: Added 9, 12, and 14.

Original entry:

Abundance Plot Parameters


Version 17.7.3

Additions:

burnmplt

name

parameters

burnmplt

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

burnmplt

New In Version 17.7.3.

Original entry:

Graphics Edit Commands

burncplt

name

parameters

burncplt

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

burncplt

New In Version 17.7.3.

Original entry:

Graphics Edit Commands

zero

Reset all relevant parameter as is stating a fresh run.

name

parameters

zero

This is to be used after, e.g., some initial relaxation step.

zero

Full implementation is still pending.

New In Version 17.7.3.

Original entry:

Link Input Cards


Version 17.7.2

Bug fix in zoning from . Documentation updated to HTML5 and added favicon.


Version 17.7.1

Changes:

irtype

x-axix type for plots.

name

number

type

default

unit

irtype

132

integer

3

-

value

result

1

log radius (cm).

2

interior mass fraction q (fraction of total mass)

3

interior mass in Msun (including summ0 (p 61))

4

radius (cm)

5

log interior mass in Msun (including summ0 (p 61))

6

zone number

7

log interior mass (Msun) using jp0 (p 119) and jp1 (p 120)

8

interior mass (Msun) using jp0 (p 119) and jp1 (p 120)

9

log exterior mass (Msun) using jp0 (p 119) and jp1 (p 120)

10

exterior mass (Msun) using jp0 (p 119) and jp1 (p 120)

11

log column density (g/cm**2) using jp0 (p 119) and jp1 (p 120)

12

column density (g/cm**2) using jp0 (p 119) and jp1 (p 120)

13

pressure (erg/cc) using jp0 (p 119) and jp1 (p 120)

14

log pressure (erg/cc) using jp0 (p 119) and jp1 (p 120)

15

(non-relativistic) gravitational potential (cm**2/sec**2) using jp0 (p 119) and jp1 (p 120)

16

log (non-relativistic) gravitational potential (cm**2/sec**2) using jp0 (p 119) and jp1 (p 120)

17

normalized (non-relativistic) gravitational potential (c**2) using jp0 (p 119) and jp1 (p 120)

18

log normalized (non-relativistic) gravitational potential (c**2) using jp0 (p 119) and jp1 (p 120)

19

gravitational redshift using jp0 (p 119) and jp1 (p 120)

20

log gravitational redshift using jp0 (p 119) and jp1 (p 120)

21

enclosed volume (cc) using jp0 (p 119) and jp1 (p 120)

22

log enclosed volume (cc) using jp0 (p 119) and jp1 (p 120)

23

enclosed volume (Rsun**3) using jp0 (p 119) and jp1 (p 120)

24

log enclosed volume (Rsun**3) using jp0 (p 119) and jp1 (p 120)

25

optical depth using jp0 (p 119) and jp1 (p 120)

26

log optical depth using jp0 (p 119) and jp1 (p 120)

27

moment of inertia coordinate (g*cm**2)

28

log moment of inertia coordinate (g*cm**2)

29

moment of inertia coordinate (Msun*Rsun**2)

30

log moment of inertia coordinate (Msun*Rsun**2)

Note

For x-axis Types 2 and 3 the diffusion coefficients in Plot Types 7 and 8 are shown in mass units, as it is most useful for investigating mixing of chemical species, for y-axis Types 1 and 4 they are radius mass units, and for x-axis Type 5 they are given in moment of inertia coordinates, as it is most useful if transport of angular momentum is considered. For Plot Types :9 - 12 the surface of the star is to the left.

Changed In Version <15.0.0: Added new plot types.

Changed In Version >15.0.0: Added new plot types.

Changed In Version 17.0.13: Added plot types 25 and 26.

Changed In Version 17.7.1: Moved plot type 5 to 29. Added new plot 5 and plots 27, 28, and 30.

Original entry:

Radial Coordinate-Control Graphics Parameters


Version 17.7.0

Additions:

taumin

Use optical depth-based zoning where \tau>taumin (p 570).

name

number

type

default

unit

taumin

570

float

0.

-

If set to \le0. then use optical depth-based zoning out to surface.

Zones are rezoned (and kept rezoned) roughly when their optical depth ratio is greater than taurat (p 571), with a cut-off at taulim (p 572) for consideration in computing the ratio.

Note

This is will only have an effect is zoning is switched on for densities and radii at the surface layers, i.e., consider the settings of parameters, e.g., dnmin (p 84), tnmin (p 83), rnmax (p 88), zonermin (p 457), zonemmin (p 336).

Note

This is now on by current default.

New In Version 17.7.0.

Original entry:

General Rezoning Parameters

taurat

Optical depth ratio used in rezoning.

name

number

type

default

unit

taurat

571

float

0.2

-

See taumin (p 570).

New In Version 17.7.0.

Original entry:

General Rezoning Parameters

taulim

Optical depth limit used in rezoning.

name

number

type

default

unit

taulim

572

float

0.1

-

See taumin (p 570).

New In Version 17.7.0.

Original entry:

General Rezoning Parameters


Version 17.6.11

Add convert statement directly to all unformatted I/O open statements. This way we no longer require environment variable, which may conflict with other FORTRAN code.

Note

Code compiled this way can still be influenced by the environment variable, e.g., if set for other codes.

This largely affects the Python model. Coming from a library, the compile-time convert statement has no effect as this only affects the main program - and for a library there is none.


Version 17.6.10

adzone now copies convective status of middle interface to both new interfaces.

… todo::

System Message: INFO/1 (/home/alex/kepler/source/doc/History.rst, line 648)

Blank line missing before literal block (after the “::”)? Interpreted as a definition list item.

Add flag to allow add preventing zone from becoming convective if interfacing with is network boundary.


Version 17.6.9

Changes:

noqsecon

Flags regulating transition to QSE for convectively coupled zones.

name

number

type

default

unit

noqsecon

210

integer

0

-

value

result

1

Don’t force zones that are convectively coupled to ISE zones to go to ISE

2

Don’t transition zones to ISE that are convectively coupled to APPROX zones

Flags may be combined (added).

Warning

This parameter should be kept zero unless you really understand what you’re doing.

Changed In Version 17.6.9: Added noqsecon (p 210) flag 2. In previous versions noqsecon (p 210) > 0 was used instead of flag 1.

Original entry:

ISE Network Transition Parameters


Version 17.6.8

Default value for iold (p 388) for versions < now is 1 for consistency with other iold (p 388) levels.

Note

There is now also a new mongo version for Linux x86 for gfortran version > 7.1 on the main branch.


Version 17.6.7

Fix typo in checkazn.


Version 17.6.6

Fix format problem in dumpio when loading old models.


Version 17.6.5

Add fix for double counting neutrino spallation (iold (p 388)=16). Reformat some routines to use implicit none and coding style updates.

Changes:

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 17.6.4

Add reaction type 23 for spontaneous emission of neutrons and protons (i_ns, i_ps) for corresponding reaclib rates.


Version 17.6.3

Update solas09.dat to jupiter values of $^{15}\mathrm{N}$:$^{14}\mathrm{N}$ abundance ratio of 1:435 (mol fraction).

Note

solas09.dat - current solar abundance should be used for production factors, however, solas12.dat and solas12bg should be used to generate models of initial solar composition.


Version 17.6.2

Add mixdiff function to ttycom and as a subroutine. Make zone parameters to mix command optional.

Additions:

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.

Original entry:

Special Purpose Commands

Changes:

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.

Original entry:

Special Purpose Commands


Version 17.6.1

Separate mix and novamix functions into its one subroutine, fix but that delmass was used in mix procedure but also was used as a q parameter in kepcom.

Changes:

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.

Original entry:

Special Purpose Commands


Version 17.6.0

Add branch name to history (maximum 16 characters).

Write message if git was not clean.

Additions:

Debug and Production Runs

By default KEPLER will no longer run if built from a non-clean git status of the source directory. You can for running force debug purpose if you specify the x flag on the command line.

Important

The purpose of this change is to ensure code git hashes for the KEPLER version running a problem remain accurate. Results from non-clean git repos can never be traced back later with any level of confidence.

New In Version 17.6.0.

Changes:

(optional) is a set of one or more space delimited words in arbitrary order chosen from among the following possibilities:

Option

Meaning

s

To suspend the code after starting.

k

do not load BURN data and kill burning, similar to the killburn command.

d

To destroy the ASCII output files after sending them to the microfiche printer (not currently implemented – see also the discussion of parameter iautoout (p 159).

h

To automatically make a paper copy of the ASCII output files (not currently implemented).

c

write out stored command file (overwrite existing).

a

append stored command file.

p

make plot on start-up.

n

suppress graphical output, e.g., for batch mode.

x

DEBUG mode. Allow running without proper git hash.

X

Extended DEBUG mode. Could be used to enable internal debugging code. Adds 2 to internal idebug variable.

Changed In Version >15.0.0: Added k option.

Changed In Version 17.1.0: Added c and a options.

Changed In Version 17.6.0: Added x option.

Changed In Version 17.11.7: Added p and n options.

Changed In Version 18.0.1: Added X option.


Version 17.5.3

Update build process (Makefile.make) to cleanly separate source code from build directory suing include files (-I directive). This will now only compile if there is actual changes to source rather than every time make is called.

Important

You may want to remove the files

uuid_com
kepcom
zcom

from the build directory. You can also just call make clean in the build directory to be on the save side.

Important

You need to remove the files

gitcom
gridcom
nburncom
fuldat.f

from the source directory. Just to be sure, this has been added to make clean as well.

Note

The same applies for building the Python module.


Version 17.5.2

Fix $^{28}\mathrm{Si}$(\alpha,\gamma) reverse rate in specl0.f. Contributed by Stan.


Version 17.5.1

Some refactoring in setrate. The partition function now allows the individual levels independent of polynomial fit. A bug was fixed that allowed to add up to 6 levels whereas the array was only good for up to 3 - this could have led to overflows, unchecked … there is now a new parameter NIST with current default 3 to set maximum number of levels for partition function statistical weight.


Version 17.5.0

Additions:

convmass

Don’t do convcetion outside convmass (p 569).

name

number

type

default

unit

convmass

569

float

1.e+99

-

Note

Unit of convmass (p 569) is in uints of solar masses if <1.e+10 otherwise in unit of grams.

New In Version 17.5.0.

Original entry:

Convection Parameters


Version 17.4.0

Additions:

iaccunit

Unit in which to measure accretion depth.

name

number

type

default

unit

iaccunit

568

integer

0

-

value

result

0

use mass or mass fraction as measured from surface (see accdepth (p 514).

1

use optical depth from surface.

New In Version 17.4.0.

Original entry:

Accretion Parameters


Version 17.3.2

Changes:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 17.3.1

Update prompt to include problem name nameprob.

Changes:

* [ NAME ]

Alternate entry point.

Command file execution is also started/tested at these points. Named entry points are only executed using the cmd_call subroutine (currently used for all standard aliases), or can be accessed using the ! command

*
* bounce

Changed In Version 17.0.2: added NAME option

Changed In Version 17.3.1: called for standard aliases.


Version 17.3.0

Additions:

loczone

Flag to switch on local criterion for new mass grid on adzoning and dezoning.

name

number

type

default

unit

loczone

567

integer

0

-

value

result

0

Use masses of neighbouring zones to determine ratio of new zones.

1

Use only local zone masses within region of rezoning.

It has been noted that if a range neighbouring zones are rezoned the order of zoning does matter if the non-local criterion is used. In particular, if a region of constant mass zoning were to be re-zoned, a zig-zack pattern in zone masses results since the bottom of the rezone region would try to match the already refined zones below, whereas the at the upper end the algorithm would try to match the not yet refined zones.

New In Version 17.3.0.

Original entry:

General Rezoning Parameters


Version 17.2.1

Additions:

Note

If you’d like to adjust the standard values of BURN isotopes, nburn and or the maximum zone number, jmz, you can specify those values using the variable names NBURN and JMZ, respectively. These can be specified statically in the Makefile , e.g.,

SOURCE = $(HOME)/kepler/source
SYSTEM = gfortran
VERSION = O64
NBURN = 500
JMZ = 32767
include $(SOURCE)/Makefile.make

or, alternatively, add the definitions to the make command line, e.g.,

make JMZ=1983 NBURN=4096

Whereas any changes in this file should propagate to all paces where these definitions are needed, it is not clear, however, whether this is the case consistently. It is therefore recommended, for the time of this writing, to perform a

make clean

before recompiling the code using make.

Warning

JMZ needs to be an odd number and NBURN needs to be an even number. NBURN should be at least 500.

For compilation on older system where the FORTRAN 2003 intrinsic ieee_arithmetic is not defined, we may chose an alternate version to use, with its corresponding compile flags

IEEEVALS = ieeevals_gcc4.f90
IEEEFLAGS := -fno-range-check

For development to disable x flag, we may chose an alternate version to use

PROGDBG = progdbg_devel.f90

To disable compilation for native architecture use in

ARCH = none

in Makefile.

New In Version 17.2.1.

Changed In Version 17.3.2: Added FULDAT variable to Makefile.

Changed In Version 18.2.3: Added variables IEEEVALS and IEEEFLAGS to Makefile.

Changed In Version 18.3.0: Added variables PROGDBG to Makefile. Added variables ARCH to Makefile.

Changed In Version 18.7.11: Variable FULDAT replaced by variable FULDEF.

Changed In Version 18.7.16: Variable FULDAT deprecated. Use proper link to desired fuldat version instead.


Version 17.2.0

Add gam edit variable.

Additions:

xmlosse

Mass loss for super-eddignton luminosity.

name

number

type

default

unit

xmlosse

565

float

0.

-

Mulitplier on mass loss if luminosity exceeds Eddington luminosity. This is corrected for GR for X-ray burst simulations, although this is not full GR but the XRB still uses local Newtonian gravity.

\dot{M}=(L/(1+z)^2-L_{\mathrm{Edd}})/(GM/R)

where

1/(1+z)=\sqrt{1-2GM/Rc^2}

and

L_\mathrm{Edd}=4\pi G M c / (0.2\,(1+X))

Values of L, R, M are taken at jm-jslosse (p 566).

New In Version 17.2.0.

Original entry:

Mass Loss Parameters

jslosse

Determine zone where values for Eddington luminosity mass loss are taken.

name

number

type

default

unit

jslosse

566

integer

1

-

See xmlosse (p 565) for details.

New In Version 17.2.0.

Original entry:

Mass Loss Parameters


Version 17.1.10

Update format for neutrino binary output “*.nu” file.


Version 17.1.9

Changes:

ipup

Abundance update parameter. Update abundances only if ipup (p 28) :math:’ne’ 0.

name

number

type

default

unit

ipup

28

integer

1

-

value

result

1

only calculate zonal reaction rates, no updates

0

no abundance updates anywhere

1

abundance updates everywhere (normal)

2

no updates in zones less than jshell0 (p 93)

3

no updates in zones jshell0 (p 93) \le j \le jshell1 (p 94)

4

no updates in zones j greater than jshell1 (p 94)

5

no updates in zones below bmasslow (p 419)

Changed In Version 17.1.9: Added Option 5 for accretion/XRB problem

Original entry:

Nuclear Reaction Parameters


Version 17.1.8

Prevent mixing between BURN and APPROX regions in APPROX network in case lburn (p 434) is set to 1.


Version 17.1.7

Changes:

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.

Original entry:

Normal Program Managment Commands


Version 17.1.6

Initialise zinit (q 134) on generation so it is available in cycle 1


Version 17.1.5

setrate fix allowing all decays at low temperature


Version 17.1.4

Changes:

n14pg

Version of N14(p,g) rate to use.

name

number

type

default

unit

n14pg

483

integer

3

-

value

result

0

original CF88 N14(p,g) rate

1

multiply the first term of the CF88 N14(p,g) rate by 0.54

2

use Imbriani et al. (2005) rate, REACLIB implementation

3

use Imbriani et al. (2005) rate, original formula

This is to account for new measurements.

New In Version 16.57.0.

Changed In Version 17.1.3: Added Options 2 and 3.

Changed In Version 17.1.4: New default value for new runs is 3.

Original entry:

Nuclear Reaction Parameters


Version 17.1.3

Changes:

n14pg

Version of N14(p,g) rate to use.

name

number

type

default

unit

n14pg

483

integer

3

-

value

result

0

original CF88 N14(p,g) rate

1

multiply the first term of the CF88 N14(p,g) rate by 0.54

2

use Imbriani et al. (2005) rate, REACLIB implementation

3

use Imbriani et al. (2005) rate, original formula

This is to account for new measurements.

New In Version 16.57.0.

Changed In Version 17.1.3: Added Options 2 and 3.

Changed In Version 17.1.4: New default value for new runs is 3.

Original entry:

Nuclear Reaction Parameters

ivrate

Version of the APPROX network rate subroutine to use.

name

number

type

default

unit

ivrate

422

integer

1

-

Currently:

value

result

0

WW95 rate set

1

use the rath00 rate set including the $^{12}\mathrm{C}$(\alpha, \gamma) rate form Buchmann et al. (2000) and Buchmann, priv. comm. (Jul 2000).

2

uses the NACRE c12ag rate.

3

use the rath00 rate set and the adopted values of Kunz et al.(2002, ApJ).

4

use the rath00 rate set and the low values of Kunz et al.(2002, ApJ).

5

use the rath00 rate set and the high values of Kunz et al.(2002, ApJ).

6

use the rath00 rate set and the REACLIB implementation of Kunz et al.(2002, ApJ).

On restart of older programs a value of 0 is initialized.

ivrate (p 422) values of 3, 4, and 5 also selects these rates in the rath00 rate set BURN co-processing “special” subroutine specl0 (see specl.f and specl0.f.)

New In Version 16.10.0.

Changed In Version 17.1.3: Added Option 6.

Changed In Version 18.8.6: Now Option 1 _actually_ uses NACRE c12ag rate, and Iotion 0 _actually_ uses the cf88 c12ag rate.

Original entry:

BURN Physics Parameters


Version 17.1.2

Changes:

accdepth

Depth where mass is to be accreted.

name

number

type

default

unit

accdepth

514

float

0.

-

value

result

0.

zones are accreted at the surface (traditional behavior).

< 0.

accrete a zone with mass fraction -accdepth (p 514) = ym / totm (q 17).

> 0.

accrete at location accdepth (p 514) = ym.

New In Version 16.80.0.

Changed In Version 17.1.2: Negative values scale with totm (q 17) not totm0 (p 222) to allow dynamic adjustment for accreton problems with significant growth of mass.

Original entry:

Accretion Parameters


Version 17.1.1

Set default value for rmaxeadv (p 564) on restart to 1.e+99.


Version 17.1.0

Added sha, version number, user name, and machine name to history. Added storage of current command file to dump.

Changes:

(optional) is a set of one or more space delimited words in arbitrary order chosen from among the following possibilities:

Option

Meaning

s

To suspend the code after starting.

k

do not load BURN data and kill burning, similar to the killburn command.

d

To destroy the ASCII output files after sending them to the microfiche printer (not currently implemented – see also the discussion of parameter iautoout (p 159).

h

To automatically make a paper copy of the ASCII output files (not currently implemented).

c

write out stored command file (overwrite existing).

a

append stored command file.

p

make plot on start-up.

n

suppress graphical output, e.g., for batch mode.

x

DEBUG mode. Allow running without proper git hash.

X

Extended DEBUG mode. Could be used to enable internal debugging code. Adds 2 to internal idebug variable.

Changed In Version >15.0.0: Added k option.

Changed In Version 17.1.0: Added c and a options.

Changed In Version 17.6.0: Added x option.

Changed In Version 17.11.7: Added p and n options.

Changed In Version 18.0.1: Added X option.


Version 17.0.13

Additions:

The xsave flag enables saving of command file before each command execution. This is to prevent loss of changes to command file in case KEPLER terminates during execution, e.g., for a end command.

% xsave

New In Version 17.0.13.

The noxsave flag disables saving of command file before each command execution. This save a lot of write operations, however, changes to command file may be lost in case KEPLER terminates during execution, e.g., for a end command.

% noxsave

New In Version 17.0.13.

The end flag end KEPLER in a save way, also saving the command file properly before termination.

% end

New In Version 17.0.13.

The delete directive deletes the command file and terminates its execution.

% delete

New In Version 17.0.13.

The delsec directive deletes the current section and skips to the next section.

*
: tn(1) > 1.d8
p 1 1.
@ dn(1) > 1.d6
% delsec

New In Version 17.0.13.

>

Jump back to origin of previous labelled.

:
< ttest
> home tn(1) > 1.d9
>
< home
p 1 1.
>

New In Version 17.0.13.

>>

Skip rest of section.

:
c example of coding if/then/else
c
> home tn(1) > 1.d9
p 1 2. *
>>
< home
p 1 2. /

If executing external call to alternate entry point, just return, identical to the !! directive.

New In Version 17.0.13.

>>>

Terminate execution of command file.

>>>

If executing external call to alternate entry point, just return, identical to the !! directive.

New In Version 17.0.13.

dtau

Optical thickness of zone.

name

type

unit

centering

storage

dtau

float

-

center

loadbuf

New In Version 17.0.13.

Original entry:

Miscellaneous

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.

Original entry:

Special Purpose Commands

rmaxeadv

Maximum radius for which energy deposition for advection from accretion is considered.

name

number

type

default

unit

rmaxeadv

564

float

1.e+99

-

Useful for XRB simulations if the photosphere expands beyond the inner edge of the accretion disk. Should be set to the radius of the innermost stable orbit in these cases.

New In Version 17.0.13.

Original entry:

Accretion Parameters

jaccemx

Maximum zone for which accretion advection luminosity is added.

name

number

type

unit

jaccemx

149

integer

-

New In Version 17.0.13.

Original entry:

Accretion-Related Parameters

Changes:

@ [ EXPRESSION ]

If EXPRESSION evaluates to .TRUE., the @ command is removed and the subsequent command are executed and removed until the next @, :, ;, or * command. An empty expression is interpreted as .TRUE., allowing to specify sections to be executed only once.

@ tn(0) > 1.d4
p xmlossn 1.
*
:
> lowt tn(1) < 1.d9
p 13 0.
p 69 0.
@
zerotime
>>
< lowt
p 13 .1
p 69 {pn(0) * 0.5}

Changed In Version 17.0.13: Make expression optional.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

iaccadv

Advection of composition during accretion.

name

number

type

default

unit

iaccadv

521

integer

1

-

value

result

0

composition is not advected this can be useful for setting up initial models for accretion problems

1

enable composition advection (recommended).

2

add composition (and angular momentum) at the location of the accretion depth, accdepth (p 514). This can be useful in case of accretion streams of common envelope models.

New In Version 16.83.0.

Changed In Version 17.0.13: Added option 2

Original entry:

Accretion Parameters

irtype

x-axix type for plots.

name

number

type

default

unit

irtype

132

integer

3

-

value

result

1

log radius (cm).

2

interior mass fraction q (fraction of total mass)

3

interior mass in Msun (including summ0 (p 61))

4

radius (cm)

5

log interior mass in Msun (including summ0 (p 61))

6

zone number

7

log interior mass (Msun) using jp0 (p 119) and jp1 (p 120)

8

interior mass (Msun) using jp0 (p 119) and jp1 (p 120)

9

log exterior mass (Msun) using jp0 (p 119) and jp1 (p 120)

10

exterior mass (Msun) using jp0 (p 119) and jp1 (p 120)

11

log column density (g/cm**2) using jp0 (p 119) and jp1 (p 120)

12

column density (g/cm**2) using jp0 (p 119) and jp1 (p 120)

13

pressure (erg/cc) using jp0 (p 119) and jp1 (p 120)

14

log pressure (erg/cc) using jp0 (p 119) and jp1 (p 120)

15

(non-relativistic) gravitational potential (cm**2/sec**2) using jp0 (p 119) and jp1 (p 120)

16

log (non-relativistic) gravitational potential (cm**2/sec**2) using jp0 (p 119) and jp1 (p 120)

17

normalized (non-relativistic) gravitational potential (c**2) using jp0 (p 119) and jp1 (p 120)

18

log normalized (non-relativistic) gravitational potential (c**2) using jp0 (p 119) and jp1 (p 120)

19

gravitational redshift using jp0 (p 119) and jp1 (p 120)

20

log gravitational redshift using jp0 (p 119) and jp1 (p 120)

21

enclosed volume (cc) using jp0 (p 119) and jp1 (p 120)

22

log enclosed volume (cc) using jp0 (p 119) and jp1 (p 120)

23

enclosed volume (Rsun**3) using jp0 (p 119) and jp1 (p 120)

24

log enclosed volume (Rsun**3) using jp0 (p 119) and jp1 (p 120)

25

optical depth using jp0 (p 119) and jp1 (p 120)

26

log optical depth using jp0 (p 119) and jp1 (p 120)

27

moment of inertia coordinate (g*cm**2)

28

log moment of inertia coordinate (g*cm**2)

29

moment of inertia coordinate (Msun*Rsun**2)

30

log moment of inertia coordinate (Msun*Rsun**2)

Note

For x-axis Types 2 and 3 the diffusion coefficients in Plot Types 7 and 8 are shown in mass units, as it is most useful for investigating mixing of chemical species, for y-axis Types 1 and 4 they are radius mass units, and for x-axis Type 5 they are given in moment of inertia coordinates, as it is most useful if transport of angular momentum is considered. For Plot Types :9 - 12 the surface of the star is to the left.

Changed In Version <15.0.0: Added new plot types.

Changed In Version >15.0.0: Added new plot types.

Changed In Version 17.0.13: Added plot types 25 and 26.

Changed In Version 17.7.1: Moved plot type 5 to 29. Added new plot 5 and plots 27, 28, and 30.

Original entry:

Radial Coordinate-Control Graphics Parameters


Version 17.0.12

Added parameters for a heating layer, to be used for X-ray (super)burst simulations. The heat is deposited in the form of a Gaussian at a fixed location relative to the surface.

Additions:

The nodebug flag switches debugging off (default).

% nodebug

New In Version 17.0.12.

The noecho flag disables printout of expression tests to console.

% noecho

New In Version 17.0.12.

The echo flag enables printout of expression tests to console (possibly misguided default).

% echo

New In Version 17.0.12.

!!

return from entry point (if applicable)

* bounce
p 1 1.
!!

New In Version 17.0.12.

?

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.

Original entry:

Normal Program Managment Commands

@

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.

Original entry:

Normal Program Managment Commands

Variable Replacement

You may specify an expression in curly braces to be replaced by the result of evaluating it, using the same procedure as outlined for command files.

p 38 {p 2}
p 38 {p 2*2.}

New In Version 17.0.12.

xheatl

Rate of energy deposition from extra heating.

name

number

type

default

unit

xheatl

561

float

0.

erg/sec

KEPLER will deposit extra heat a location xheatym (p 562) in a Gaussian window of width (2\,\sigma) xheatdm (p 563) and at a total rate (luminosity) of xheatl (p 561). For check, the total rate of energy deposition is also recorded in enxheatd (q 147) and the total energy deposited over the run in enxheat (q 148).

New In Version 17.0.12.

Original entry:

X-ray Burst Parameters

xheatym

Center of mass where energy is deposited; mass is measured relative to surface.

name

number

type

default

unit

xheatym

562

float

-1.e+99

g

New In Version 17.0.12.

Original entry:

X-ray Burst Parameters

xheatdm

Width (2\,\sigma) of the Gaussian in mass where energy is deposited.

name

number

type

default

unit

xheatdm

563

float

0.

g

New In Version 17.0.12.

Original entry:

X-ray Burst Parameters

enxheatd

Total rate of energy deposition by extra heating.

name

number

type

unit

enxheatd

147

float

erg/sec

New In Version 17.0.12.

Original entry:

X-Ray Burst-related Parameters

enxheat

Total energy deposition by extra heating.

name

number

type

unit

enxheat

148

float

erg

New In Version 17.0.12.

Original entry:

X-Ray Burst-related Parameters

Changes:

> NAME [ EXPRESSION ]

Jump to jump target labelled NAME. If the optional argument EXPRESSION is specified, the jump is only executed if the expression evaluates to .TRUE..

@ tn(1) > 1.d9
> home

A loop example:

:
o i 0 def
< yyy
> xxx i>10
o i {i + 1}
z en {i}
>yyy
<xxx
% end

New In Version 17.0.2.

Changed In Version 17.0.12: Added jump condition.

Arithmetic Expressions

In arithmetic expressions integer and float numbers can be used. Arithmetic operations permitted are +, -, * , / , % (modulo), ** (power), and brackets, ( and ), however, the operands must be of same type (integer or float).

Additionally, the abs, log (logarithm base 10), ln (logarithm base e), exp, sqrt, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, asinh, acosh, atanh, erf, erfc, and erfcs (erfc_scaled), function have been defined.

The type conversion functions aint (truncate to integer - returns float), int (truncate to integer - returns integer), nint (nearest integer - returns integer), floor (nearest integer below - returns integer), ceil (nearest integer above - returns integer), and real (returns float) are defined as well.

The min and max functions return the lower or larger of the two arguments, separated by , or ;. Both arguments need to have same type, which is also type returned.

Changed In Version 17.0.12.

Changed In Version 18.7.4: Removed ^ (now used for xor).

Changed In Version 18.7.5: Add min and max functions.

vloss

Remove the outer zone if its velocity exceeds vloss (p 271) and its radius is larger than rlossmin (p 436), but do not change the previous values of pbound (p 69) and tbound (p 68).

name

number

type

default

unit

vloss

271

float

1.e+99

cm/sec

The APPROX and BURN isotope masses are added to the “wind” arrays.

if vloss (p 271)<0. then the absolute value of vloss (p 271) is interpreted as a multiple of the local escape velocity, \sqrt{2 G M(r) / r} (same in GR), sqrt ( 2 gee geemult (p 359) zm ( jm (q 2) ) / rn ( jm (q 2) ) ).

Changed In Version >15.14.0: Wind mass loss recording added.

Changed In Version 16.25.0: Added rlossmin (p 436).

Changed In Version 17.0.12: Added vesc.

Original entry:

Mass-Loss-Connected Rezoning Parameters


Version 17.0.11

Additions:

//*

Same as // but delete all old command files.

name

parameters

//*

Note

This is done only once during generation, the first time it is encountered.

New In Version 17.0.11.

Original entry:

Optional Cards

Changes:

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.

Original entry:

Other ASCII Output-File Edit Commands

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 17.0.10

Added time-dependent magnetic field for pulsar energy deposition. This now also operates for high-temperature cases.

Additions:

\\

End current command file or BURN generator file section.

name

parameters

\\\\

New In Version 17.0.10.

Original entry:

Optional Cards

pulsb150

Initial magnetic field strength.

name

number

type

default

unit

pulsb150

559

float

1.

1.e+15 G

Use this extended formula with field decay if both pulsb150 (p 559) and pulstau (p 560) are > 0:

E = 2\times10^{52} \left(\frac{P}{1\mathrm{ms}}\right)^{-2}\,\mathrm{erg}

where P is the pulsar rotation rate

\frac{\mathrm{d}E}{\mathrm{d}t} = 10^{49} B_{15}^2 \left(\frac{P}{1\mathrm{ms}}\right)^{-4}\, \mathrm{erg}/\mathrm{s}

where B_{15} is the current magnetic field,

B_{15}   = B_{15,0} + \left(B_{15,0} - B_{15,f}\right) \exp(-t/\tau)

is an arbitrary assumption that causes initial field B_{15,0} (pulsb150 (p 559)) to decay to B_{15,f} (pulsb15 (p 516)) on a characteristic time \tau (pulstau (p 560)), and t is the time since timex0 (p 38), i.e., t = ( time (p 2) - timex0 (p 38) ).

Warning

If timex0 (p 38) < 0 then no pulsar energy is deposited.

New In Version 17.0.10.

Original entry:

GRB / Magnetar Simulation Parameters

pulstau

Decay time of initial magnetic field toward.

name

number

type

default

unit

pulstau

560

float

100.

1.e+15 G

See pulsb150 (p 559).

New In Version 17.0.10.

Original entry:

GRB / Magnetar Simulation Parameters

Changes:

r3amult

Multiplier on triple-alpha reaction rate.

name

number

type

default

unit

r3amult

484

float

1.

-

Is used in both APPROX and BURN networks.

Special values:

value

result

-1.

use rate by Ogota, fit by Richard Cybert, added 20091006.

-2.

use rate by Nguyen et al. (2012) for T<10^8 K and CF88 for T>10^8 K, added 20130514 by Laurens Keek.

-3.

use rate by Fybno et al. (2005) for added 20140506 by Alexander Heger rate provided by Raphael Hirschi

New In Version 16.58.0.

Changed In Version 17.0.1: Added -2.

Changed In Version 17.0.10: Added -3.

Original entry:

Nuclear Reaction Parameters


Version 17.0.9

Added record of energy for pulsar engine and nickel decay.

Corrected pulsar module.

Additions:

enpuls

Energy depositied by pulsar.

name

number

type

unit

enpuls

143

float

erg

New In Version 17.0.9.

Original entry:

Supernova-Related Parameters

enpulsd

Energy deposition rate by pulsar.

name

number

type

unit

enpulsd

144

float

erg/sec

New In Version 17.0.9.

Original entry:

Supernova-Related Parameters

ennidec

Energy depositied by $^{56}\mathrm{Ni}$ decay.

name

number

type

unit

ennidec

145

float

erg

New In Version 17.0.9.

Original entry:

Supernova-Related Parameters

ennidecd

Energy deposition rate by $^{56}\mathrm{Ni}$ decay.

name

number

type

unit

ennidecd

146

float

erg/sec

New In Version 17.0.9.

Original entry:

Supernova-Related Parameters


Version 17.0.8

Corrected APPROX energy generation for weak rates and neutrino losses.

Changes:

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 17.0.7

Added neutrino output format

Additions:

nnuout

Write out data file for neutrino information every nnuout (p 558) cycles.

name

number

type

default

unit

nnuout

558

integer

0

-

Usually should write out data every cycle.

New In Version 17.0.7.

Original entry:

Various Files


Version 17.0.6

Added separate switched for nickel decay, pulsar energy generation, and low-T neutrino losses. These are now all additive.

Additions:

nidecay

Switch for $^{56}\mathrm{Ni}$ decay energy depositon in supernova after explosion.

name

number

type

default

unit

nidecay

557

integer

1

-

value

result

0

switch $^{56}\mathrm{Ni}$ decay energy deposition off

1

switch $^{56}\mathrm{Ni}$ decay energy deposition on (default)

See timex0 (p 38) for a detailed description.

New In Version 17.0.6.

Original entry:

Supernova Parameters


Version 17.0.5

Corrected bug in neutrino loss routine from 2000 (bug originated from Frank Timmes).

Changes:

iold

Set to value other than 0 to use old physics - mostly fix that energy generation in APPROX did not include neutrino losses and mass excess but only considered differences in binding energy. These are used as flags.

name

number

type

default

unit

iold

388

integer

0

-

value

result

0

Use current physics.

1

(bit 0) No nu loss in H burning and BE instead of ME and old nu loss routines (old1/old2, < 1997) this should not affect lburn (p 434) as that was only implemented later, i.e., here was no bug to be fixed - where lburn (p 434) is used, iold (p 388){}\,=1 has no effect.

2

(bit 1) Use old nu loss (old3)

4

(bit 2) Use old (1997) nu loss and ME estimates (bad)

8

(bit 3) Use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

(bit 4) Double counting of $^{3}\mathrm{He}$(n,\gamma), $^{3}\mathrm{H}$(p,\gamma) and reverse. This bug may have been introduced by Alex when adding Langanke \nu-induced spallation.

32

(bit 5) Do not use fix in \nu loss energies for APPROX PP chains.

64

(bit 6) FFN weak rates are used for nu loss in BURN even if rates are zeroed because of being outside temperature/density range.

New In Version 15.15.0.

Changed In Version 17.0.5: Added 2.

Changed In Version 17.0.8: Added 4.

Changed In Version 17.0.11: Added 8.

Changed In Version 17.6.5: Added 16.

Changed In Version 17.9.1: Added 32.

Changed In Version 18.10.3: Added 64.

Original entry:

Physics Parameters


Version 17.0.4

Add UUID version tracking by restart (execution) and execution history. The purpose is to be able to track restarts.

Changes:

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.

Original entry:

Other Terminal Edit Commands


Version 17.0.3

Add $^{12}\mathrm{C}$+$^{12}\mathrm{C}$ rates from Xiao-Dong Tang.

Additions:

iccrate

Select BR for $^{12}\mathrm{C}$+$^{12}\mathrm{C}$ rate.

name

number

type

default

unit

iccrate

556

integer

0

-

value

result

0

default (Dayras et al. 1976)

-1

Xiao-Dong Tang 20130912 pc - temporary CCN BR

-2

Xiao-Dong Tang 20130912 pc - temporary CCN BR upper limit

-3

Xiao-Dong Tang 20130912 pc - temporary CCN BR lower limit

New In Version 17.0.3.

Original entry:

Nuclear Reaction Parameters


Version 17.0.2

Many major changes. Including new command file, optional parameters, new streamlined syntax for most commands “cards.” Notably, cutsurf behaves differently and the z command no longer accepts a single negative number as a range. All commands that that zones numbers now take mass coordinates and ranges as well. See, e.g., <j> command.

Additions:

The debug flag allows debugging of expression interpretation.

% debug

New In Version 17.0.2.

! NAME

execute the named entry point

@ un(1) > 0.
! bounce

New In Version 17.0.2.

< NAME

Jump target, ignored otherwise.

< home

New In Version 17.0.2.

> NAME [ EXPRESSION ]

Jump to jump target labelled NAME. If the optional argument EXPRESSION is specified, the jump is only executed if the expression evaluates to .TRUE..

@ tn(1) > 1.d9
> home

A loop example:

:
o i 0 def
< yyy
> xxx i>10
o i {i + 1}
z en {i}
>yyy
<xxx
% end

New In Version 17.0.2.

Changed In Version 17.0.12: Added jump condition.

Used-Defind Optional (‘O’) Parameters

These parameters can be used in commad files or to specify other quantities that are useful to analysis later. They are set and modified using the o command.

See also

o command

The mode of the parameters (fixed or floating point) follows the normal FORTRAN convention. The current values of the parameters are remembered in the restart dumps.

New In Version 17.0.2.

//

The following lines will be appended to command file until \\ command or end of file.

name

parameters

//

New In Version 17.0.2.

Original entry:

Optional Cards

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.

Original entry:

Normal Program Managment Commands

*

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.

Original entry:

Special Purpose Commands

/

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

Resolution of Commands

The commands desribed in this section are processed by the ttycom subroutine and its entry point execute for KEPLER Generator Input Cards, BURN Generator Cards, and Command Files. If input processing is done by any of these latter, KEPLER first matches against commands local to these functions before passing execution to ttycom as described below.

Changed In Version >16.0.0.

Note

Some of the commands originally were desined for special functions, e.g., “link” files that have now been generalized, and make no sense to use in isolation, i.e., some of them require several commands to yield a menaingful result, e.g., the pst card.

KEPLER first tries to match the input string against the listed commands. In case the commands starts with an integer or float variable, this implies the <j> command.

If no command is found that matches, KEPLER will also try to locate, in this sequence,

  1. Changable (‘P’) Parameters by name

  2. Edit (‘Q’) Parameters by name

  3. Used-Defind Optional (‘O’) Parameters by name

and in case these are found, then a command is executed as if p, q, or o had been specified (implcitly).

New In Version 17.0.2: automatic matching of names against p, q, and o parameters

Changes:

New Commad File Syntax

Changed In Version 17.0.2: the cmd package was rewritten from scratch, including addition of Used-Defind Optional (‘O’) Parameters.

Supported command file-specific commands

% OPTIONS

Options/flags/directives to the command file interpreter. The number of spaces between % and the command may be 0 or larger.

The debug flag allows debugging of expression interpretation.

% debug

New In Version 17.0.2.

The nodebug flag switches debugging off (default).

% nodebug

New In Version 17.0.12.

The simpleq flag switches to simple, single-level “if” statement evaluation (default).

% simpleq

New In Version 18.7.7.

The nestedq flag switches to simple, single-level “if” statement evaluation.

% nestedq

New In Version 18.7.7.

The noecho flag disables printout of expression tests to console.

% noecho

New In Version 17.0.12.

The echo flag enables printout of expression tests to console (possibly misguided default).

% echo

New In Version 17.0.12.

The xsave flag enables saving of command file before each command execution. This is to prevent loss of changes to command file in case KEPLER terminates during execution, e.g., for a end command.

% xsave

New In Version 17.0.13.

The noxsave flag disables saving of command file before each command execution. This save a lot of write operations, however, changes to command file may be lost in case KEPLER terminates during execution, e.g., for a end command.

% noxsave

New In Version 17.0.13.

The end flag end KEPLER in a save way, also saving the command file properly before termination.

% end

New In Version 17.0.13.

The delete directive deletes the command file and terminates its execution.

% delete

New In Version 17.0.13.

The delsec directive deletes the current section and skips to the next section.

*
: tn(1) > 1.d8
p 1 1.
@ dn(1) > 1.d6
% delsec

New In Version 17.0.13.

Changed In Version 17.11.7: Replace # by % to distinguish from comment lines for the off chance of an accidental collision.

* [ NAME ]

Alternate entry point.

Command file execution is also started/tested at these points. Named entry points are only executed using the cmd_call subroutine (currently used for all standard aliases), or can be accessed using the ! command

*
* bounce

Changed In Version 17.0.2: added NAME option

Changed In Version 17.3.1: called for standard aliases.

! NAME

execute the named entry point

@ un(1) > 0.
! bounce

New In Version 17.0.2.

!!

return from entry point (if applicable)

* bounce
p 1 1.
!!

New In Version 17.0.12.

< NAME

Jump target, ignored otherwise.

< home

New In Version 17.0.2.

> NAME [ EXPRESSION ]

Jump to jump target labelled NAME. If the optional argument EXPRESSION is specified, the jump is only executed if the expression evaluates to .TRUE..

@ tn(1) > 1.d9
> home

A loop example:

:
o i 0 def
< yyy
> xxx i>10
o i {i + 1}
z en {i}
>yyy
<xxx
% end

New In Version 17.0.2.

Changed In Version 17.0.12: Added jump condition.

;

All lines until next entry point are ignored.

*
p 1 1.
;
p 1 2.
*
@ tn(1) > 1.d7
p 13 .1

>

Jump back to origin of previous labelled.

:
< ttest
> home tn(1) > 1.d9
>
< home
p 1 1.
>

New In Version 17.0.13.

>>

Skip rest of section.

:
c example of coding if/then/else
c
> home tn(1) > 1.d9
p 1 2. *
>>
< home
p 1 2. /

If executing external call to alternate entry point, just return, identical to the !! directive.

New In Version 17.0.13.

>>>

Terminate execution of command file.

>>>

If executing external call to alternate entry point, just return, identical to the !! directive.

New In Version 17.0.13.

@ [ EXPRESSION ]

If EXPRESSION evaluates to .TRUE., the @ command is removed and the subsequent command are executed and removed until the next @, :, ;, or * command. An empty expression is interpreted as .TRUE., allowing to specify sections to be executed only once.

@ tn(0) > 1.d4
p xmlossn 1.
*
:
> lowt tn(1) < 1.d9
p 13 0.
p 69 0.
@
zerotime
>>
< lowt
p 13 .1
p 69 {pn(0) * 0.5}

Changed In Version 17.0.13: Make expression optional.

: [ EXPRESSION ]

If EXPRESSION evaluates to .TRUE., the commands following up to the next @, :, ;, or * command are executed but not removed. An empty expression is interpreted as .TRUE., allowing to specify sections to be executed repeatedly.

: ncyc % 100 == 0
d #{ncyc}

~

Similar to : command but always evaluates to .FALSE.. This can be used, e.g., to store “subroutine” code sections that are retained unconditionally. Really the same as

: F

New In Version 17.11.7.

? [ EXPRESSION ]

If EXPRESSION evaluates evaluates to .TRUE., then the commands following up to the next ? or ?? command are executed (if statement) and if it evaluates to .FALSE. they are skipped. Removal is independent of whether they are executed or skipped, but is only governed whether on is in a @ or : section. If EXPRESSION is not provided, this serves as a marker for the end of the if statement (endif).

In simpleq mode, any new ? ends the previous section and starts a new one, code after a ? without an EXPRESSION is executed unconditionally.

In nestedq mode, any new ? with an EXPRESSION introduces a new level that is only ended by a final ? without an EXPRESSION.

% simpleq

*
:
dev xl 0.
xl = 1.e8
? (xmlossr > 1.e20)
xl = 5.e7
? (xmlossr > 1.e21)
x = 2.e7
? (xmlossr > 1.e22)
xl = 1.e7
? (xl < 0.99 * xmlossr) | (xl > 1.01 * xmlossr)
dtmax = {xl}

New In Version 18.7.7.

?? [ EXPRESSION ]

If EXPRESSION evaluates evaluates to .TRUE. or is missing and the previous section was not executed, then the commands following up to the next ? or ?? command are executed (elseif/else statements) and otherwise they are skipped. Removal is independent of whether they are executed or skipped, but is only governed whether on is in a @ or : section.

% nestedq

*
:
dev xl {pie}
? (xmlossr > 1.e22)
xl = 1.e7
?? (xmlossr > 1.e21)
x = 2.e7
?? (xmlossr > 1.e20)
xl = 5.e7
??
xl = 1.e8
?
? (xl < 0.99 * xmlossr) | (xl > 1.01 * xmlossr)
dtmax = {xl}

New In Version 18.7.7.

Variable Replacement in Commands

All other commands are processed by ttycom as regular input. Prior to passing the command to ttycom, however, and strings enclosed in curly braces, { and }, are arithmetically interpreted similar to the @ and : commands. The result is converted to a string of same type (integer or float) and passed to ttycom. One extra variable name allowed here is nameprob which is replaced by the current problem name.

One-Time and Persistent Commands

All executed commands not in sections lead by :, including @ commands that match, until the next entry point (*) or comment section (;), are removed from the command file and the revised version is written back to disk. Entry points, (*) and section comments (;) remain unless they mark empty sections.

Arithmetic Expressions

In arithmetic expressions integer and float numbers can be used. Arithmetic operations permitted are +, -, * , / , % (modulo), ** (power), and brackets, ( and ), however, the operands must be of same type (integer or float).

Additionally, the abs, log (logarithm base 10), ln (logarithm base e), exp, sqrt, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, asinh, acosh, atanh, erf, erfc, and erfcs (erfc_scaled), function have been defined.

The type conversion functions aint (truncate to integer - returns float), int (truncate to integer - returns integer), nint (nearest integer - returns integer), floor (nearest integer below - returns integer), ceil (nearest integer above - returns integer), and real (returns float) are defined as well.

The min and max functions return the lower or larger of the two arguments, separated by , or ;. Both arguments need to have same type, which is also type returned.

Changed In Version 17.0.12.

Changed In Version 18.7.4: Removed ^ (now used for xor).

Changed In Version 18.7.5: Add min and max functions.

Command Expressions

Command expressions consist of a logical expression that use the comparison operators >, <, >=, <=, ==, = (same as ==), /=, and != (same as /=) to compare arithmetic expressions. More complex expression can be composed using and brackets, ( and ), ~ (not), & (and), or ^ (xor), and | (or), in that order of precedence. You may use logical values .TRUE., .True., .true., T, .FALSE., .False., .false., or F in or as logical expressions. Use cases may be limited.

Changed In Version 17.11.7: Added logical values and logical not (~).

Changed In Version 18.7.2: Added /= and !=.

Changed In Version 18.7.4: Added ^ (removed as allowed symbol for power).

Special Variables

Special variables are cputime, which returns the CPU time used since start of the current execution, and timeused, which returns the CPU time since start of the problem, both as float and in sec.

Changed In Version 18.7.19: Renamed cpu_time to cputime.

Kepler Variables

A selection of KEPLER variables can also be used, including p and q parameters (by name or number), and user-defined optional o parameters. Also allowed are any zonal variables accessible through loadbuf where zone number or mass coordinate can be used similar to the z interactive command.

This includes a small set of KEPLER physical and mathematical constants, pie, c, k, me, a, sigt, gee, n0, solmass, solrad, year, and rgas.

One can also use a small selection of array functions named after the FORTRAN functions on loadbuf quantities and specify ranges using the : (colon) syntax where omitted first and last indices stand for 1 and jm (q 2) respectively.

function

type

description

sum

float

sum up values

maxval

float

maximum value

minval

float

minimum value

maxloc

integer

index of maximum

minloc

integer

index of minimum

To obtain location of variable values in loadbuf arrays, the following functions can be used. You may use , or ; to separate arguments, or omit brackets where the expression remains unique, but you must retain “,” or “;”.

function

type

description

locl

integer

lower zone number

loc

integer

closest zone number

loch

integer

higher zone number

locx

float

linear interpolated floating zone number

mocl

integer

lower zone number (test outside-in)

moc

integer

closest zone number (test outside-in)

moch

integer

higher zone number (test outside-in)

mocx

float

linear interpolated floating zone number (test outside-in)

@ loc(rn,1.d12) > 1000
@ loc rn(:1200),1.d12  > 1000

Changed In Version 17.11.7: Added “;” as allowed separator. Allow range specification. Require separator. Add “m” functions.

To test where condition is fulfilled anywhere for loadbuf arrays, the following functions can be used. You may omit brackets for call syntax where the expression remains unique. You can use the FORTRAN operators <, <=, ==, =, >=, >, /=, and !=.

function

type

description

any

logical

condition fulfilled for any array value

all

logical

condition fulfilled for all array values

@ all(rn < 1.d12)
@ any convect == 4

New In Version 17.11.7.

Changed In Version 18.7.2: Added = and !=.

Note

Dissection of the expression fails with variable names that contain operators, e.g., for some reaction rates. In this case, square brackets, [ and ] can be used to keep these together.

@ [o16+o16](1) > 1.d10
d #oign

Changed In Version 17.0.13.

Examples

% debug
:
o i 1 def
: (dn(.0) > 0. | (dn(i+1) < 1.e+10))
z dn 1
o i 1 +
p { i + 1 } {p i} +
c {abs (- i)}
c {10.^3}
>xxx
o i del
*
~
<xxx
p 1
d {nameprob}#{i}
% debug
p vinstopm 2.
@ zm(minloc(un(:vinstopm))) < 3.d33
d {nameprob}#mysn
% end

Warning

Currently, when a command like end that terminates KEPLER is executed, the modified command file is not saved back to disk before the program ends. The file is only written back when command execution comes to a normal end. Instead, use the % end macro as in example above.

* [ NAME ]

Alternate entry point.

Command file execution is also started/tested at these points. Named entry points are only executed using the cmd_call subroutine (currently used for all standard aliases), or can be accessed using the ! command

*
* bounce

Changed In Version 17.0.2: added NAME option

Changed In Version 17.3.1: called for standard aliases.

link

Include other files.

name

parameters

link

FILENAME

link sollo03g
FILENAME

name of file to include.

Commands from include file are inserted and executed literally.

Note

Include files can be nested (include files may contain further include files), however, the maximum nesting level is nine (9).

Note

This is different from the link command as it needs to process the generator commands and set flags for generation of the star. Files linked using the link command must not contain generator cards.

New In Version >15.0.0.

Changed In Version 17.0.2: The name of the card used to be “include” but has been renamed to reflect that it has a evry similar functunallity as the input card with the same name.

Original entry:

Optional Cards

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

Original entry:

Normal Program Managment Commands

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

Original entry:

Other Terminal Edit Commands

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}).

Original entry:

Other ASCII Output-File Edit Commands

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>.

Original entry:

Other ASCII Output-File Edit Commands

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>.

Original entry:

Other ASCII Output-File Edit Commands

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

Original entry:

Other ASCII Output-File Edit Commands

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.

Original entry:

Other ASCII Output-File Edit Commands

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.

Original entry:

Graphics Edit Commands

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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

Original entry:

Abundance and Production Factor Plots

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.

Original entry:

Abundance and Production Factor Plots

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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).

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

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.

Original entry:

Special Purpose Commands

pst

Piston Cards.

name

parameters

pst

( TIME INNER-RADIUS ) | clear

pst clear
pst 0.     1.0072e+7
pst 1.e+10 1.0072e+7

Note

At least two required if any are specified.

INNER-RADIUS

radius of the inner boundary of the problem (cm)

TIME

time of piston location (unit:sec)

clear

reset piston data and disable piston

A series of such cards with monotonically increasing values of TIME are used to build up a discrete time history of the inner problem boundary, which the code uses to get intermediate values by interpolation. If the INNER-RADIUS given is 0., this serves as a flag for the code to reset its value to RADIUS0, so that a higher precision value can given. This is sometimes useful in treating compact configurations such as surface layers on neutron stars. The range of times covered must exceed the range of times for which the problem is to be run and at least two piston cards must be specified.

Currently, a maximum of npistz = 300 pst cards are allowed. npistz is a FORTRAN parameter set in kepcom.

Changed In Version 16.85.0: Piston is handled in ttycom.

Changed In Version 17.0.2: Added clear option.

Note

It used to be the case that:

The code does not remember data from 'PST' cards in any
previously read |LINK| decks, but does remember this current
'PST' data in restart dumps.

Now all use pst clear to reset piston, otherwise it is always stored.

Original entry:

Link Input Cards

cut

Cut out the inner ZONE zones.

name

parameters

cut

ZONE

cut 1.5
cut 12

ZONE

Upper zone (inclusive) which is to be removed. Processing of zone specification is done similar to the <j> command.

radius0 (p 60) and summ0 (p 61) are updated accordingly.

Changed In Version 16.85.0: moved from link to ttycom

Changed In Version 17.0.2: Added general evaluation of zone specification.

Original entry:

Link Input Cards

bounce

Generate piston (pst cards) from analytic formula.

name

parameters

bounce

XCUT TMIN RMIN RMAX ALPHA [ cut] [ scut ] [ accel ]

XCUT

Zone for piston. Processing of the zone specifications is done the same way as for the <j> command.

If XCUT is a floating point number, however, it is interpreted as the Y_\mathrm{e} value where to locate the piston.

TMIN

Time for infall (sec) or acceleration multiplier if accel is specified.

RMIN

maximum position of piston (cm)

RMAX

maximum (terminal) position of piston (cm)

ALPHA

multiplier on free fall acceleration for outward movement of piston

cut

The innermost XCUT zones are cut away (see cut command).

scut

Interprete XCUT as the entropy (kb/baryon) value where to locate the piston.

accel

TMIN is interpreted as the acceleration for the piston infall instead. The time of bounce then depends on the structure of the star. A typical value for TMIN in this case may eb around 0.25 (Thomas Janka, prov. com.).

This card generates a piston that moves inward from the outer boundary radius of zone XCUT to the radius RMIN (cm) in a time TMIN (sec). The radius as a function of time is fit by a parabola with the initial slope being the velocity at the outer boundary of zone XCUT. After TMIN the piston moves outwards with the (negated) free fall velocity from a point at radius RMAX (cm) in a gravitational field that is ALPHA times that of the mass enclosed by the outer boundary of zone XCUT. When the maximum position of the piston is reached, the movement of the piston is stopped.

If the piston is generated successfully, tshock (p 343) is set accordingly. This is particularly useful if the accel option is used

New In Version >15.0.0.

Changed In Version 17.0.2: Generalized treatment of zone specification was added.

Original entry:

Link Input Cards

ye

Y_{\mathrm{e}} cards for ISE initialization.

name

parameters

ye

( ARBITRARY INTERIOR-MASS YEQ0 ) | clear

ye clear
ye 1 0. 0.48
ye 2 2. 0.50

Note

At least two are required if any are given.

ARBITRARY

arbitrary, but required, value that is generally used to number the ye card

INTERIOR-MASS

interior mass coordinate (Msun) for this Y_\mathrm{e} point

YEQ0

value of Y_\mathrm{e} to be used to initialize new ISE zones at this mass coordinate (mol/g)

clear

reset Y_\mathrm{e} initialization data and disable initialization

A series of such cards with monotonically increasing values of INTERIOR-MASS are used to build up a discrete representation of the post-oxygen burning Ye profile, which the code uses to get intennediate values by linear interpolation (see subroutine sdot). Out of the range of mass coordinates specified by such a set of ye cards, the code uses the minimum of the current (APPROX-generated) value of Y_\mathrm{e} and yemax (p 323)) in order to initialize a new ISE zone.

Changed In Version 16.85.0: ye is handled in ttycom.

Changed In Version 17.0.2: Fixed initialization and added clear option.

Note

It used to be the case that:

The code does not remember data from "ye" cards in any
previously read |LINK| decks, but does remember this current
"ye" data in restart dumps.

Now use ye clear to reset Y_\mathrm{e} initialization, otherwise it is always stored.

Original entry:

Link Input Cards

Deprececations:

Old Command Files

Note

Prior to version 17.00.02 the command file was based on a library that was developed for the STERN code. Only a limited set of cmd-files command was supported, including

All other commands are processed by ttycom as regular input.

Example:

@un(1)<=1.d+6
d xxx#infall
exit
*
@dn(1)>=1.d10
d xxx#d10
exit

All executed commands, including @ commands that match, are removed from the command file and the revised version is written back to disk. Entry points, (*) and section comments (;) remain unless they make empty sections.

New In Version >15.0.0.

Deprecated Since Version 17.0.2: Replaced with New Syntax


Version 17.0.1

Add co-rotation for binary WD setups.

Additions:

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

Original entry:

Other Terminal Edit Commands

taucorot

Time scale on which co-rotation is established.

name

number

type

default

unit

taucorot

555

float

0.

sec

See ymcorot (p 431), awcorotx (p 581), awcoroty (p 582), and awcorotz (p 430) for details.

New In Version 17.0.1.

Original entry:

Rotation Parameters

Changes:

kaptab

Select opacity table.

name

number

type

default

unit

kaptab

377

integer

1

-

value

result

0

old

1

OPAL’96

2

OPAL’96 only in H-rich regions

3

Potekhin et al.~2006 (condall06, 10^{-6}<\rho<10^9)

4

Itoh et al. 2008 (10^0<\rho<10^{12.8})

The Tables 3 and 4 for are implemented by Laurens Keek for use in thick NS crust models.

Note

Itoh et al. 2008 is officially only valid for liquids (\Gamma<180), but Laurens removed the check for this. Otherwise you revert to the old opacities at the edges of your model, which is probably not any better.

Itoh maps isotopes onto 11 isotopes (heaviest is iron); Potekhin uses a mean ion approach.

New In Version 15.5.0.

Changed In Version 17.0.1: Added Options 3 and 4 (Keek)

Original entry:

Heat Diffusion Parameters

r3amult

Multiplier on triple-alpha reaction rate.

name

number

type

default

unit

r3amult

484

float

1.

-

Is used in both APPROX and BURN networks.

Special values:

value

result

-1.

use rate by Ogota, fit by Richard Cybert, added 20091006.

-2.

use rate by Nguyen et al. (2012) for T<10^8 K and CF88 for T>10^8 K, added 20130514 by Laurens Keek.

-3.

use rate by Fybno et al. (2005) for added 20140506 by Alexander Heger rate provided by Raphael Hirschi

New In Version 16.58.0.

Changed In Version 17.0.1: Added -2.

Changed In Version 17.0.10: Added -3.

Original entry:

Nuclear Reaction Parameters


Version 17.0.0

Add new version numbers with double “.”. These (nsetparm (p 66)) are now saved as integers. Add density factor for accretion. Add effetive diffusivities to dump file and adjust amout of data stored.

Additions:

accdnfac

Density of newly accreted zone relative to outermost zone.

name

number

type

default

unit

accdnfac

554

float

0.5

-

New In Version 17.0.0.

Original entry:

Accretion Parameters

Changes:

Getting an Account

We will need the IP address of the machine from which you connect to the server and a ssh public key secured by passphrase.

To make that ssh key, if you do not yet have one already, use

ssh-keygen -a 256 -t ed25519

which, however, may overwrite any existing id_ed25519 keys, though it will ask you whether you do want to overwrite it or not. So, no worries here if you are careful and read the screen output.

Note

If and only if you already have a ed25519 key and would like to create a new one for access to this git server, you could name it, e.g., id_git_star and use instead

ssh-keygen -a 256 -t ed25519 -f ~/.ssh/id_git_star

to create a new key named id_git_star. At the time of this writing, you may, however, yet be unlikely to already have a ed25519 key. In the section below you would the use

ssh-add id_git_star

instead of the line

ssh-add

I also ask you to use a secure passphrase to secure your key. If I can crack it, it will be rejected or deleted at a later time.

When you have a key, send it (the file ~/.ssh/id_ed25519.pub or ~/.ssh/id_git_star.pub) along with the IP address of the machine from which you will access the repository.

Note

A static IP address is needed and easiest. If you do not have a static IP address, we can still try with a dynamic host name as you would get from DynDNS or NoIp. But either fixed IP or host name are needed. Please do send these along.

If you have ssh access to a computer with a static IP address, you can use that as a proxy to connect to the server. Please provide the IP address of that server then.

Changed In Version 17.0.0.

Useful Input Cards

Note

The following cards are not specific to generators.

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.

Main entry:

Normal Program Managment Commands

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

Main entry:

Normal Program Managment Commands

Note

All forms of the p card are allowed in generators, however, only setting values has any useful impact.

Changed In Version 17.0.0: generator p cards used to allow only setting parameters and only allowed to specify parameters by number.; now any form of the p card is allowed in generators (as they are processed by the same routine as other input).

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

Main entry:

Special Purpose Commands

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.

Main entry:

Special Purpose Commands

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.

Main entry:

Other ASCII Output-File Edit Commands

/

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.

Main entry:

Special Purpose Commands

KEPLER Generator Restrictions

Note

The values below are historic values; current values may differ.

Restrictions corresponding to current FORTRAN parameter settings in include-file kepcom and subroutine gener are listed below. These may be changed by editing and recompiling KEPLER.

nniz

Maximum Number of Networks = 5. (But see discussion in net card definition.)

nhiz

Maximum Number of Ion Types per Network = 20.

nmiz

Maximum Number of Material Mixtures = 10.

nimz

Maximum Number of Ion Types per Mixture = 20.

nitz

Maximum Number of Ion Types Overall = 100.

ndatqz

Maximum Number of dump cards = 250.

nzedz

Maximum Number of zedit cards = 30.

jmz

Maximum Number of Zones = 650.

Useful Input Cards

Note

The following cards are not specific to generators.

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.

Main entry:

Normal Program Managment Commands

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

Main entry:

Normal Program Managment Commands

Note

All forms of the p card are allowed in generators, however, only setting values has any useful impact.

Changed In Version 17.0.0: generator p cards used to allow only setting parameters and only allowed to specify parameters by number.; now any form of the p card is allowed in generators (as they are processed by the same routine as other input).

See also

p command

BURN Generator Restrictions

Note

The values below are historic values; current values may differ.

Restrictions corresponding to current FORTRAN parameter settings in include-file burncom and subroutine genburn are listed below. These may be changed by editing and recompiling KEPLER.

nnizb

Maximum Number of BURN Networks = 1. (But see net discussion).

nhizb

Maximum Number of Isotope Types per BURN Network = 300, if nburn is changed. (Unclear what this if clause means)

nburn

‘Actual’ Number of Isotopes in the BURN Network = 150. Usually this should be identical to nhizb.

nmizb

Maximum Number of BURN Material Mixtures = 2.

nimzb

Maximum Number of BURN Isotope Types per Mixture = 150.

nitzb

Maximum Number of BURN Isotope Types Overall = 200.

jmzb

Maximum Number of BURN Zones = jmz.

nsetparm

Initialize new parameters in subroutine restart and re-arrange/add/remove/initialize internal arrays and edit quantities if nsetparm (p 66) \le current version.

name

number

type

default

unit

nsetparm

66

integer

170001

-

nsetparm (p 66) is then set to the current value after all updates have been made.

Changed In Version 17.0.0: Now an integer variable with 10000 times major version. There was never any need for this to be a float.

Changed In Version 15.0.0: .. note:: It is no longer possible to write out older versions KEPLER data format. This is because some internal data arrays are re-arranged on loading by restart

Warning

Do not change manually unless you really know what you do and only after checking restart carefully.

Note

p 66 used to be a float value. The old documentation read:

"xk" represents a floating point number used in subroutine
"restart" as an index for the version of KEPLER is which the
last set new parameters has been introduced.  After such a
new parameter update is made "SETPARM" is reset to "xk"+l.
This allows restart dumps written by older versions of KEPLER
with fewer parameters to be used by any later version of the
code.

Original entry:

Miscellaneous Parameters


Version 16.99.0

Add new model for magnetic field based on shear. Used, e.g., for WD mergers.

Additions:

xmagfbr

Strength of equipartition radial magnetic field used for simple dynamo with magnet (p 423) = 8.

name

number

type

default

unit

xmagfbr

552

float

0.0001

-

New In Version 16.99.0.

Original entry:

Magnetic Fields

xmagfbt

Strength of equipartition toroidal magnetic field used for simple dynamo with magnet (p 423) = 8.

name

number

type

default

unit

xmagfbt

553

float

0.01

-

New In Version 16.99.0.

Original entry:

Magnetic Fields

Changes:

magnet

Switch to enable magnetic fields according to [Spr02].

name

number

type

default

unit

magnet

423

integer

0

-

value

result

0

off

1

in semiconvective regions only the N^2_\mu limiting case of Spruit’s description is considered.

2

in semiconvective regions the geometric mean between the N^2_\mu limiting case and Schwarzschild convection is assumed. Recommended by Spruit.

3

N^2_\mu is multiplied by 0.1.

4

an old buggy case is reproduced in which \eta_1 does not include the second term in the max statement of equation (36) of [Spr02]

5

an old buggy case is reproduced in which q_1 is missing a factor \left(\Omega/N_{T}\right)^{1/4}.

8

use a simple equipartition model using xmagfbr (p 552) and xmagfbt (p 553). (Woosley & Heger, 2013, in prep. ?)

New In Version 16.11.0.

Changed In Version 16.99.0: Added Case 8.

Note

A description of Case 8-physics would be nice.

Original entry:

Magnetic Fields


Version 16.98.0

Add proper (intrinsically condervative) model for viscous heating. Add record of it to dump file.

Additions:

sv

Shear viscous heating rate.

name

type

unit

centering

storage

sv

float

erg/g/sec

center

dump

New In Version 16.98.0.

Original entry:

Saved Zonal BURN Co-Processor Arrays

nangdis

Rotational energy source from dissipation.

name

number

type

default

unit

nangdis

551

integer

0

-

Mostly, this releases energy due to dissipation. But transport in general could also lead to energy “cost”. This should be used in combination with mixcycl (p 433) \ge 1 only.

For cases of mixcycl (p 433) = 0: a value of 1 will try to conserve energy, a value of 2 will keep the specific rate constant during the iteration, violating energy conservation.

New In Version 16.98.0.

Original entry:

Rotation Parameters

env

Total viscous energy dissipated.

name

number

type

unit

env

139

float

erg

New In Version 16.98.0.

Original entry:

Viscous Energy Deposition

envd

Viscous energy dissipation rate in last time step.

name

number

type

unit

envd

140

float

erg/sec

New In Version 16.98.0.

Original entry:

Viscous Energy Deposition

envc

Total viscous energy dissipation check.

name

number

type

unit

envc

141

float

erg

New In Version 16.98.0.

Original entry:

Viscous Energy Deposition

envcd

Viscous energy dissipation rate check in last time step.

name

number

type

unit

envcd

142

float

erg/sec

New In Version 16.98.0.

Original entry:

Viscous Energy Deposition


Version 16.97.0

Add factors for accretion rate and luminosity to model redshift variations from observational data.


Version 16.96.0

Add record of accretion/decretion.

Additions:

accratef

Multiplier on accretion rate from time-dependent input file.

name

number

type

default

unit

accratef

550

float

1.

-

For use with GR corrections in XRB problems.

New In Version 16.96.0.

Original entry:

Accretion Parameters

dvacc

Volume change due to mass accretion.

name

number

type

unit

dvacc

137

float

cc

New In Version 16.96.0.

Original entry:

Accretion-Related Parameters

dvloss

Volume change due to mass loss.

name

number

type

unit

dvloss

136

float

cc

New In Version 16.96.0.

Original entry:

Decretion-Related Parameters

dvdev

Volume change due to mass decretion (from bottom).

name

number

type

unit

dvdev

138

float

cc

New In Version 16.96.0.

Original entry:

Decretion-Related Parameters


Version 16.95.0

Add entropy output file.

Additions:

nentout

Frequency to write out *.ent file.

name

number

type

default

unit

nentout

546

integer

0

-

Values less than 1 disable output.

New In Version 16.95.0.

Original entry:

Entropy Files

nentlev

Number of levels to write out in *.ent file.

name

number

type

default

unit

nentlev

547

integer

0

-

value

result

<0

write out the entire star.

0

write out only central values

>0

number of levels to write out.

See nentout (p 546).

New In Version 16.95.0.

Original entry:

Entropy Files

entdm

Mass of level interval to write out into *.ent file.

name

number

type

default

unit

entdm

548

float

0.5

Msun

value

result

<0

write out relative mass coordinate (normalized to 1.

0

write out every zone.

>0

zone mass of levels to write out.

New In Version 16.95.0.

Original entry:

Entropy Files


Version 16.94.0

Add record of advection “luminosity.”

Additions:

xladv

Current advection luminosity.

name

number

type

unit

xladv

135

float

erg/sec

New In Version 16.94.0.

Original entry:

Accretion-Related Parameters


Version 16.93.0

Add extra dumps in hydrogen burning. Relocate BURN data to end of dump file.

Additions:

hm2

execued when central h1 burnt exceeds h1hm2 (p 543) relative to the initial value set by KEPLER in h1init (q 101).

Set h1hm2 (p 543) to a value larger than 1. to disable.

Writes #hm2 dump.

New In Version 16.93.0.

hm5

execued when central h1 burnt exceeds h1hm5 (p 544) relative to the initial value set by KEPLER in h1init (q 101).

Set h1hm5 (p 544) to a value larger than 1. to disable.

Writes #hm5 dump.

New In Version 16.93.0.

hm10

execued when central h1 burnt exceeds h1hm10 (p 545) relative to the initial value set by KEPLER in h1init (q 101).

Set h1hm10 (p 545) to a value larger than 1. to disable.

Writes #hm10 dump.

New In Version 16.93.0.

h1hm2

Mass fraction of h1 burnt to write out the #hm2 dump.

name

number

type

default

unit

h1hm2

543

float

0.02

-

KEPLER sets h1init (q 101) to the initial value found at the end of the first time step at the center and computes the burnt hydrogen mass fraction relative to that.

New In Version 16.93.0.

Original entry:

Special Command Execution And Dump Parameters

h1hm5

Mass fraction of h1 burnt to write out the #hm5 dump.

name

number

type

default

unit

h1hm5

544

float

0.05

-

KEPLER sets h1init (q 101) to the initial value found at the end of the first time step at the center and computes the burnt hydrogen mass fraction relative to that.

New In Version 16.93.0.

Original entry:

Special Command Execution And Dump Parameters

h1hm10

Mass fraction of h1 burnt to write out the #hm10 dump.

name

number

type

default

unit

h1hm10

545

float

0.1

-

KEPLER sets h1init (q 101) to the initial value found at the end of the first time step at the center and computes the burnt hydrogen mass fraction relative to that.

New In Version 16.93.0.

Original entry:

Special Command Execution And Dump Parameters


Version 16.92.0

Record inital values of $^{4}\mathrm{He}$ and metallicity.

Additions:

he4init

Initial He4.

name

number

type

unit

he4init

133

float

-

New In Version 16.92.0.

Original entry:

Initial Composition Parameters


Version 16.91.0

Add option to chnage overwrite behavior of bdat and built-in rates.

Additions:

ibdatov

Overwriting of hard-coded and bdat rates.

name

number

type

default

unit

ibdatov

542

integer

0

-

value

result

-1

all bdat rates will be overwritten if hard-coded rates exist

0

only rates 21 and 22 will be overwritten.

1

bdat rates to overwrite any specl\*.f rates

New In Version 16.91.0.

Original entry:

BURN Physics Parameters


Version 16.90.0

Add new neutrino interactions for nucleosynthesis (Projjwal Bandergee).

Additions:

ihe4cc

Switch on charged current neutrino reactions on he4 if set to 1.

name

number

type

default

unit

ihe4cc

539

integer

1

-

This reaction was added to KEPLER on 20110317 thanks ot Projjwal Banerjee.

New In Version 16.90.0.

Original entry:

BURN Physics Parameters

inuenc

Switch on neutral current due to electron neutrinos if set to 1.

name

number

type

default

unit

inuenc

540

integer

1

-

This reaction was added to KEPLER on 20110317 to allow for hard electron neutrinos due to oscillations, thanks ot Projjwal Banerjee.

New In Version 16.90.0.

Original entry:

BURN Physics Parameters

inuebnc

Switch on neutral current due to electron anti-neutrinos if set to 1.

name

number

type

default

unit

inuebnc

541

integer

1

-

This reaction was added to KEPLER on 20110317 to allow for hard electron neutrinos due to oscillations, thanks to Projjwal Banerjee.

New In Version 16.90.0.

Original entry:

BURN Physics Parameters


Version 16.89.0

Add output of SE file link for NuGrid. Verbosity of adapnet and tty.

Additions:

ittyv

Verbosity of tty output.

name

number

type

default

unit

ittyv

538

integer

1

-

Be quiet if set to 0.

New In Version 16.89.0.

Original entry:

General Edit Control Parameters

iadapv

Verbosity of adapent output.

name

number

type

default

unit

iadapv

537

integer

1

-

Be quiet if set to 0.

New In Version 16.89.0.

Original entry:

BURN Coprocessing Control Parameters

nsekout

Write out data file for NuGrid every nsekout (p 536) cycles.

name

number

type

default

unit

nsekout

536

integer

0

-

Usually should write out data every cycle.

New In Version 16.89.0.

Original entry:

Various Files


Version 16.88.0

Add factors for accretion and base luminosity time scale.

Additions:

acctimef

Multiply accretion time and time scale by this factor for accretion data from a file.

name

number

type

default

unit

acctimef

534

float

1.

-

This is to simulate redshift time delay.

New In Version 16.88.0.

Original entry:

Accretion Parameters

xl0timef

Multiply base luminosity time and time scale by this factor for accretion data from a file.

name

number

type

default

unit

xl0timef

535

float

1.

-

This is to simulate redshift time delay. Usually you would use this in combination with acctimef (p 534).

New In Version 16.88.0.

Original entry:

Accretion Parameters


Version 16.87.0

Add base luminosity file input and diganostic for current accretion rate.

Additions:

lumfile

Use nameprob.lum file for time-dependent base luminosity.

name

number

type

default

unit

lumfile

533

integer

0

-

The file contains a comment line with version information, then a line with the number of entries (I6), then the data in two columns: time in sec and base luminosity xlum0 (p 62) in erg/sec: (2E13.6).

New In Version 16.87.0.

Original entry:

Accretion Parameters

xmacrate

Accretion rate.

name

number

type

unit

xmacrate

132

float

g/sec

New In Version 16.87.0.

Original entry:

Accretion-Related Parameters

Changes:

accrate

Rate at which mass in the form of new zones is added to the surface of the star.

name

number

type

default

unit

accrate

211

float

0.

Msun/yr

The accumulated mass is stored in xmacrete (p 212) until it is large enough to be added as a whole zone. The surface boundary pressure is gradually increased at a rate proportional to accrate (p 211) until a mass (in xmacrete (p 212)) equal to that in the current outer zone is reached. Then a new zone, the mirror image of the old outer zone, is added. Accretion composition is set by the compsurf command in ttycom. The boundary pressure from the accretion phantom is stored in pboundac (q 96).

Note

This prescription will work best for coarse and roughly equal surface zoning.

Negative accretion rate means to reads in time-dependent accretion rate data from file nameprob.acc. The file contains a comment line with version information, then a line with the number of entries ((I6)), then the data in two columns: time in seconds and accretion rate in grams per second. Format: (2E25.17). The resulting rate is multiplied by -accrate (p 211) to allow scaling without having to change the file. See also: accratef (p 550) which seesm to duplicate the scaling functionallity.

Changed In Version 16.47.0: The boundary pressure from the accretion phantom zone is no longer added to pbound (p 69). It goes into pboundac (q 96) instead.

Changed In Version 16.87.0: negative values makes it read timedependent data from from file

Original entry:

Accretion Parameters


Version 16.86.0

Add decretion zone location

Additions:

jmdec

Zone from which to remove mass in decretion.

name

number

type

default

unit

jmdec

532

integer

1

-

New In Version 16.86.0.

Original entry:

Decretion Parameters


Version 16.85.0

Major changes. Add log file and UUIDs. Add decretion and diagnostics. Minumum mass coordinates fir|APPROX| and neutrino energy losses. Extra switches for nuclear buneing and neutrino losses.

Additions:

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.

Original entry:

Other Terminal Edit Commands

resetdec

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

name

parameters

resetdec

New In Version 16.85.0.

Original entry:

Special Purpose Commands

ipnuc

Do nuclear burning/energy generation.

name

number

type

default

unit

ipnuc

525

integer

1

-

Same use of jshell0 (p 93) and jshell1 (p 94) as ipup (p 28).

New In Version 16.85.0.

Changed In Version 18.11.4: add bmasslow (p 419)

Original entry:

Nuclear Reaction Parameters

ipnu

Do neutrino losses.

name

number

type

default

unit

ipnu

526

integer

1

-

Same use of jshell0 (p 93) and jshell1 (p 94) as ipup (p 28).

New In Version 16.85.0.

Changed In Version 18.11.4: add bmasslow (p 419)

Original entry:

Nuclear Reaction Parameters

idecmode

Mode for “decretion” model.

name

number

type

default

unit

idecmode

529

integer

1

-

value

result

0

No decretion

1

decreted mass is added to decmass (q 130)

else

decreted mass is added to summ0 (p 61)

The decreted mass will always also be added to xmdec (q 129).

New In Version 16.85.0.

Original entry:

Decretion Parameters

decrate

Rate of mass decretion from inner zone.

name

number

type

default

unit

decrate

530

float

0.

-

Use accretion rate if set to a negative value.

New In Version 16.85.0.

Original entry:

Decretion Parameters

fracdec

Fraction of mass of inner zone for dezoning if in decretion mode.

name

number

type

default

unit

fracdec

531

float

1.

-

New In Version 16.85.0.

Original entry:

Decretion Parameters

amasslow

Minimum mass coordinate for APPROX network.

name

number

type

default

unit

amasslow

527

float

-1.e+99

-

Similar to bmasslow (p 419).

New In Version 16.85.0.

Original entry:

Physics Parameters

umasslow

Minimum mass for neutrino losses.

name

number

type

default

unit

umasslow

528

float

-1.e+99

-

Similar to bmasslow (p 419).

New In Version 16.85.0.

Original entry:

Physics Parameters

nlogout

Output log file if set to 1.

name

number

type

default

unit

nlogout

524

integer

1

-

Writing out log files less often the every step does not make sense.

New In Version 16.85.0.

Original entry:

Various Files

xmdec

Total mass removed from bottom.

name

number

type

unit

xmdec

129

float

g

New In Version 16.85.0.

Original entry:

Decretion-Related Parameters

decmass

Total mass removed from bottom and not added to substrate.

name

number

type

unit

decmass

130

float

g

New In Version 16.85.0.

Original entry:

Decretion-Related Parameters

dmdec

Mass removed in last time step.

name

number

type

unit

dmdec

131

float

g

New In Version 16.85.0.

Original entry:

Decretion-Related Parameters

Changes:

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.