Parameters by Function

Time and Status Parameters

time

Initial or current time.

name

number

type

default

unit

time

2

float

0.

sec

toffset

Cumulative amount of time by which the problem time has been offset by zerotime commands.

name

number

type

default

unit

toffset

315

float

0.

sec

In other words, toffset (p 315) should be added to the current problem time to get the actual time since the beginning of the problem. Normally, toffset (p 315) is reset internally when the zerotime command is issued and should not be reset by the user.

New In Version 6.0.0.

niterbar

Total number of cycles used to compute iterbar, the average number of iterations per cycle. (Internally set.).

name

number

type

default

unit

niterbar

157

integer

1

-

Parameter-Change Parameters

timezms

Time at which to make the zero-age-main-sequence (ZAMS) parameter changes and restart dump (typically 1.e+12).

name

number

type

default

unit

timezms

308

float

1.e+99

sec

Restart dump #zams is written out.

Todo

TODO: KEPLER should be changed to also execute an alias at this point instead of parameter-based settings. The alias for that is already defined.

Note

In fact, all aliases should be implemented using command files instead.

New In Version 5.0.0.

Other entry:

Restart-Dump Control Parameters

izonezms

Reset the value of izonef (p 86) to izonezms (p 309) at the time specified by timezms (p 308).

name

number

type

default

unit

izonezms

309

integer

1

-

New In Version 5.0.0.

Other entry:

General Rezoning Parameters

q1faczms

Reset the value of q1fac (p 13) to q1faczms (p 310) at the time specified by timezms (p 308).

name

number

type

default

unit

q1faczms

310

float

0.1

-

New In Version 5.0.0.

Other entry:

Artificial Viscosity Parameters

tempcig

Central temperature at which to make the pre-carbon-ignition parameter changes and restart dump (typically 5.e+8).

name

number

type

default

unit

tempcig

311

float

1.e+99

K

New In Version 5.0.0.

Other entry:

Restart-Dump Control Parameters

yflrxcig

Reset the value of yfloorx (p 47) to yflrxcig (p 312) when the central temperature specified by tempcig (p 311) is reached.

name

number

type

default

unit

yflrxcig

312

float

0.003

-

New In Version 5.0.0.

Other entry:

Timestep Control Parameters

fmaxmcig

Reset the value of fmaxm (p 195) to fmaxmcig (p 313) when the central temperature specified by tempcig (p 311) is reached if fmaxmcig (p 313) > 0.

name

number

type

default

unit

fmaxmcig

313

float

1.

-

New In Version 5.0.0.

Changed In Version >15.15.0: Only reset if fmaxmcig (p 313) > 0.

Other entry:

Mass-Fraction-Based Rezoning Parameters

fmax0cig

Reset the value of fmax0 (p 150) to fmax0cig (p 314) when the central temperature specified by tempcig (p 311) is reached if fmax0cig (p 314) > 0.

name

number

type

default

unit

fmax0cig

314

float

1.

-

New In Version 5.0.0.

Changed In Version >15.15.0: Only reset if fmaxmcig (p 313) > 0.

Other entry:

Mass-Fraction-Based Rezoning Parameters

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.

Problem Termination Parameters

nstop

Maximum number of cycles.

name

number

type

default

unit

nstop

14

integer

100000

-

tstop

Stop time.

name

number

type

default

unit

tstop

15

float

1.e+30

sec

iterbarm

Maximum allowed value of niterbar without terminating the problem.

name

number

type

default

unit

iterbarm

158

integer

100

-

tempstop

Terminate the problem when the central temperature reaches TEMPSTOP.

name

number

type

default

unit

tempstop

304

float

1.e+99

K

New In Version 3.0.0.

denstop

Terminate the problem when the central density reaches denstop (p 305).

name

number

type

default

unit

denstop

305

float

1.e+99

g/cc

New In Version 3.0.0.

vinstop

Terminate the problem when the infall velocity below vinstopm (p 462) exceeds vinstop (p 306).

name

number

type

default

unit

vinstop

306

float

1.e+99

cm/sec

Note that positive values of vinstop (p 306) correspond to negative (in-falling) velocities.

New In Version 3.0.0.

Changed In Version 16.40.0: Added vinstopm (p 462).

vinstopm

name

number

type

default

unit

vinstopm

462

float

1.e+99

-

Upper mass limit for which infall velocity is checked against vinstop (p 306) to determine whether #presn has been reached. :unit: g

New In Version 16.40.0.

o16stop

Terminate the problem when the o16 mass-fraction drops below o16stop (p 307) provided the central temperature exceeds tqselim (p 184).

name

number

type

default

unit

o16stop

307

float

-1.

-

Basically this corresponds to a time near the end of core oxygen burning for values of o16stop (p 307) about 0.05.

New In Version 3.0.0.

Special Command Execution And Dump Parameters

tempcdep

If the central temperature is \ge tempcdep (p 331), then make a restart dump labeled #cdep, execute the alias-defined cdep command, and reset tempcdep (p 331) to 1.e+99.

name

number

type

default

unit

tempcdep

331

float

1.e+99

K

Normally, this parameter is used to reset certain parameter values following carbon depletion.

New In Version 11.0.0.

o16odep

If the central oxygen abundance is \ge o16odep (p 332) and the central temperature is \ge tqselim (p 184), then make a restart dump labelled #odep, execute the alias-defined odep command, and reset o16odep (p 332) to -1.e+99.

name

number

type

default

unit

o16odep

332

float

-1.e+99

-

Normally, this parameter is used to reset certain parameter values at oxygen depletion.

New In Version 11.0.0.

tempchar

If the central temperature is \ge tempchar (p 333), then make a restart dump labeled with #tn and the current cycle number, reset tempchar (p 333) to 1.e+99, and finally execute the alias-defined tnchar command.

name

number

type

default

unit

tempchar

333

float

1.e+99

K

Note that the user-defined tnchar command can change the value of tempchar (p 333) in such a way as to cause the tnchar command to be issued recursively, i.e., by using the p command in the form:

p n delta add

(see Input Cards).

New In Version 11.0.0.

Deprecated Since Version <15.0.0: Has not been used recently.

denchar

If the central density is \ge denchar (p 334), then make a restart dump labeled with #dn and the current cycle number, reset denchar (p 334) to 1.e+99, and finally execute the alias-defined dnchar command.

name

number

type

default

unit

denchar

334

float

1.e+99

g/cc

Note that the user-defined dnchar command can change the value of denchar (p 334) in such away as to cause the dnchar command to be issued recursively, i.e., by using the p command in the form:

p n delta add

(see Input Cards).

New In Version 11.0.0.

Deprecated Since Version <15.0.0: Has not been used recently.

abarchar

If the central mean atomic weight (abar) is \ge abarchar (p 335), then make a restart dump labelled with #ab and the current cycle number, reset abarchar (p 335) to 1.e+99, and finally execute the alias-defined abchar command.

name

number

type

default

unit

abarchar

335

float

1.e+99

-

Note that the user-defined abchar command can change the value of abarchar (p 335) in such a way as to cause the abchar command to be issued recursively, i.e., by using the p command in the form:

p n delta add

(see Input Cards).

New In Version 11.0.0.

Deprecated Since Version <15.0.0: Has not been used recently.

tshock

If the problem time is \ge tshock (p 343), then make a restart dump labelled #shock, reset tshock (p 343) to 1.e+99, and finally execute the alias-defined tshock command.

name

number

type

default

unit

tshock

343

float

1.e+99

sec

Normally, this command is used to reset certain parameter values and/or make edits at the time of the piston-induced bounce of the collapsing iron core that creates an out-going shock wave.

New In Version 13.0.0.

tnucleo

If the problem time is \ge tnucleo (p 344), then make a restart dump labelled #nucleo, reset tnucleo (p 344) to 1.e+99, and finally execute the alias-defined tnucleo command.

name

number

type

default

unit

tnucleo

344

float

1.e+99

-

Normally, this command is used to reset certain parameter values and/or make edits at a time just after explosive nucleosynthesis is complete.

New In Version 13.0.0.

tenvel

If the problem time is \ge tenvel (p 345), then make a restart dump labeled #envel , reset tenvel (p 345) to 1.e+99, and finally execute the alias-defined tenvel command.

name

number

type

default

unit

tenvel

345

float

1.e+99

-

Normally, this command is used to reset certain parameter values and/or make edits just before the supernova shock wave breaks through the surface of the pre-supernova star.

New In Version 13.0.0.

h1hdep

Central hydrogen abundance at which the #hdep dump is made.

name

number

type

default

unit

h1hdep

405

float

0.01

-

New In Version 15.25.0.

he4hedep

Central helium abundance at which the #hedep dump is made.

name

number

type

default

unit

he4hedep

406

float

0.01

-

New In Version 15.25.0.

h1hburn

Hydrogen mass fraction at which to make the #hburn dump.

name

number

type

default

unit

h1hburn

454

float

0.4

-

New In Version 16.36.0.

c12heign

Carbon mass fraction at which to make the #heign dump.

name

number

type

default

unit

c12heign

455

float

0.01

-

New In Version 16.36.0.

he4hebrn

Helium mass fraction at which to make the #heburn dump.

name

number

type

default

unit

he4hebrn

456

float

0.5

-

New In Version 16.36.0.

nzsave

Number of older z files to save.

name

number

type

default

unit

nzsave

488

integer

0

-

They are named *z1, *z2, …

New In Version 16.63.0.

h1hign

Mass fraction of h1 burnt to write out the #hign dump.

name

number

type

default

unit

h1hign

495

float

0.01

-

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

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.

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.

Other Execution Control Parameters

iautoout

Autumated ASCII and graphical output.

name

number

type

default

unit

iautoout

159

integer

0

-

value

result

> 1

send out two copies of the ASCII output BURN

> 2

Also send out two copies of the graphics output

Note: No output files are destroyed.

Warning

CRAY only!

This is an obsolescent parameter that should not be used on UNIX machines without recasting.

fraccore

The effective number of zones used in regess (jmcalc (p 162)) shall be the minimum needed to contain the inner fraccore (p 161) mass-fraction of the initial mass of the star.

name

number

type

default

unit

fraccore

161

float

1.1

-

jmcalc

Effective number of zones used in subroutine regess.

name

number

type

default

unit

jmcalc

162

integer

jm

-

jmcalc (p 162) is internally calculated from fraccore (p 161) and should not be changed.

jpause

Pause the code at the end of the calculation for zone j = jpause (p 192) in regess (“pause 1”) and in update (“pause 2”). Do not pause if jpause (p 192) < 0. Type a carriage return to continue.

name

number

type

default

unit

jpause

192

integer

-1

-

General Edit Control Parameters

nedit

Number of cycles between ASCII edits.

name

number

type

default

unit

nedit

16

integer

20

-

dtedit

Time between ASCII edits (0. = \infty).

name

number

type

default

unit

dtedit

17

float

0.

sec

npixedit

Graphics edits to the monitor are made every npixedit (p 64) KEPLER cycles (if itvstart (p 127) > 0).

name

number

type

default

unit

npixedit

64

integer

50

-

Main entry:

Device-Control Graphics Parameters

abunlim

Least elemental mass fraction plotted or listed in a terminal ion edit.

name

number

type

default

unit

abunlim

128

float

0.001

-

Other entry:

Velocity And Abundance Graph Parameters

nnewoutf

Start a new labelled ASCII output file every nnewoutf (p 197) cycles.

name

number

type

default

unit

nnewoutf

197

integer

2000

-

Changed In Version 2.0.0: Value is set to 2000 when switching from version < 3

npage

Number of lines printed per “page” of ASCII output.

name

number

type

default

unit

npage

268

integer

53

-

The value 53 causes zone lists to be printed in 50-zone blocks.

scalem

Mass unit used for the mass coordinate employed in making ASCII and terminal edits.

name

number

type

default

unit

scalem

273

float

1.9892e+33

g

neditz1

Make an ascii edit of primary zonal quantities every neditz1 (p 274) \times nedit (p 16) cycles.

name

number

type

default

unit

neditz1

274

integer

10

-

neditz2

Make an ascii edit of secondary zonal quantities every neditz2 (p 275) \times nedit (p 16) cycles.

name

number

type

default

unit

neditz2

275

integer

20

-

nedita

Make an elemental abundance edit every nedita (p 243) \times nedit (p 16) cycles.

name

number

type

default

unit

nedita

243

integer

10

-

neditp

Make an ascii edit of all changeable parameters every neditp (p 278) \times nedit (p 16) cycles.

name

number

type

default

unit

neditp

278

integer

50

-

medit

Flag determining the minimum amount of information printed in an ASCII cycle edit regardless of the settings of other edit parameters:.

name

number

type

default

unit

medit

276

integer

0

-

value

result

\le 0

minimum is a 1 page “short” edit

\ge 1

minimum includes a primary zonal edit

\ge 2

minimum includes a secondary zonal edit

\ge 3

minimum includes an ion abundance edit

\ge 4

minimum includes an ISE abundance edit

\ge 5

minimum includes a BURN isotope edit

\ge 6

minimum includes a BURN isotope edit for all

\ge 7

minimum includes a parameter edit.

meditfin

Effective value of medit (p 276) used in determining the scope of the final edit made when the problem is finished.

name

number

type

default

unit

meditfin

277

integer

7

-

kapverb

Verbostiy of opacity subroutine. Zero gives no messages.

name

number

type

default

unit

kapverb

391

integer

0

-

New In Version 15.19.0.

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.

ISE Edit Parameters

njeditq

Make a ISE edit every njeditq (p 168) zones.

name

number

type

default

unit

njeditq

168

integer

5

-

neditq

Make a detailed edit of the ISE zones every neditq (p 180) general numerical edits.

name

number

type

default

unit

neditq

180

integer

20

-

xthres

Edit only those ISE isotopes with mass fractions exceeding xthres (p 183).

name

number

type

default

unit

xthres

183

float

0.0001

-

neditq1

Make an ISE edit for the central zone every neditq1 (p 198) \times nedit (p 16) cycles.

name

number

type

default

unit

neditq1

198

integer

5

-

New In Version 3.0.0.

Changed In Version 4.0.0: The value is reset to 5 is set when switching from version < 4

BURN Edit Parameters

neditb

Make a BURN isotopic abundance edit every neditb (p 241) \times nedit (p 16) KEPLER cycles.

name

number

type

default

unit

neditb

241

integer

5

-

jmeditb

Edit only zones whose zone number is \le jmeditb (p 244) during normal BURN isotopic abundance edits.

name

number

type

default

unit

jmeditb

244

integer

1

-

neditall

Make a BURN isotopic abundance edit for all zones every neditall (p 245) \times nedit (p 16) cycles regardless of the value of neditb (p 241).

name

number

type

default

unit

neditall

245

integer

100

-

abunlimb

Edit only those BURN isotope mass-fractions whose values exceed abunlimb (p 272) in making terminal edits (including isotopic mass-fraction sums over zones).

name

number

type

default

unit

abunlimb

272

float

1.e-5

-

ncomp

Make a complete ASCII edit of the nuclear processes in all zones considered by the BURN coprocessor every ncomp (p 250) cycles.

name

number

type

default

unit

ncomp

250

integer

999999

-

ncent

Make an ASCII edit of the nuclear processes in the central zone considered by the BURN coprocessor every ncent (p 251) cycles.

name

number

type

default

unit

ncent

251

integer

999999

-

nedt

Make an ASCII edit of the nuclear processes involved every nedt (p 252) BURN coprocessor matrix inversions (debugging only).

name

number

type

default

unit

nedt

252

integer

999999

-

si28dep

Central si28 mass fraction at which the #sidep dump is made, if the mass fractions of o16 and he4 are below 0.01.

name

number

type

default

unit

si28dep

420

float

0.0001

-

New In Version 16.5.0.

Restart-Dump Control Parameters

ndump

Number of cycles between restart dumps.

name

number

type

default

unit

ndump

18

integer

10

-

nsdump

Save every nsdump (p 156) restart dumps.

name

number

type

default

unit

nsdump

156

integer

10

-

nsavez

Total number of non-BURN zonal arrays to save in restart dumps.

name

number

type

default

unit

nsavez

269

integer

24

-

These arrays are listed in kepcoms, starting with ym and numbering nzonei + nzonec in total. nsavez (p 269) must be at least 14 and no greater than nzonei + nzonec. Saving more than the minimum number of arrays needed to restart the problem is often useful for edit purposes.

nsaveb

Total number of BURN zonal arrays to save in restart dumps.

name

number

type

default

unit

nsaveb

270

integer

10

-

These arrays are listed in kepcoms, starting with netnumb and numbering nzoneb in total. nsaveb (p 270) must be at least 6 and no greater than nzoneb. Saving more than the minimum number of arrays needed to restart the problem is often useful for edit purposes.

Note

You probably should leave this value alone.

tempcig

Central temperature at which to make the pre-carbon-ignition parameter changes and restart dump (typically 5.e+8).

name

number

type

default

unit

tempcig

311

float

1.e+99

K

New In Version 5.0.0.

Main entry:

Parameter-Change Parameters

timezms

Time at which to make the zero-age-main-sequence (ZAMS) parameter changes and restart dump (typically 1.e+12).

name

number

type

default

unit

timezms

308

float

1.e+99

sec

Restart dump #zams is written out.

Todo

TODO: KEPLER should be changed to also execute an alias at this point instead of parameter-based settings. The alias for that is already defined.

Note

In fact, all aliases should be implemented using command files instead.

New In Version 5.0.0.

Main entry:

Parameter-Change Parameters

Post-Processor-Dump Control Parameters

Deprecated Since Version <15.0.0: Post-processor no longer operational.

ncycqq

Number of KEPLER cycles between post-processor dump cycles, i.e., calls to dumpq.

name

number

type

default

unit

ncycqq

299

integer

5

-

lenqmax

Maximum length of a post-processor dump file.

name

number

type

default

unit

lenqmax

44

integer

3000000

bytes

niondump

Number of dump cycles between forced dumps of all dump-grid points of all ‘ions’ specified as dump variables.

name

number

type

default

unit

niondump

164

integer

40

-

nisodump

Number of dump cycles between forced dumps of all dump-grid points of all BURN ‘isotopes’ specified as dump variables.

name

number

type

default

unit

nisodump

165

integer

400

-

nzondump

Number of dump cycles between forced dumps of all dump-grid points of all arrays specified as dump variables except ‘ions’ and ‘isotopes’.

name

number

type

default

unit

nzondump

166

integer

40

-

dscalem

Mass units used for the internal mass coordinate, ymass, used for dumping purpos~s.

name

number

type

default

unit

dscalem

297

float

1.9892e+33

g

See subroutine dumpq.

ngridmin

Minimum number of points allowed in a dump grid.

name

number

type

default

unit

ngridmin

298

integer

10

-

See subroutine dumpq.

lentrack

Length of the track(s) assigned to each dump variable in the post-processor dump(s).

name

number

type

default

unit

lentrack

300

integer

16384

bytes

See subroutine dumpq.

backfacq

If the fractional change in a dump variable since the last dump cycle exceeds backfacq (p 303) \times ratzdump(IDAT), then also dump the old value of that variable at the previous (dump cycle) time point, where backfacq (p 303) \times ratzdump(idat) is the (previously specified) maximum allowed fractional change between dumps of this zonal dump variable (indexed by idat).

name

number

type

default

unit

backfacq

303

float

0.5

-

nfirstq

Default value of the first cycle to be read or plotted in making post-processor edits, time plots, or timemaps.

name

number

type

default

unit

nfirstq

346

integer

0

-

Note that this parameter is reset by the newdumps command to the current value of ncyc (q 4) + ncycqq (p 299) - mod(ncyc (q 4), ncycqq (p 299)) so that KEPLER will not try to read old dumps.

New In Version 13.0.0.

Timestep Control Parameters

dtnew

Initial or current timestep.

name

number

type

default

unit

dtnew

1

float

1.

sec

dtmax

Maximum timestep allowed.

name

number

type

default

unit

dtmax

25

float

1.e+99

sec

dtcr

Maximum desired fractional change in radius per step.

name

number

type

default

unit

dtcr

6

float

0.05

-

dtct

Maximum desired fractional change in temperature per step.

name

number

type

default

unit

dtct

7

float

0.05

-

dtcd

Maximum desired fractional change in density per step.

name

number

type

default

unit

dtcd

8

float

0.1

-

dtcq

Maximum desired fractional linear contraction per step.

name

number

type

default

unit

dtcq

9

float

0.05

-

dtcdt

Maximum fractional change in the timestep per step.

name

number

type

default

unit

dtcdt

10

float

0.99

-

dtcl

Maximum desired fractional change in luminosity per step.

name

number

type

default

unit

dtcl

72

float

1.e+99

-

dtcp

Maximum desired fractional change in abundances per step.

name

number

type

default

unit

dtcp

46

float

0.1

-

yfloorx

Minimum elemental mass fraction that effects the timestep.

name

number

type

default

unit

yfloorx

47

float

0.001

-

yflrxcig

Reset the value of yfloorx (p 47) to yflrxcig (p 312) when the central temperature specified by tempcig (p 311) is reached.

name

number

type

default

unit

yflrxcig

312

float

0.003

-

New In Version 5.0.0.

Main entry:

Parameter-Change Parameters

dyemult

If iytsflag (p 67) \ge 1, increase the timestep sensitivity to changes in ye by a factor of dyemult (p 39).

name

number

type

default

unit

dyemult

39

float

200.

-

dyqmult

If iytsflag (p 67) \ge 1, increase the timestep sensitivity to changes in yq by a factor of dyqmult (p 40).

name

number

type

default

unit

dyqmult

40

float

2.5

-

iytsflag

Consider only changes in ye, yq, yf, ysi, and y56 in ISE zones when computing the timestep if iytsflag (p 67) \ge 1.

name

number

type

default

unit

iytsflag

67

integer

1

-

Extrapolation Control Parameters

extrap

Extrapolation Parameter used in guessing new R, T, and L values.

name

number

type

default

unit

extrap

3

float

1.

-

value

result

0.

old values

1.

linear extrapolation

fcrext

Factor used to reduce noise in radius extrapolation.

name

number

type

default

unit

fcrext

26

float

10.

-

See subroutine gess.

fctext

Factor used to reduce noise in temperature extrapolation.

name

number

type

default

unit

fctext

27

float

10.

-

fclext

Factor used to reduce noise in luminosity extrapolation.

name

number

type

default

unit

fclext

71

float

1.e-5

-

Convergence Control Parameters

fcrmax

Maximum allowed relative convergence error in radius.

name

number

type

default

unit

fcrmax

11

float

1.e-6

-

fctmax

Maximum allowed relative convergence error in temperature.

name

number

type

default

unit

fctmax

12

float

1.e-6

-

fclmax

Maximum allowed relative convergence error in luminosity.

name

number

type

default

unit

fclmax

70

float

1.

-

thickfac

Determine whether zones are considered in thermal equilibrium depending on time step and optical thickness.

name

number

type

default

unit

thickfac

51

float

0.001

-

If the timestep is greater than the thermal timescale for a zone by a factor \ge 0.5 \times thickfac (p 51), then consider the zone to be in thermal steady-state and deal with any residual non-convergence in the solution of the energy equation by recalculating the luminosity in terms of the final iterated value of the internal energy. Otherwise, recalculate the internal energy in terms of the final iterated luminosity.

See subroutine update.

denconv

Allowed fractional convergence error in density when calculating a hydrostatic initial stellar configuration in the generator using the dstat option.

name

number

type

default

unit

denconv

213

float

1.e-7

-

See subroutine gener.

fmin

Under-relaxation factor on the corrections taken each iteration in the Henyey-solver.

name

number

type

default

unit

fmin

375

float

1.

-

The maximum number of iteration is now maxit (p 5) / fmin (p 375).

New In Version 15.3.0.

Backup Control Parameters

maxit

Maximum number of times subroutine regess is called to iterate R, T, and L estimates before the timestep is reduced by dtcut (p 53) and the step repeated (termed a backup).

name

number

type

default

unit

maxit

5

integer

40

-

maxbak

Maximum number of times a given step is redone before the code quits.

name

number

type

default

unit

maxbak

52

integer

5

-

dtcut

Fractional timestep reduction when a step is redone.

name

number

type

default

unit

dtcut

53

float

0.1

-

fcrbu

Reduce timestep by dtcut (p 53) and redo step if convergence error in radius is still greater than fcrbu (p 22) after maxit (p 5) iterations.

name

number

type

default

unit

fcrbu

22

float

0.01

-

fctbu

Reduce timestep by dtcut (p 53) and redo step if convergence error in temperature is still greater than fctbu (p 23) after maxit (p 5) iterations.

name

number

type

default

unit

fctbu

23

float

0.01

-

fclbu

Reduce timestep by dtcut (p 53) and redo step if convergence error in luminosity is still greater than fclbu (p 73) after maxit (p 5) iterations.

name

number

type

default

unit

fclbu

73

float

1.

-

tfcrbu

If the maximum fractional change in radius during a timestep exceeds tfcrbu (p 54) \times dtcr (p 6) then redo step.

name

number

type

default

unit

tfcrbu

54

float

2.

-

tfctbu

If the maximum fractional change in temperature during a timestep exceeds tfctbu (p 55) \times dtct (p 7) then redo step.

name

number

type

default

unit

tfctbu

55

float

2.

-

tfclbu

If the maximum fractional change in luminosity during a timestep exceeds tfclbu (p 74) \times dtcl (p 72) then redo step.

name

number

type

default

unit

tfclbu

74

float

1.e+99

-

tfcybu

Maximim allowed fractional change in abundance before an abundance backup is made. (See abunminx (p 204)).

name

number

type

default

unit

tfcybu

205

float

0.5

-

abunminx

Force a backup after a call to subroutine BURN from subroutine sdot if a calculated elemental mass fraction change would cause the resulting mass fraction to be less than abunminx (p 204) or to change by a fractional amount greater than tfcybu (p 205).

name

number

type

default

unit

abunminx

204

float

-1.e-5

-

Negative abundance backup checked for all isotopes in APPROX independent of their abundance. Only the absolute value of abunminx (p 204) is considered, i.e., backups are made if an isotope mass fraction is less than abs(abunminx (p 204)).

Changed In Version >16.9.0: Used to be that “Such backups are made only if the elemental mass fractions involved are greater than yfloorbx (p 206).”

yfloorbx

Elemental mass fraction floor for making abundance backups. (See abunminx (p 204)).

name

number

type

default

unit

yfloorbx

206

float

0.001

-

iqerrflg

Fatal errors in qburn encountered during a normal regess iteration will cause KEPLER to back-up if iqerrflg (p 207) \ge 1, or to terminate if iqerrflg (p 207) < 1.

name

number

type

default

unit

iqerrflg

207

integer

1

-

Main entry:

ISE Network Convergence Parameters

xmratbak

Redo the timestep (“backup”) if the fractional change of mass in the mass-losing zone exceeds xmratbak (p 224).

name

number

type

default

unit

xmratbak

224

float

0.2

-

Main entry:

Mass Loss Parameters

Boundary Condition Parameters

radius0

Radius of inner boundary.

name

number

type

default

unit

radius0

60

float

0.

cm

summ0

Mass inside inner boundary.

name

number

type

default

unit

summ0

61

float

0.

g

xlum0

Luminosity emerging from inner surface.

name

number

type

default

unit

xlum0

62

float

0.

erg/sec

tbound

Temperature at outer boundary.

name

number

type

default

unit

tbound

68

float

0.

K

pbound

Pressure at outer boundary.

name

number

type

default

unit

pbound

69

float

0.

erg/cc

Changed In Version 16.47.0: The boundary pressure from the accretion phantom zone is no longer added here. I goes now into pboundac (q 96) instead.

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.

Main entry:

Mass-Loss-Connected Rezoning Parameters

Accretion Parameters

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

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.

xmacrete

Mass of phantom outer zone used to mediate mass accretion. See accrate (p 211).

name

number

type

default

unit

xmacrete

212

float

0.

g

xl0ratef

Multiplier on luminosity from base from time-dependent input file.

name

number

type

default

unit

xl0ratef

549

float

1.

-

For use with GR corrections in XRB problems. .. versionadded:: 16.96

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.

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.

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.

accmass

Determine accretion mass.

name

number

type

default

unit

accmass

460

float

0.

-

Set mass of the accreted zones if positive.

If negative, the mass of the accreted zone is -accmass (p 460) * totm (q 17).

The mass of the new zone is, however, limited to not be different from the outermost zone by more than a factor (or fraction) accmassf (p 461).

If zero the mass of the new zone is that of the current outermost zone.

New In Version 16.39.0.

accmassf

The mass of newly accreted zone is may not differ by more than a factor (or fraction) accmassf (p 461) from the current outermost zone.

name

number

type

default

unit

accmassf

461

float

1.4142

-

In combination with accmass (p 460) this can be used to accrete a “ramp” of changing zone masses. Good either for well resolved interfaces or fine surface zoning.

New In Version 16.39.0.

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.

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

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

Main entry:

Rotation Parameters

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.

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.

fracadz

Maximum ratio of mass accreting zone before it is forced to adzone.

name

number

type

default

unit

fracadz

518

float

2.

-

New In Version 16.82.0.

Other entry:

Accretion-Connected Rezoning Parameters

losseadv

Include energy term from advection in mass loss.

name

number

type

default

unit

losseadv

519

integer

1

-

value

result

0

switched off.

1

average of zone interface values (recommended).

2

a simple symmetric scheme that is second order for equidistant zone masses.

3

use average gradient and zone center pressure.

4

use second-order gradient and zone center pressure.

5

downward differencing (poor choice).

6

upward differencing (poor choice).

7

use downward boundary value only (seems sub-optimal choice).

8

use upward boundary value only (seems sub-optimal choice).

New In Version 16.82.0.

iacceadv

Include energy term from advection in accretion.

name

number

type

default

unit

iacceadv

520

integer

1

-

Set to 0 to switch off.

See losseadv (p 519) for values.

New In Version 16.82.0.

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

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.

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.

Mass Loss Parameters

xmlossm

Multiplier on the de Jager mass-loss rate.

name

number

type

default

unit

xmlossm

220

float

0.

-

See cycle and [deJ86].

xmloss0

Nominal mass loss rate from the surface of the star.

name

number

type

default

unit

xmloss0

221

float

0.

Msun/yr

This constant mass loss rate is added to whatever de Jager-prescription mass loss may have been specified by xmlossm (p 220).

Todo

TODO: Check how this integrates with later-added mass loss rate formulae

totm0

The original total mass of the star.

name

number

type

default

unit

totm0

222

float

0.

g

This is set during generation and is used in interpreting edit, dump, and rezoning parameters involving stellar mass fractions rather than the current mass of the star (totm (q 17)) which may change. due to mass loss, accretion, etc.

Note

Normally, the internally set value of totm0 (p 222) should not be changed by the user.

fracdez

Dezone the mass-losing zone if its mass drops below fracdez (p 223) times the average mass of the zones on either side of it.

name

number

type

default

unit

fracdez

223

float

0.5

-

Main entry:

Mass-Loss-Connected Rezoning Parameters

xmratbak

Redo the timestep (“backup”) if the fractional change of mass in the mass-losing zone exceeds xmratbak (p 224).

name

number

type

default

unit

xmratbak

224

float

0.2

-

Other entry:

Backup Control Parameters

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.

nsurfz

If nsurfz (p 217) > 0 and izonef (p 86) > 0, maintain a logarithmic ramp in zonal mass of the NSURFZ zones at the surface of the star, where fracsz0 (p 218) is twice the desired mass-fraction of the surface zone and fracsz1 (p 219) is twice the desired mass-fraction of the nsurfz (p 217)th zone from the surface.

name

number

type

default

unit

nsurfz

217

integer

-10

-

Otherwise, nsurfz (p 217) has no effect.

See subroutine rezone.

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Main entry:

Mass-Loss-Connected Rezoning Parameters

fracsz0

Inner surface zoning parameter.

name

number

type

default

unit

fracsz0

218

float

1.

-

See subroutine rezone and the discussion under nsurfz (p 217).

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Main entry:

Mass-Loss-Connected Rezoning Parameters

fracsz1

Outer surface zoning parameter.

name

number

type

default

unit

fracsz1

219

float

1.

-

See subroutine rezone and the discussion under nsurfz (p 217).

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Main entry:

Mass-Loss-Connected Rezoning Parameters

xlanger1

Langer mass loss rate parameter 1.

name

number

type

default

unit

xlanger1

355

float

0.

?

New In Version 14.0.0.

xlanger2

Langer mass loss rate parameter 2.

name

number

type

default

unit

xlanger2

356

float

0.

?

New In Version 14.0.0.

xmlossn

Multiplier on Niewenhuijzen & de Jager mass loss rate.

name

number

type

default

unit

xmlossn

363

float

0.

-

New In Version 15.1.0.

xmlossw

Multiplier on WR mass loss rate.

name

number

type

default

unit

xmlossw

387

float

0.

-

New In Version 15.13.0.

zfakexp

Metallicity-dependence of the mass loss.

name

number

type

default

unit

zfakexp

379

float

0.5

-

\kappa=\kappa_0\cdot(Z/Z_{\odot})^{\mathtt{zfakexp}}

  • For non-WR stars all metals (everything but H and He) are considered.

  • For WR stars only the Fe and Ni abundance is considered.

New In Version 15.7.0.

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.

tloss

Minimum temperature below which zones are removed from star, similar to vloss (p 271) and rloss (p 409).

name

number

type

default

unit

tloss

410

float

-1.e+99

-

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

New In Version 15.29.0.

cfakexp

Metallicity dependent mass loss scaling with C abundance for cool Pop III stars.

name

number

type

default

unit

cfakexp

473

float

0.

-

If under-abundant in $\mathrm{C}$ and $\mathrm{Fe}$ relative to total metallicity, reduce mass loss by abundance fraction of $\mathrm{C}$+$\mathrm{Fe}$ relative to its solar value, to power cfakexp (p 473).

New In Version 16.51.0.

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.

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.

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.

awwkloss

Remove all outer shells that have an angular velocity angwwk -times bigger than Keplerian velocity.

name

number

type

default

unit

awwkloss

469

float

1.e+99

-

New In Version 16.45.0.

Main entry:

Rotation Parameters

lossrot

Use Langer’s (1998) formula for rotationally enhanced mass loss.

name

number

type

default

unit

lossrot

470

integer

0

-

value

result

0

off

1

on

New In Version 16.45.0.

Main entry:

Rotation Parameters

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.

Artificial Viscosity Parameters

q2fac

Quadratic artificial viscosity (q) factor.

name

number

type

default

unit

q2fac

4

float

4.

-

Shock transitions are spread over about 2 * sqrt(q2fac (p 4)) zones. [WZW78].

q1fac

Linear artificial viscosity factor.

name

number

type

default

unit

q1fac

13

float

0.1

-

Helps damp sound waves during hydrostatic evolution. Should be set to 0. during hydrodynamic phases. Normally set to 1000. in the generator until the star settles down onto the zero-age main sequence (from an initially rather arbitrary configuration), at which point it is reset to 0.1.

artv1

Multiply q1fac (p 13) by artv1 (p 107) in zone j if jartv1 (p 110) \le j \le artv2 (p 108).

name

number

type

default

unit

artv1

107

float

1.

-

artv2

Multiply q1fac (p 13) by artv2 (p 108) in zone j if jartv2 (p 111) \le j < jm - jartv3 (p 112).

name

number

type

default

unit

artv2

108

float

1.

-

artv3

Multiply q1fac (p 13) by artv3 (p 109) in zone j if j \ge max(jartv1 (p 110), jartv2 (p 111), jm - jartv3 (p 112)).

name

number

type

default

unit

artv3

109

float

1.

-

jartv1

See artv1 (p 107) - artv3 (p 109).

name

number

type

default

unit

jartv1

110

float

1000.

-

jartv2

See artv1 (p 107) - artv3 (p 109).

name

number

type

default

unit

jartv2

111

integer

1000

-

jartv3

See artv1 (p 107) - artv3 (p 109).

name

number

type

default

unit

jartv3

112

integer

1000

-

q1faczms

Reset the value of q1fac (p 13) to q1faczms (p 310) at the time specified by timezms (p 308).

name

number

type

default

unit

q1faczms

310

float

0.1

-

New In Version 5.0.0.

Main entry:

Parameter-Change Parameters

Equation-Of-State Parameters

pimult

Ion energy and pressure multiplier.

name

number

type

default

unit

pimult

34

float

1.

-

prmult

Radiation energy and pressure multiplier.

name

number

type

default

unit

prmult

35

float

1.

-

pemult

Electron energy and pressure multiplier.

name

number

type

default

unit

pemult

36

float

1.

-

xipot

Ionization potential.

name

number

type

default

unit

xipot

56

float

13.6053

eV

See subroutine es.

dzero

Characteristic density for pressure ionization.

name

number

type

default

unit

dzero

57

float

0.1

g/cc

npflag

Pairs are included in EOS calculation only if npflag (p 58) > 0.

name

number

type

default

unit

npflag

58

integer

1

-

etaconv

Relative convergence required in calculating the electron Fermi degeneracy parameter, eta.

name

number

type

default

unit

etaconv

92

float

1.e-5

-

xmimult

The mass used in calculating ion degeneracy is xmimult (p 149) times the mass of a neutron.

name

number

type

default

unit

xmimult

149

float

1.

-

eionmult

Multiplier on the contribution of ionization potential energy to the equation of state. See subroutine ES.

name

number

type

default

unit

eionmult

196

float

1.

-

wilsonmt

Multiplier on the Wilson-based nuclear EOS (except for thee thermal ion component) if it is \ge 0. Otherwise, the old non-relativistic, partial degeneracy model for the ion EOS is used.

name

number

type

default

unit

wilsonmt

199

float

-1.

-

Warning

Setting this parameter \ge 0 appears to cause anomalous contributions to the pressure and energy at densities far below nuclear density and probably should not be used without revision. See subroutine ES.

t11cut

Upper bound on the temperature used to calculate the energy in nuclear excited states and nuclear partition functions.

name

number

type

default

unit

t11cut

200

float

1.

1.e+11 K

See subroutines es and sdotq.

Main entry:

ISE Network Physics Parameters

coulmult

Multiplier on the Wigner-Seitz Coulomb corrections to the ion energy and pressure (See [Cla], p. 152, and subroutine es).

name

number

type

default

unit

coulmult

215

float

1.

-

icalcne

Calculate more accurate electron densities in partially ionized regions if icalcne (p 337) > 0 using Lisa Ensman’s multiple-ion, Saba equilibrium subroutine, calcne.

name

number

type

default

unit

icalcne

337

integer

0

-

Generally this more accurate, but very time-consuming routine is turned on just before shock-breakout while doing supernova light-curve calculations.

New In Version 12.0.0.

xneconv

Maximum allowable fractional convergence error in the electron density calculated by subroutine calcne.

name

number

type

default

unit

xneconv

338

float

1.e-5

-

See icalcne (p 337).

New In Version 12.0.0.

ionflag

Determine calculation of ionization.

name

number

type

default

unit

ionflag

339

integer

0

-

If ionflag (p 339) \le 0 and the density and temperature have changed by a fraction less than ddsfrac (p 153) and dtsfrac (p 154), respectively, since the last iteration, then extrapolate the value of the electron density from its partial derivatives with respect to density and temperature instead of calling calcne (when icalcne (p 337) > 0 – see icalcne (p 337)), unless this is the first iteration.

Otherwise call calcne all the time, provided icalcne (p 337) > 0.

New In Version 12.0.0.

xnemin

Minimum mass fraction for which an element is included in the calculation of Saha ionization equilibrium done in subroutine calcne.

name

number

type

default

unit

xnemin

340

float

1.e-5

-

See icalcne (p 337).

New In Version 12.0.0.

Heat Diffusion Parameters

transm

Multiplier on diffusive heat transport.

name

number

type

default

unit

transm

37

float

1.

-

t7peek

Opacity will be no larger than xkmin (p 50) + t7peek (p 49) \times \rho * T_7^4.

name

number

type

default

unit

t7peek

49

float

1.e+50

cgs

T_7 = T\left/10^7\,\mathrm{K}\right.

The unit should be about \mathrm{cm}^5\,\mathrm{g}^{-3}.

xkmin

Least upper opacity bound.

name

number

type

default

unit

xkmin

50

float

1.e-10

cm**2/g

See t7peek (p 49) and KAPPA

zbound

Mass fraction of heavy elements above which iben1 opacities are used.

name

number

type

default

unit

zbound

91

float

0.1

-

xkimt

Multiplier on iben1 opacity.

name

number

type

default

unit

xkimt

29

float

1.

-

xk2mt

Multiplier on iben2 opacity.

name

number

type

default

unit

xk2mt

30

float

1.

-

xk3mt

Multiplier on Christy opacity.

name

number

type

default

unit

xk3mt

31

float

1.

-

xk4mt

Multiplier on Compton opacity.

name

number

type

default

unit

xk4mt

32

float

1.

-

rxkcmt

Multiplier on conductive opacity.

name

number

type

default

unit

rxkcmt

33

float

1.

-

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)

fkapz

Multiplier on metallicity used in OPAL opacities.

name

number

type

default

unit

fkapz

378

float

1.

-

New In Version 15.6.0.

xkdmin

Minimum value for density used in subroutine kappa.

name

number

type

default

unit

xkdmin

404

float

1.e-20

-

New In Version 15.24.0.

kapburn

Use of BURN abundances for opacity.

name

number

type

default

unit

kapburn

467

integer

0

-

value

result

0

use APPROX abundances

1

use BURN abundances

New In Version 16.43.0.

fackap

Multiply opacity and its derivatives by fackap (p 468).

name

number

type

default

unit

fackap

468

float

1.

-

New In Version 16.44.0.

Convection Parameters

xmlen

Ratio of the convective mixing length to the pressure scale height.

name

number

type

default

unit

xmlen

19

float

1.

-

fudgc

Fudge factor for convection (about 0.01).

name

number

type

default

unit

fudgc

20

float

0.01

-

Reduces convective efficiency for very small departures from adiabatic gradients and thus makes the numerical onset of convection less abrupt and unstable. (see subroutines regess and update)

difim

Multiplier for the rate of convective mixing.

name

number

type

default

unit

difim

21

float

1.

-

fracneut

If the semi convective test parameter, W, is < 0. but greater than - fracneut (p 59) * abs(log(T1/T0)), then the zonal interface is flagged convectively neutral (“NEUT” or “,”).

name

number

type

default

unit

fracneut

59

float

0.05

-

See subroutine update.

Other entry:

Graphics Labeling Parameters

frcsound

Don’t do convection if the absolute value of the zone velocity exceeds frcsound (p 146) times the local sound speed.

name

number

type

default

unit

frcsound

146

float

0.1

-

convlim

Limit the convective velocity to a fraction convlim (p 147) of the local sound speed.

name

number

type

default

unit

convlim

147

float

1.

-

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.

xltaucon

Limit how fast convective velocity can increase.

name

number

type

default

unit

xltaucon

209

float

0.

sec

Don’t allow the convective velocity to increase by a factor greater than exp (dt (q 1)/(xltaucon (p 209) \times tauconv)) in one timestep, where dt (q 1) is the current timestep and tauconv is the timescale for convective mixing.

See subroutines regess and update.

Useful in modeling detonations.

See flamerad (p 214) for studying deflagrations.

Main entry:

Carbon Deflagration Parameters

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.

Main entry:

ISE Network Transition Parameters

mixcycl

Determine when during cycle “”mixing” is being done.

name

number

type

default

unit

mixcycl

433

integer

0

-

Do mixing at beginning mixcycl (p 433) = 1, 2) or at end of cycle mixcycl (p 433) = 0; default behaviour).

mixcycl (p 433) > 0 is extremely helpful to prevent fatal crashes due do mixing after a too long time step, e.g., off-center burning shells that burn inward.

mixcycl (p 433) = 1 uses always the new time step (dt (q 1)) for mixing.

mixcycl (p 433) = 2 uses the old time step (dtold (q 3); magnitude of mixing consistent with mixcycl (p 433) = 0) for mixing unless a backup occurs, then also the current time-step of the backup cycle (dt (q 1)) is used. When a backup occurs, the original mass fractions are restored and the star is re-mixed with the new time-step. Effective diffusion coefficients as used for the mixing are stored in the restart dump.

New In Version 16.22.0.

Other entry:

Semiconvection And Overshoot Parameters

zmhiconv

Maximum mass for convection.

name

number

type

default

unit

zmhiconv

490

float

1.e+99

g

New In Version 16.66.0.

rnhiconv

Maximum radius for convection.

name

number

type

default

unit

rnhiconv

491

float

1.e+99

cm

New In Version 16.66.0.

Semiconvection And Overshoot Parameters

drmult

Semi-convective mixing will be slower than thermal transport by at least drmult (p 24) (about 0.1) in zones with mean atomic weight, \bar{A}, is \ge abarsemi (p 324).

name

number

type

default

unit

drmult

24

float

0.1

-

See subroutine update.

Also see drmultlo (p 325), woversht (p 148), and woverslo (p 326).

dtsmult

The fractional amount of semi convective mixing that can occur in one timestep is limited to approximately dtsmult (p 75).

name

number

type

default

unit

dtsmult

75

float

1.e+99

-

woversht

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

name

number

type

default

unit

woversht

148

float

0.01

-

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

See update and [WZW78].

If woversht (p 148) = 0 no overshoot mixing is done.

Also see woverslo (p 326).

abarsemi

Value of the zonal mean atomic weight, \bar{A}, used to divide the star into two regions with separately specifiable values of the semiconvective mixing rate and the overshoot mixing coefficient.

name

number

type

default

unit

abarsemi

324

float

4.

g/mol

See the definitions of drmult (p 24), woversht (p 148), drmultlo (p 325), and woverslo (p 326).

New In Version 9.0.0.

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

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

nosht

Convective zones are bound by overshooting layer only of they are at least nosht (p 424) zones thick.

name

number

type

default

unit

nosht

424

integer

2

-

This is to prevent the numerical “spaghetti” instability.

Old dumps are restart with the previous standard value of nosht (p 424) = 1.

New In Version 16.13.0.

optconv

Minimum optical depth below (i.e., outside of) which zone are not allowed to become convective.

name

number

type

default

unit

optconv

408

float

2./3.

-

Note

when loading old dumps the it is set to 0.

New In Version 15.27.0.

semilan

\alpha efficiency parameter for semiconvection according to [Lan83].

name

number

type

default

unit

semilan

412

float

0.

-

[Lan83] is generalized for general EOS by replacing in Eq. (10)

\nabla_{\mathrm{L}}-\nabla

by

\nabla_{\mathrm{S}}-\frac{d \log \rho}{d \log
P}\left(\Gamma_3-1\right).

For an ideal gas with radiation the second term of the new expression is equal to \nabla-\frac{\phi}{\delta}\nabla_{\mu}, giving the original relation from [Lan83]. If semilan (p 412) \leq 0 the original prescription of [WZW78] Overshooting also is still treated that way.

New In Version 15.30.0.

alpth

Efficiency factor for thermohaline convection.

name

number

type

default

unit

alpth

425

float

1.

-

If set to zero no thermohaline convection is considered. Thermohaline convections occurs in regions with destabilizing composition gradient, but stabilizing temperature gradient (salt finger instability). The implementation in KEPLER is according to Braun (1997, PhD thesis) and Kippenhahn et al. (1980)

New In Version 16.16.0.

mixcycl

Determine when during cycle “”mixing” is being done.

name

number

type

default

unit

mixcycl

433

integer

0

-

Do mixing at beginning mixcycl (p 433) = 1, 2) or at end of cycle mixcycl (p 433) = 0; default behaviour).

mixcycl (p 433) > 0 is extremely helpful to prevent fatal crashes due do mixing after a too long time step, e.g., off-center burning shells that burn inward.

mixcycl (p 433) = 1 uses always the new time step (dt (q 1)) for mixing.

mixcycl (p 433) = 2 uses the old time step (dtold (q 3); magnitude of mixing consistent with mixcycl (p 433) = 0) for mixing unless a backup occurs, then also the current time-step of the backup cycle (dt (q 1)) is used. When a backup occurs, the original mass fractions are restored and the star is re-mixed with the new time-step. Effective diffusion coefficients as used for the mixing are stored in the restart dump.

New In Version 16.22.0.

Main entry:

Convection Parameters

Rotation Parameters

nangmix

Enable rotationally-induced mixing.

name

number

type

default

unit

nangmix

364

integer

0

-

value

result

0

off

1

on

New In Version 15.2.0.

angfmu

Molecular weight sensitivity of rotational mixing processes.

name

number

type

default

unit

angfmu

365

float

1.

-

Affects Eddington-Sweet circulation and Goldreich-Schubert-Fricke instability. If a negative sign is added, these instabilities are completely switched off when the \mu-current exceeds the destabilizing circulation velocity, otherwise they are just reduced by a factor of one plus the ratio of the two circulation velocities.

New In Version 15.2.0.

angfc

Efficiency of chemical mixing by rotational instabilities.

name

number

type

default

unit

angfc

366

float

1.

-

New In Version 15.2.0.

angfjc

Efficiency of angular momentum transport by (semi)convection.

name

number

type

default

unit

angfjc

367

float

1.

-

New In Version 15.2.0.

angrcrit

Critical Reynolds number (affects secular shear instability).

name

number

type

default

unit

angrcrit

368

float

2500.

-

New In Version 15.2.0.

angric

Critical Richardson number (do not change).

name

number

type

default

unit

angric

369

float

0.25

-

New In Version 15.2.0.

angfjdsi

General efficiency multiplier for dynamical shaer instability.

name

number

type

default

unit

angfjdsi

370

float

1.

-

New In Version 15.2.0.

angfjshi

General efficiency multiplier for Solberg-Hoiland instability.

name

number

type

default

unit

angfjshi

371

float

1.

-

New In Version 15.2.0.

angfjssi

General efficiency multiplier for secular shear instability.

name

number

type

default

unit

angfjssi

372

float

1.

-

New In Version 15.2.0.

angfjez

General efficiency multiplier for Eddington-Sweet circulation.

name

number

type

default

unit

angfjez

373

float

1.

-

New In Version 15.2.0.

angfjgsf

General efficiency multiplier for Goldreich-Schubert-Fricke instability.

name

number

type

default

unit

angfjgsf

374

float

1.

-

New In Version 15.2.0.

angfjdyn

General efficiency multiplier for generalised dynamical instability.

name

number

type

default

unit

angfjdyn

585

float

0.

-

New In Version 18.1.0.

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.

angsmt

Secular rotational mixing processes may not change by more than that per time-step.

name

number

type

default

unit

angsmt

380

float

1.

-

New In Version 15.8.0.

nangsmg

Smooth some gradients used for computation of the rotational instabilities over that much grid points on either side. A Gaussian smoothing profile is used.

name

number

type

default

unit

nangsmg

381

integer

2

-

New In Version 15.8.0.

angsml

Secular rotational mixing processes may change by at least that fraction for the local zonal diffusion time-scale.

name

number

type

default

unit

angsml

382

float

0.001

-

New In Version 15.8.0.

angsmm

Secular rotational mixing processes may change by at least that fraction of the total diffusion coefficient.

name

number

type

default

unit

angsmm

383

float

0.001

-

New In Version 15.8.0.

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.

awcorotx

x-component of co-rotation angular velocity.

name

number

type

default

unit

awcorotx

581

float

0.

-

Enabled using ymcorot (p 431).

awcoroty

y-component of co-rotation angular velocity.

name

number

type

default

unit

awcoroty

582

float

0.

-

Enabled using ymcorot (p 431).

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.

awwkloss

Remove all outer shells that have an angular velocity angwwk -times bigger than Keplerian velocity.

name

number

type

default

unit

awwkloss

469

float

1.e+99

-

New In Version 16.45.0.

Other entry:

Mass Loss Parameters

lossrot

Use Langer’s (1998) formula for rotationally enhanced mass loss.

name

number

type

default

unit

lossrot

470

integer

0

-

value

result

0

off

1

on

New In Version 16.45.0.

Other entry:

Mass Loss Parameters

ymjkep

Reduce angular momentum to Keplerian angular momentum in the surface layes down to an exterior mass of ymjkep (p 471) if it exceeds Keplerian rotation.

name

number

type

default

unit

ymjkep

471

float

-1.e+99

-

This is useful for some accretion problems of for mapping stars with too much rotation into KEPLER, e.g, from merging binaries.

New In Version 16.49.0.

centmult

Multiplier on simplistic centrifugal force.

name

number

type

default

unit

centmult

480

float

0.

-

Currently just uses j^2/r^3 at equator, i.e., \omega^2\,r where r is shell radius. It would appear a naive integration over a rigid spherical shell would have an average centrifugal force in radial direction of 2/3.

Note

Use 2/3.

New In Version 16.54.0.

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.

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.

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.

angw0m

Mass coordinate (not including summ0 (p 61)) for which inner angular velocities angw0x (p 579), angw0y (p 580), and angw0z (p 510) are set.

name

number

type

default

unit

angw0m

511

float

-1.

g

A negative value disables setting of inner region angular velocity (default).

New In Version 16.77.0.

Todo

A value of 0 sets just inner boundary condition.

If solved by diffusion equation, transfer may be hard to estimate; alternatively, moment of inertia of core could be provided as parameter.

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.

Other entry:

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

Other entry:

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

Other entry:

Accretion Parameters

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.

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.

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.

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.

Other entry:

Various Files

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.

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.

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.

Magnetic Fields

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.

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.

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.

xmagfmu

Multiply \mu-gradient considered in magnetic field model by this factor.

name

number

type

default

unit

xmagfmu

438

float

1.

-

New In Version 16.26.0.

xmagft

Multiply T-gradient considered in magnetic field model by this factor.

name

number

type

default

unit

xmagft

439

float

1.

-

New In Version 16.26.0.

xmagfnu

Multiply eddy viscosity by considered in magnetic field model this factor.

name

number

type

default

unit

xmagfnu

440

float

1.

-

New In Version 16.25.0.

xmagfdif

Multiply eddy diffusivity in magnetic field model by this factor.

name

number

type

default

unit

xmagfdif

441

float

1.

-

New In Version 16.25.0.

Nuclear Reaction Parameters

sneutmt

Neutrino energy loss rate multiplier (APPROX only).

name

number

type

default

unit

sneutmt

101

float

1.

-

snucmt

Non-neutrino nuclear energy generation rate multiplier (APPROX only).

name

number

type

default

unit

snucmt

102

float

1.

-

c12agmlt

Multiplier on the overall C12(a,g) rate (APPROX only).

name

number

type

default

unit

c12agmlt

208

float

1.

-

Warning

This parameter is obsolescent. It is better to use e1mltc12 (p 227) and e2mltc12 (p 228).

Deprecated Since Version <15.0.0.

e1mltc12

Multiplier on the E1 part of the C12(a,g) cross-section.

name

number

type

default

unit

e1mltc12

227

float

1.

-

Note

Affects both APPROX and the the BURN coprocessor, but currently has no effect on the CI2(a,g) rate used to calculate photo-disintegration flows in ISE)

e2mltc12

Multiplier on the E2 part of the C12(a,g) cross-section.

name

number

type

default

unit

e2mltc12

228

float

1.

-

Note

Affects both APPROX and the the BURN coprocessor, but currently has no effect on the C12(a,g) rate used to calculate photo-disintegration flows in ISE.

tnucmin

Don’t calculate nuclear burning in APPROX if the temperature is less than tnucmin (p 65).

name

number

type

default

unit

tnucmin

65

float

0.

K

Note

Unless the hydrogen burning rate is significant, no APPROX network calculations will be done below 1.e+7 K, even if tnucmin (p 65) < 1.e+7 K. See dypmin (p 89).

dypmin

Minimum amount of potential hydrogen burn in the present timestep needed to trigger the use of any reaction network.

name

number

type

default

unit

dypmin

89

float

1.e-10

mol/g

APPROX only.

Note

This really should be set to a much smaller number! (-Alex)

dymgmin

Minimum amount of Mg24 production required in the last timestep to trigger the use of the full reaction network.

name

number

type

default

unit

dymgmin

90

float

1.e-10

mol/g

APPROX only.

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

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.

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.

irnet

Network switch parameter.

name

number

type

default

unit

irnet

63

integer

0

-

value

result

0

use APPROX network

1

use sdot1 (H and He burning network).

else

use sdot2 (NOVA network).

Note

sdot1 and sdot2 are replaced by dummy routines in the current version of KEPLER and an error message will result if they are entered.

Warning

The old routines would have to be extensively updated before being used again.

dsnum

Fractional density and temperature perturbations used to get nuclear energy generation rate derivatives.

name

number

type

default

unit

dsnum

103

float

1.e-6

-

APPROX only.

ddsfrac

Maximum fractional change in density since the last iteration for which \bar{A} changes and energy generation rates can be extrapolated from their previous values (APPROX only).

name

number

type

default

unit

ddsfrac

153

float

0.01

-

dtsfrac

Maximum fractional change in temperature since the last iteration for which ABAR changes and energy generation rates can be extrapolated from their previous values (APPROX only).

name

number

type

default

unit

dtsfrac

154

float

0.001

-

iudflag

Extrapolate energy generation rates and \bar{A} changes in cases of small temperature and density change only if iudflag (p 155) is also \le 0.

name

number

type

default

unit

iudflag

155

integer

0

-

iupdflag

Don’t calculate derivatives in subroutine sdot when called from subroutine update if iupdflag (p 163) \ge 0.

name

number

type

default

unit

iupdflag

163

integer

1

-

APPROX only.

iflgabar

The mean atomic weight, \bar{A}, calculated in subroutine sdot is implicitly coupled to the ion equation of state only if iflgabar (p 160) \ne 0 and the normal APPROX network (IN = 1) is being used.

name

number

type

default

unit

iflgabar

160

integer

0

-

Warning

This is an obsolescent parameter and the coding should be carefully rechecked if it is set \ne 0).

Deprecated Since Version <15.0.0.

dxncbkup

Backup if abundance change vector dy returned from burn implies a mass non-conservation larger than dxncbkup.

name

number

type

default

unit

dxncbkup

442

float

1.e-7

-

New In Version 16.28.0.

irprox

Determine use of RPROX network.

name

number

type

default

unit

irprox

482

integer

1

-

value

result

0

never use RPROX

1

use RPROX network when in right temperature and hydrogen mass fraction regime (default)

2

use RPROX network independent of yp mass fraction

3

always use rprox network

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.

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.

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.

tnumin

Minimum temperature for neutrino losses if APPROX and BURN are not active.

name

number

type

default

unit

tnumin

522

float

1.e+7

-

New In Version 16.84.0.

Main entry:

Physics Parameters

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.

Carbon Deflagration Parameters

xltaucon

Limit how fast convective velocity can increase.

name

number

type

default

unit

xltaucon

209

float

0.

sec

Don’t allow the convective velocity to increase by a factor greater than exp (dt (q 1)/(xltaucon (p 209) \times tauconv)) in one timestep, where dt (q 1) is the current timestep and tauconv is the timescale for convective mixing.

See subroutines regess and update.

Useful in modeling detonations.

See flamerad (p 214) for studying deflagrations.

Other entry:

Convection Parameters

flamerad

Characteristic flame radius for carbon deflagration studies.

name

number

type

default

unit

flamerad

214

float

0.

cm

If xltaucon (p 209) > 0 and flamerad (p 214) > 0, multiply the convective timescale, taucon, used to calculate the maximum allowed rate that the convective luminosity can increase (see xltaucon (p 209)) by an additional factor of flamerad (p 214)/rflame, where rflame is the maximum radius at which a temperature above 2.e+9 K exists. This parameter effectively varies the velocity at which a deflagration can propagate and should be used only when studying carbon detonations.

Note

Larger values of flamerad (p 214) imply slower deflagration speeds, and that the relationship is not linear.

Flame Model

Propagation of a single one dimensional burning front based on the Sharp Wheeler Model.

The motion of the flame at time t is given by

v=A\,g_\mathrm{eff}\,(t-t_\mathrm{new})^C.

The flame also has a minimum value that can be set by convection or by the laminar speed. g_\mathrm{eff} is the acceleration due to gravity at the flame surface times the Atwood number there (from subroutine vcond)

Parameters used:

parameter

description

timenew (p 281)

when the flame became RT unstable

sharp1 (p 282)

A

sharpr (p 283)

B - minimum speed from convection (cm/sec)

sharp2 (p 284)

C

newflam (p 285)

edit only - current location of flame

Initially the flame moves at the laminar speed or turbulent convective speed until the instability has time to develop.

If the carbon fraction is non zero - use the laminar speed

If sharpr (p 283) is non-zero use the convective speed

Typical values are

parameter

value

c12flame (p 279)

0.

timenew (p 281)

1.

sharp1 (p 282)

0.1

sharpr (p 283)

1.e+7 cm/sec

sharp2 (p 284)

1.

c12flame

Carbon mass fraction ahead of flame.

name

number

type

default

unit

c12flame

279

float

0.

-

For carbon compositions the laminar flame speed is taken to scale as (c12flame/0.5)**:n:0.889.

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

279 FLAMVA 0.

If FLAMVA /= 0., the current problem is a study of a carbon
deflagration in a white dwarf.

The current radius of the deflagration flame is taken as the
radius of the outermost zone where the temperature exceeds
2.E+9 K and is edited as JFLAM by KEPLER.  The outward speed
of the flame is controlled by adjusting the opacity for heat
conduction between zones JFLAM and JFLAM + 1 up or down by a
factor, XKAPFLAM, between 0. and 1.  Such "gating" is
performed in subroutines KAPPA and UPDATE and sets the
velocity of advance of the 2.E+9 K temperature front to a
comoving value that averages: vflame = vcond * ( rflame /
xlambmin)**(FLAMVB - 2.), where xlambmin = 4 * pi * vcond**2
/ geff and vcond is FLAMVC times the heat conduction
velocity, rflame is the current radius of the flame front,
and geff is FLAMVA times the acceleration of gravity at the
flame front.  The calculated flame velocity is bounded below
by vcond and above by FLAMVD times the speed of sound behind
the flame front.  Basically the flame front wrinkles as it
propagates in a fractal manner and the extra area it thus
enjoys causes the flame to burn the entrained material more
rapidly.  See subroutine CYCLE for more details.  FLAMVA
would typically be set to a value about 0.2 corresponding to
a 20 % delta rho/rho across the burning front to study
"plausible" carbon deflagrations using this model.

o16flame

Oxygen mass fraction for ne-ox problems.

name

number

type

default

unit

o16flame

280

float

0.

-

For neon-oxygen compositions the flame has a composition dependence (o16flame (p 280)/0.6)**:n:0.688

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

280 FLAMVB 2.6

Fractal exponent helping determine the relationship between
the velocity of heat conduction and the velocity of the
carbon deflagration flame based on its degree of "wrinkling."

FLAMVB is equivalent to the fractal dimension of the burning
front which is 2. for a smooth surface, 2.7 corresponds to
fully developed turbulence, and 3. corresponds to filled
space.

timenew

When the flame became RT unstable.

name

number

type

default

unit

timenew

281

float

0.

sec

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

281 FLAMVC 50.

Multiplier on the heat conduction velocity used to calculate
the velocity of the carbon deflagration front.

See the discussion given for FLAMVA for a more detailed
explanation of its use.  The default value of 50. corresponds
to the laminar flame speed in a 50/50 carbon-oxygen mixture
at 2.E+9 g/cc.

sharp1

Sharp1 parameter.

name

number

type

default

unit

sharp1

282

float

0.

-

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

282 FLAMVD 1.

The velocity of the carbon deflagration flame front is
limited to FLAMVD times the local sounq speed.

See the discussion for FLAMVA.

sharpr

Minimum speed from convection.

name

number

type

default

unit

sharpr

283

float

1.

cm/sec

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

283 JFLAM 0

The zone where the carbon deflagration flame is currently
located.

Note:
This parameter is internally set by KEPLER to be the
outermost zone whose temperature exceeds 2.E+9 K and its
value should not be changed by the user.

sharp2

Sharp2 parameter.

name

number

type

default

unit

sharp2

284

float

0.

-

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

284 XKAPFLAM 0.001

Carbon deflagration opacity gating factor.

Must be 0. < XKAPFLAM < 1.

See the discussion given for FLAMVA for a more detailed
explanation of its use.

newflam

(Edit only.).

name

number

type

default

unit

newflam

285

integer

0

-

Note

Stan, please explain.

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

285 XMFLAM 0.

The mass (g) in the current carbon deflagration flame-front
zone JFLAM (P 283) that has already been burned

This parameter is set internally by KEPLER and should not be
changed.

When the entire mass of zone JFLAM has been burned the
opacity coupling it to zone JFLAM + 1 is changed from being
divided by XKAPFLAM to being multiplied by it.  This causes
the flame front to advance to the next zone.  See the
discussion given for FLAMVA.

xlmxmult

Obsolete.

name

number

type

default

unit

xlmxmult

347

float

1.

-

Changed In Version 16.6.0.

Note

The original manuscript contained the description:

347 FLAMVE 0.805

Density power dependence of the heat conduction velocity used
in calculating the velocity of nuclear deflagrations in Type
Ia supernovae.

See parameters 279 - 285 and subroutine cycle for details.

composition

value

C/O

0.805

Ne/O

1.06

tsharp

A parameter for Type Ia SNe simulations.

name

number

type

default

unit

tsharp

362

float

0.

?

Now obsolete.

New In Version 14.50.0.

Deprecated Since Version 16.2.0.

rhotrans

Some SNIa stuff.

name

number

type

default

unit

rhotrans

389

float

1.e+7

-

Now obsolete.

Note

Ask Stan.

New In Version 15.17.0.

Deprecated Since Version 16.2.0.

cbfmult

Multiplier for convectively bound flame for O burning flame.

name

number

type

default

unit

cbfmult

593

float

0.

-

New In Version 18.7.0.

ISE Network Transition Parameters

tqselim

A sufficient condition to change a zone from the APPROX to ISE network is if its temperature exceeds tqselim (p 184), its o16 mass fraction is less than o16lim (p 185), its iron peak mass fraction exceeds qn56lim (p 186), and its density exceeds dqselim (p 203).

name

number

type

default

unit

tqselim

184

float

1.5e+9

K

o16lim

See tqselim (p 184).

name

number

type

default

unit

o16lim

185

float

0.04

-

qn56lim

See tqselim (p 184).

name

number

type

default

unit

qn56lim

186

float

0.

-

siqselim

A sufficient condition to change a zone from the ISE to the NSE network is for the sum of the silicon and sulphur “group” elemental mass fractions to be less than or equal to siqselim (p 189).

name

number

type

default

unit

siqselim

189

float

0.001

-

dqselim

Nominal minimum density for changing a zone from the APPROX to the ISE network.

name

number

type

default

unit

dqselim

203

float

100000.

g/cc

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.

Other entry:

Convection Parameters

noiland

If noiland (p 290) > 0, prevent separated islands of zones employing the ISE network from developing by not letting zone j go to ISE unless zone j - 1 has already done so.

name

number

type

default

unit

noiland

290

integer

1

-

jqse

Change all APPROX network zones with j < jqse (p 106) to the ISE network.

name

number

type

default

unit

jqse

106

integer

0

-

jnse

Change all ISE zones with j < jnse (p 188) to the NSE network.

name

number

type

default

unit

jnse

188

integer

0

-

tapprox

Change zones back to APPROX network if temperature drops below tapprox (p 411).

name

number

type

default

unit

tapprox

411

float

-1.e+99

-

Operates similar to the approx command in Input Cards.

New In Version 15.29.0.

ISE Network Physics Parameters

y56gessm

Initial guess made in sdot for the y56 abundance when initializing a new ISE zone.

name

number

type

default

unit

y56gessm

201

float

0.0001

mol/g

If y56gessm (p 201) is within 0.001 of 1., the temperature is greater than tqsemin (p 105), and J > 1, then the initial guesses for the proton, neutron, and Fe56 abundances used in the ISE iteration are taken equal to their values in the next innermost zone, which typically is already in ISE.

yemax

Maximum value of Y_\mathrm{e} allowed when initializing a new ISE zone.

name

number

type

default

unit

yemax

323

float

0.498

mol/g

This simulates the small amount of neutronization that usually occurs before the end of oxygen burning.

New In Version 9.0.0.

iburnye

Initialization of ISE zones with Y_\mathrm{e} taken from the BURN network.

name

number

type

default

unit

iburnye

357

integer

0

-

value

result

0

off

1

on

When off Y_\mathrm{e} is initialized from APPROX| instead, but observing yemax (p 323).

New In Version 14.0.0.

yemin

No further changes in ye are allowed for ye < yemin (p 41) :unit: mol/g.

name

number

type

default

unit

yemin

41

float

0.02

-

tqsemin

Floor on the temperature used in the ISE calculation.

name

number

type

default

unit

tqsemin

105

float

2.e+9

K

snuwmult

Multiplier on neutrino energy losses from weak processes on nuclei and nucleons.

name

number

type

default

unit

snuwmult

187

float

1.

-

Note

ISE only.

iexciteh

Include excited states in ISE calculations only if iexciteh (p 171) > 0.

name

number

type

default

unit

iexciteh

171

integer

1

-

t11cut

Upper bound on the temperature used to calculate the energy in nuclear excited states and nuclear partition functions.

name

number

type

default

unit

t11cut

200

float

1.

1.e+11 K

See subroutines es and sdotq.

Other entry:

Equation-Of-State Parameters

isi30brn

Neutron-rich-silicon-burning flows are included in the ISE network if isi30brn (p 202) \ge 1.

name

number

type

default

unit

isi30brn

202

integer

1

-

See subroutine sdotq.

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

ISE Network Convergence Parameters

iterqmh

Maximum number of iterations allowed in ISE calculation.

name

number

type

default

unit

iterqmh

172

integer

1000

-

ypconvh

Allowed relative convergence error in the proton abundance in the ISE calculation.

name

number

type

default

unit

ypconvh

173

float

1.e-8

-

ynconvh

Allowed relative convergence error in the neutron abundance in the ISE calculation.

name

number

type

default

unit

ynconvh

174

float

1.e-8

-

ysiconvh

Allowed relative convergence error in the Si28 abundance in the ISE calculation.

name

number

type

default

unit

ysiconvh

175

float

1.e-8

-

cnseh

Increment the proton, neutron, and $^{28}\mathrm{Si}$ abundances by a fraction cnseh (p 176) of that calculated by the Newton-Raphson method for an ISE iteration.

name

number

type

default

unit

cnseh

176

float

1.

-

fyph

Maximum allowed relative change in proton abundance during an ISE iteration.

name

number

type

default

unit

fyph

177

float

0.05

-

fynh

Maximum allo~ed relative change in neutron abundance during an ISE iteration.

name

number

type

default

unit

fynh

178

float

0.05

-

fysih

Maximum allowed relative change in Si28 abundance during an ISE iteration.

name

number

type

default

unit

fysih

179

float

0.15

-

xiter1qe

If the relative change of the proton, neutron, or $^{28}\mathrm{Si}$ abundance is opposite in sign and more than xiter1qe (p 181) in magnitude with respect to the corresponding change during the previous ISE iteration cycle, then cut the current step size in half if more than iter1qe (p 182) iterations have been done.

name

number

type

default

unit

xiter1qe

181

float

0.5

-

iter1qe

See xiter1qe (p 181).

name

number

type

default

unit

iter1qe

182

integer

10

-

iqerrflg

Fatal errors in qburn encountered during a normal regess iteration will cause KEPLER to back-up if iqerrflg (p 207) \ge 1, or to terminate if iqerrflg (p 207) < 1.

name

number

type

default

unit

iqerrflg

207

integer

1

-

Other entry:

Backup Control Parameters

dtqnum

Relative temperature change used in calculating numerical derivatives in sdotq.

name

number

type

default

unit

dtqnum

169

float

0.0001

-

ddqnum

Relative density change used in calculating numerical derivatives in sdotq.

name

number

type

default

unit

ddqnum

170

float

0.0001

-

BURN Coprocessing Control Parameters

inburn

BURN coprocessing and related edits are done only if inburn (p 267) > 0.

name

number

type

default

unit

inburn

267

integer

0

-

Note

inburn (p 267) is set to 1 by subroutine genburn if a BURN generator deck has been specified in the regular generator deck using the genburn card or by the genburn interactive command.

Warning

This is an internal flag and should not be changed by the user, except to permanently turn off BURN co-processing in a problem.

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

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.

dtfrac

When BURN co-processing is initiated, or when the zerotime or reset commands are given, (re)set the zonal timesteps used by the BURN coprocessor to dtfrac (p 230) * dtnew (p 1).

name

number

type

default

unit

dtfrac

230

float

0.01

-

netmax

BURN co-processing is skipped if a zone’s network number, netnum, is greater than netmax (p 240).

name

number

type

default

unit

netmax

240

integer

1

-

bmassmin

BURN co-processing is skipped if a zone’s exterior mass coordinate is less than bmassmin (p 231).

name

number

type

default

unit

bmassmin

231

float

-1.

g

bmassmax

BURN co-processing is skipped if a zone’s exterior mass coordinate is greater than bmassmax (p 232).

name

number

type

default

unit

bmassmax

232

float

1.e+99

g

btempmin

BURN co-processing is skipped if a zone’s temperature is less than btempmin (p 233).

name

number

type

default

unit

btempmin

233

float

1.e+6

K

btempmax

BURN co-processing is skipped if a zone’s temperature is greater than btempmax (p 234).

name

number

type

default

unit

btempmax

234

float

1.e+99

K

snucmin

BURN co-processing is skipped if the absolute value of a zone’s normal nuclear energy generation rate (snn) is less than snucmin (p 235).

name

number

type

default

unit

snucmin

235

float

1.e-99

erg/g/sec

bdenmin

BURN co-processing is skipped if a zone’s density is less than bdenmin (p 236).

name

number

type

default

unit

bdenmin

236

float

1.e-99

g/cc

bdenmax

BURN co-processing is skipped if a zone’s density is greater than bdenmax (p 237).

name

number

type

default

unit

bdenmax

237

float

1.e+99

g/cc

nupdate

Do a forced update of BURN isotopic abundances in every zone every nupdate (p 229) cycles.

name

number

type

default

unit

nupdate

229

integer

100

-

tchange

Force a zone to be updated by the BURN coprocessor if its fractional temperature change since its last BURN processing exceeds tchange (p 238).

name

number

type

default

unit

tchange

238

float

0.02

-

dchange

Force a zone to be updated by the BURN coprocessor if its fractional density change since its last BURN processing exceeds dchange (p 239).

name

number

type

default

unit

dchange

239

float

0.05

-

nsubcycm

Number of coupled BURN co-processing / BURN isotope convection subcycles per KEPLER cycle.

name

number

type

default

unit

nsubcycm

264

integer

1

-

yelimb

Minimum value of yeburn below which no BURN co-processing is considered.

name

number

type

default

unit

yelimb

417

float

0.497

-

Use this parameter in conjunction with netmax (p 240).

New In Version 16.3.0.

bmasslow

Mass coordinate below which no BURN co-processing is considered.

name

number

type

default

unit

bmasslow

419

float

-1.e+99

-

This parameter is automatically changed (increased only) if a zone reaches a Y_{\mathrm{e}} value below yelimb (p 417) (in the APPROX network) or the network number in the APPROX network rises above netmax (p 240). It is then set to just below the upper edger (in interior mass coordinate) of the cell.

New In Version 16.4.0.

netmin

Minimum APPROX network number until which BURN coprocessing is followed.

name

number

type

default

unit

netmin

429

integer

1

-

This is useful in combination with iburnye (p 357) so that BURN is still active when switching to QSE.

New In Version 16.18.0.

ibwarn

Set BURN date warning messages.

name

number

type

default

unit

ibwarn

485

integer

1

-

value

result

0

suppress warning messages

2

show warning messages for bad rates in subroutine rateb

New In Version 16.59.0.

BURN full Processing

New In Version 16.24.0.

lburn

Substitute BURN network for APPROX network (including energy generation, \bar{A}, \bar{Z}, \ldots) when set to 1.

name

number

type

default

unit

lburn

434

integer

0

-

Abundances are mapped to APPROX abundances for plot/edit purposes only.

New In Version 16.24.0.

lbbkup

This parameter regulates the behaviour of lburn (p 434).

name

number

type

default

unit

lbbkup

435

integer

2

-

value

result

0

allow backups in BURN, but end KEPLER if it encounters “excess negative abundance BURN backups”. (o d behaviour)

1

enforce only one BURN inversion cycle. If there is a backup in BURN when using lburn (p 434), the cycle will encounter a backup.

2

allows backups in BURN but will generate a cycle backup if the maximum number of “negative abundance BURN backups” is exceeded.

New In Version 16.24.0.

Changed In Version 16.79.0: Since lbbkup (p 435) = 2 does not seem to cause problems, this has been set as the new default value.

BURN Physics Parameters

mazful

Use Fuller et. al.’s weak rates in the BURN coprocessor if mazful (p 265) = 1, otherwise use the old rates of Mazurek and Hansen.

name

number

type

default

unit

mazful

265

integer

1

-

taunu

Time scale for the neutrino pulse considered by the BURN coprocessor in calculating neutrino-induced nucleosynthesis after core collapse.

name

number

type

default

unit

taunu

286

integer

0

sec

enu53

Total energy for the neutrino pulse considered by the BURN coprocessor in calculating neutrino- induced nucleosynthesis after core collapse.

name

number

type

default

unit

enu53

287

float

3.

1.e+53 erg

tmunu

Temperature of the \mu and \tau neutrinos in the neutrino pulse considered by the BURN coprocessor in calculating neutrino- induced nucleosynthesis after core collapse.

name

number

type

default

unit

tmunu

288

float

8.

MeV

tenu

Temperature of the electron neutrinos in the neutrino pulse considered by the BURN coprocessor in calculating neutrino-induced nucleosynthesis after core collapse.

name

number

type

default

unit

tenu

289

float

4.

MeV

tenubar

Electron anti-neutrino temperature for core collapse neutrino flux.

name

number

type

default

unit

tenubar

446

float

-1.

MeV

Use tenu (p 289) instead if tenubar (p 446) is negative.

New In Version 16.32.0.

ivspecl

Version of the special rate set to use.

name

number

type

default

unit

ivspecl

421

integer

0

-

Currently:

value

result

0

use lower limit rate set (as used by Hoffman et al. 2000)

1

use the NACRE rate set

2

use the standard rate set plus the upper bound of $^{22}\mathrm{Ne}$(\alpha,n) $^{22}\mathrm{Ne}$ (\alpha, \gamma) (constant 7 % BR) as determined by Wischer (Aug 2000).

3

use the NACRE rate set plus the upper bound of $^{22}\mathrm{Ne}$(\alpha,n) determined by Rayet et al. (2000).

4

use the standard rate set plus the CF88 $^{22}\mathrm{Ne}$(\alpha, \gamma) and $^{22}\mathrm{Ne}$(\alpha,n) rates.

6

use the standard rate set plus the $^{22}\mathrm{Ne}$(\alpha,n) rate from Jaeger et al. (2001) and the $^{22}\mathrm{Ne}$(\alpha, \gamma) rate lower limit from Kaepeller, i.e. dropping the 633 keV resonance, and moving the 828 keV resonance to 832 keV with a strength of 118 meV.

8

same as 6, but use the high limit $^{22}\mathrm{Ne}$(\alpha,n) rate of Jaeger et al. (2001).

10

is same as 6, but uses the low limit $^{22}\mathrm{Ne}$(\alpha,n) rate of Jaeger et al. (2001).

New In Version 16.8.0.

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

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.

lowamul

Minimum mass number for which weak rates are modified.

name

number

type

default

unit

lowamul

463

integer

0

-

New In Version 16.41.0.

pdmult

Multiplier on positron decay/electron capture rate for lowamul (p 463) \leq ihwamul (p 466).

name

number

type

default

unit

pdmult

464

float

1.

-

New In Version 16.41.0.

edmult

Multiplier on electron decay rate for lowamul (p 463) \leq ihwamul (p 466).

name

number

type

default

unit

edmult

465

float

1.

-

New In Version 16.41.0.

ihwamul

Maximum mass number for which weak rates are modified.

name

number

type

default

unit

ihwamul

466

integer

0

-

New In Version 16.42.0.

tweakmin

Minimum temperature for weak rates.

name

number

type

default

unit

tweakmin

479

float

0.5

1.e+9 K

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

New In Version 16.53.0.

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.

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.

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.

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.

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.

BURN Coprocessing Zonal Burn Control Parameters

ileqs

Flag to switch on sparse matrix solver.

name

number

type

default

unit

ileqs

258

integer

1

-

value

result

0

on

1

off

Changed In Version 12.0.0.

Note

this number used to be occupied by parameter iratstop (p 258) with the description:

Pause while updating zone IRATSTOP if IRATSTOP > 0.
Type <return> to continue.

delchi

Maximum desired fractional change of an isotopic abundance used in determining the zonal timestep used in the BURN coprocessor.

name

number

type

default

unit

delchi

247

float

0.15

-

chimin

Minimum isotopic abundance that affects the calculation of the zonal timestep in the BURN coprocessor.

name

number

type

default

unit

chimin

246

float

1.e-6

mol/g

al26mult

Decrease the abundance threshold for Al26 to affect the BURN coprocessor zonal timestep from chimin (p 246) to chimin (p 246)/ al26mult (p 266).

name

number

type

default

unit

al26mult

266

float

100.

-

fdtn

Maximum factor by which the zonal timestep in the BURN coprocessor can be increased in one zonal cycle.

name

number

type

default

unit

fdtn

248

float

2.

-

nzro

Set newly calculated negative BURN isotope abundances to 0. if nzro (p 253) \ne 0.

name

number

type

default

unit

nzro

253

integer

1

-

amaglim

Minimum absolute magnitude of a BURN matrix element for which Gauss-Jordan elimination is carried out in solving for changes in isotopic abundances.

name

number

type

default

unit

amaglim

254

float

0.

-

ninv

Total number of BURN-coprocessor matrix inversions so far (internally incremented).

name

number

type

default

unit

ninv

255

integer

0

-

dtbkup

Back up to the previous zonal cycle in the BURN coprocessor if the new zonal timestep is less than dtbkup (p 249) times the previous timestep.

name

number

type

default

unit

dtbkup

249

float

0.5

-

bkupmass

Minimum absolute magnitude ofa negative isotopic abundance (except of protons) that can cause a zonal backup in the BURN coprocessor.

name

number

type

default

unit

bkupmass

261

float

1.e-13

mol/g

bkupdiv

Factor by which to reduce the BURN coprocessor zonal timestep when a negative isotopic abundance backup occurs.

name

number

type

default

unit

bkupdiv

260

float

10.

-

bkupmp

Minimum absolute magnitude of a negative proton abundance that can cause a zonal backup in the BURN coprocessor.

name

number

type

default

unit

bkupmp

262

float

1.e-19

mol/g

nbkupmax

Maximum number of consecutive negative isotopic abundance backups allowed in the BURN coprocessor before quitting.

name

number

type

default

unit

nbkupmax

263

integer

10

-

nbkup

Total number of BURN-coprocessor backups so far (internally incremented).

name

number

type

default

unit

nbkup

256

integer

0

-

negbkup

Cumulative number of BURN coprocessor backups due to encountering negative isotopic abundances (incremented internally).

name

number

type

default

unit

negbkup

259

integer

0

-

ntty

FORTRAN I/O unit number for zburn messages sent to the user’s terminal.

name

number

type

default

unit

ntty

257

integer

6

-

irecb

Record maximum abundances in BURN network (and save in the restart dumps if set to 1.

name

number

type

default

unit

irecb

418

integer

0

-

See also new plots and terminal commands. XXX

New In Version 16.4.0.

Neutrino Deposition Parameters

jshell0

Innermost zone in which there is neutrino deposition.

name

number

type

default

unit

jshell0

93

integer

1

-

jshell1

Outermost zone in which there is neutrino deposition.

name

number

type

default

unit

jshell1

94

integer

1000

-

eexplode

Total neutrino deposition energy.

name

number

type

default

unit

eexplode

95

float

0.

erg

texplode

Time of neutrino deposition.

name

number

type

default

unit

texplode

96

float

1.e+99

sec

tauexp

Time scale for neutrino deposition.

name

number

type

default

unit

tauexp

97

float

0.01

sec

p0core

Artificial neutrino core pressure parameter.

name

number

type

default

unit

p0core

98

float

0.

cgs

The artificial neutrino core pressure is given by:

pcore = p0core (p 98) * d**d0power (p 100) * exp(-d0core (p 99) / D),

where d is the density in g/cc, pcore is in erg/cc, and p0core (p 98) is in appropriate cgs units.

d0core

Core density cutoff.

name

number

type

default

unit

d0core

99

float

3.e+11

g/cc

d0power

Core pressure density dependence exponent.

name

number

type

default

unit

d0power

100

float

1.

-

General Rezoning Parameters

izonef

General rezoning flag.

name

number

type

default

unit

izonef

86

integer

1

-

value

result

\le0

no rezoning (including dezoning)

1

normal rezoning

2

rezoning with before and after edits

3

stop after hydrostatic adzoning

idzonef

Dezoning Flags.

name

number

type

default

unit

idzonef

87

integer

1

-

flag

result

1

enable dezoning

2

write edits

4

exit on failure

Changed In Version 16.33.0.

Note

Used to be

value

result

\le0

no dezoning

1

normal dezoning

2

dezoning with before and after edits

3

dezone, edit, then stop

Data files from earlier version are translated in subroutine restart as follows

old

new

2

3

3

7

else

unchanged

izonezms

Reset the value of izonef (p 86) to izonezms (p 309) at the time specified by timezms (p 308).

name

number

type

default

unit

izonezms

309

integer

1

-

New In Version 5.0.0.

Main entry:

Parameter-Change Parameters

jmmin

Minimum number of zones allowed after dezoning.

name

number

type

default

unit

jmmin

85

integer

10

-

irzopt

Rezoning Option Flag.

name

number

type

default

unit

irzopt

216

integer

0

-

value

result

\le0

Normal rezoning.

1, \ge3

Modify the density gradient considered in adzoning by the factor (\bar{Z}+1)/\bar{A} in order to suppress runaway adzoning of the density discontinuities that sometimes form at composition interfaces (especially H/He). Note that for a non-degenerate, perfect gas this is equivalent to considering the gradient in the matter pressure instead of in the density when adzoning. Dezoning is not affected.

\ge2

Don’t adzone across the boundaries of fully convective regions.

See subroutine rezone.

jlcalc

Remove the inner jlcalc (p 190) zones from the problem and reset the inner boundary conditions on radius, radius0 (p 60), and mass, summ0 (p 61), but don’t change the central luminosity, xlum0 (p 62).

name

number

type

default

unit

jlcalc

190

integer

0

-

etacut

Electron degeneracy parameter, \eta, above which to use temperature interpolation in subroutine adzone.

name

number

type

default

unit

etacut

136

float

10.

-

minzone

Do not rezone the innermost minzone (p 444) zones.

name

number

type

default

unit

minzone

444

integer

1

-

The old default is to not rezone the innermost zone.

A value of minzone (p 444) = 0 allows to rezone the innermost zone.

New In Version 16.31.0.

iazonef

Flag to switch off adzoning.

name

number

type

default

unit

iazonef

452

integer

1

-

value

result

1

allow adzoning

0

disallow adzoning

New In Version 16.34.0.

maxzone

Do not rezone outermost maxzone (p 472) zones.

name

number

type

default

unit

maxzone

472

integer

0

-

The implicit default for old runs was 2, which is used when restarting an old run.

New In Version 16.50.0.

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.

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.

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.

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.

Physcial Rezoning Parameters

rnratmax

Maximum fractional radius change allowed betWeen zones before adzoning.

name

number

type

default

unit

rnratmax

76

float

0.25

-

rnratmin

Minimum fractional radius change allowed between zones before dezoning.

name

number

type

default

unit

rnratmin

77

float

0.1

-

tnratmax

Maximum fractional temperature change allowed between zones before adzoning.

name

number

type

default

unit

tnratmax

78

float

0.25

-

tnratmin

Minimum fractional temperature change allowed between zones before dezoning.

name

number

type

default

unit

tnratmin

79

float

0.1

-

dnratmax

Maximum fractional density change allowed between zones before adzoning.

name

number

type

default

unit

dnratmax

80

float

0.25

-

dnratmin

Minimum fractional density change allowed between zones before dezoning.

name

number

type

default

unit

dnratmin

81

float

0.1

-

rnmin

Minimum radius for which adzoning is considered.

name

number

type

default

unit

rnmin

82

float

1.e+99

cm

rnmax

Maximum radius for which rezoning is considered.

name

number

type

default

unit

rnmax

88

float

1.e+99

cm

tnmin

Minimum temperature for which adzoning is considered.

name

number

type

default

unit

tnmin

83

float

1.

K

dnmin

Minimum density for which adzoning is considered.

name

number

type

default

unit

dnmin

84

float

1.e-99

g/cc

abarstep

No rezoning is performed when the region under consideration contains a step in \bar{A} of more than abarstep (p 426).

name

number

type

default

unit

abarstep

426

float

1.e+99

-

New In Version 16.17.0.

zbarstep

No rezoning is performed when the region under consideration contains a step in \bar{Z} of more than zbarstep (p 427).

name

number

type

default

unit

zbarstep

427

float

1.e+99

-

New In Version 16.17.0.

xmustep

No rezoning is performed when the region under consideration contains a step in the mean molecular weight, \mu=\bar{A}/(1+\bar{Z}) of more than xmustep (p 428).

name

number

type

default

unit

xmustep

428

float

1.e+99

-

New In Version 16.17.0.

zonemmax

Do not dezone zones bigger than zonemmax (p 445).

name

number

type

default

unit

zonemmax

445

float

1.e+99

-

New In Version 16.32.0.

ddmin

Minimum density for dezoning.

name

number

type

default

unit

ddmin

451

float

-1.

-

New In Version 16.34.0.

zonermin

Do not adzone a pair of zones with thickness below zonermin (p 457).

name

number

type

default

unit

zonermin

457

float

-1.

-

New In Version 16.37.0.

Usefule for XRB simulations.

zonermax

Do not dezone zones with thickness greater than zonermax (p 458).

name

number

type

default

unit

zonermax

458

float

1.e+99

-

New In Version 16.37.0.

Useful for XRB simulations.

Mass-Fraction-Based Rezoning Parameters

fracrz0

See fracrz1 (p 138) and fmax0 (p 150).

name

number

type

default

unit

fracrz0

193

float

-1.

-

fracrz1

Multiplier in the effective values of the density, temperature, and radius gradients used to determine the necessity for adzoning or dezoning.

name

number

type

default

unit

fracrz1

138

float

1.

-

value

result

fracm \le fracrz0 (p 193)

rzmultm (p 194)

fracrz0 (p 193) < fracm \le fracrz1 (p 138)

rzmult0 (p 140)

fracrz1 (p 138) < fracm \le fracrz2 (p 139)

rzmult1 (p 141)

fracm > fracrz2 (p 139)

rzmult2 (p 142)

Here fracm is the cumulative mass fraction measured from the center of the star

See also tcorefac (p 104) and fmax0 (p 150).

fracrz2

See fracrz1 (p 138) and fmax0 (p 150).

name

number

type

default

unit

fracrz2

139

float

1.

-

rzmultm

See fracrz1 (p 138).

name

number

type

default

unit

rzmultm

194

float

1.

-

rzmult0

See fracrz1 (p 138).

name

number

type

default

unit

rzmult0

140

float

1.

-

rzmult1

See fracrz1 (p 138).

name

number

type

default

unit

rzmult1

141

float

1.

-

rzmult2

See fracrz1 (p 138).

name

number

type

default

unit

rzmult2

142

float

1.

-

fmaxm

See fmax0 (p 150).

name

number

type

default

unit

fmaxm

195

float

1.

-

fmax0

Adzone mass fraction parameter.

name

number

type

default

unit

fmax0

150

float

1.

-

Always adzone if the total mass fraction of any pair of zones exceeds:

value

result

fracm \le fracrz0 (p 193)

fmaxm (p 195)

fracrz0 (p 193) < fracm \le fracrz1 (p 138)

fmax0 (p 150)

fracrz1 (p 138) < fracm \le fracrz2 (p 139)

fmax1 (p 151)

fracm > fracrz2 (p 139)

fmax2 (p 152)

Here fracm is the cumulative mass fraction measured from the center of the star

fmax1

See fmax0 (p 150).

name

number

type

default

unit

fmax1

151

float

1.

-

fmax2

See fmax0 (p 150).

name

number

type

default

unit

fmax2

152

float

1.

-

zonemmin

Minimum mass that a pair of zone may have and still be allowed to be adzoned.

name

number

type

default

unit

zonemmin

336

float

1.e-99

g

New In Version 11.0.0.

fmaxmcig

Reset the value of fmaxm (p 195) to fmaxmcig (p 313) when the central temperature specified by tempcig (p 311) is reached if fmaxmcig (p 313) > 0.

name

number

type

default

unit

fmaxmcig

313

float

1.

-

New In Version 5.0.0.

Changed In Version >15.15.0: Only reset if fmaxmcig (p 313) > 0.

Main entry:

Parameter-Change Parameters

fmax0cig

Reset the value of fmax0 (p 150) to fmax0cig (p 314) when the central temperature specified by tempcig (p 311) is reached if fmax0cig (p 314) > 0.

name

number

type

default

unit

fmax0cig

314

float

1.

-

New In Version 5.0.0.

Changed In Version >15.15.0: Only reset if fmaxmcig (p 313) > 0.

Main entry:

Parameter-Change Parameters

abarrat0

Limiting ratio for \bar{A} for rezoning.

name

number

type

default

unit

abarrat0

143

float

2.

-

The effective values of the density, radius, and temperature gradients used for rezoning are formed by multiplying the actual gradients by the factor:

case

condition

adzoning

(1. + abarratm (p 144) * abarrat0 (p 143) * abarrat) / (abarrat0 (p 143) + abarrat)

dezoning

(1. + 1.5 * abarratm (p 144) * abarrat0 (p 143) * abarrat) / (abarrat0 (p 143) + abarrat)

where abarrat is the average relative \bar{A} change between adjacent zones. (XXX get definition from code)

Do this for adzoning only if the sum of the masses in the involved zones divided by the total mass of the star exceeds fracmlim (p 145).

abarratm

See abarrat0 (p 143).

name

number

type

default

unit

abarratm

144

float

1.3

-

fracmlim

See abarrat0 (p 143).

name

number

type

default

unit

fracmlim

145

float

0.01

-

tcorefac

Increase the rezoner’s sensitivity to temperature gradients by a factor of tcorefac (p 104) in the region where fracm, the cumulative mass fraction measured from the center of the star, is less than or equal fracrz1 (p 138).

name

number

type

default

unit

tcorefac

104

float

1.

-

zoneymax

Do not dezone zones with xm (i)/ym (i) > zoneymax (p 513).

name

number

type

default

unit

zoneymax

513

float

1.e+99

-

New In Version 16.79.0.

Mass-Loss-Connected Rezoning Parameters

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.

Other entry:

Boundary Condition Parameters

rlossmin

Minimum radius for which to apply vloss (p 271).

name

number

type

default

unit

rlossmin

436

float

1.

-

New In Version 16.25.0.

nsurfz

If nsurfz (p 217) > 0 and izonef (p 86) > 0, maintain a logarithmic ramp in zonal mass of the NSURFZ zones at the surface of the star, where fracsz0 (p 218) is twice the desired mass-fraction of the surface zone and fracsz1 (p 219) is twice the desired mass-fraction of the nsurfz (p 217)th zone from the surface.

name

number

type

default

unit

nsurfz

217

integer

-10

-

Otherwise, nsurfz (p 217) has no effect.

See subroutine rezone.

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Other entry:

Mass Loss Parameters

fracsz0

Inner surface zoning parameter.

name

number

type

default

unit

fracsz0

218

float

1.

-

See subroutine rezone and the discussion under nsurfz (p 217).

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Other entry:

Mass Loss Parameters

fracsz1

Outer surface zoning parameter.

name

number

type

default

unit

fracsz1

219

float

1.

-

See subroutine rezone and the discussion under nsurfz (p 217).

Warning

This is an obsolescent parameter involving an old mass-loss scheme and should not be used without a careful check of the detailed coding in rezone.

Deprecated Since Version <16.0.0.

Other entry:

Mass Loss Parameters

fracdez

Dezone the mass-losing zone if its mass drops below fracdez (p 223) times the average mass of the zones on either side of it.

name

number

type

default

unit

fracdez

223

float

0.5

-

Other entry:

Mass Loss Parameters

Accretion-Connected Rezoning Parameters

fracadz

Maximum ratio of mass accreting zone before it is forced to adzone.

name

number

type

default

unit

fracadz

518

float

2.

-

New In Version 16.82.0.

Main entry:

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

Main entry:

Decretion Parameters

jmdec

Zone from which to remove mass in decretion.

name

number

type

default

unit

jmdec

532

integer

1

-

New In Version 16.86.0.

Main entry:

Decretion Parameters

Decretion Parameters

Decretion is removal of mass from the bottom of the simulation domain. Usually used in combination with accretion.

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.

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.

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.

Other entry:

Accretion-Connected Rezoning Parameters

jmdec

Zone from which to remove mass in decretion.

name

number

type

default

unit

jmdec

532

integer

1

-

New In Version 16.86.0.

Other entry:

Accretion-Connected Rezoning Parameters

Numerics Parameters

cenu

Velocity centring parameter (Range: 0.5 - 1.).

name

number

type

default

unit

cenu

48

float

1.

-

value

result

0.5

exact energy conservation

1.

greatest stability

Warning

Actually, KEPLER only behaves reasonably if cenu (p 48) = 1., so the user should not change the default value without careful study and a willingness to bear full responsibility for whatever nonsense may result.

xl0limf

Multiplier on limiting flux in radiation flux limiter.

name

number

type

default

unit

xl0limf

392

float

4.

-

New In Version 15.20.0.

xl0limk

Limiting flux multiplied by.

name

number

type

default

unit

xl0limk

393

float

0.

-

\exp\left\{\frac{4\pi\;\mathtt{rn}^2\;\mathtt{xl0limk}}{\kappa\;\mathtt{xm}}\right\}

llimout

Limit to radiative flux of outer zone only if set to 1 (old behaviour), otherwise limit to flux of the hotter zone (upper or lower).

name

number

type

default

unit

llimout

394

integer

1

-

New In Version 15.20.0.

Miscellaneous Parameters

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.

Obsolete Parameters

igridm

Obsolete.

name

number

type

default

unit

igridm

117

integer

498

-

igridv

Obsolete.

name

number

type

default

unit

igridv

118

integer

496

-

ivplot

Obsolete.

name

number

type

default

unit

ivplot

129

integer

1

-

mlcompf

Obsolete.

name

number

type

default

unit

mlcompf

226

integer

0

-

edmassl

Obsolete.

name

number

type

default

unit

edmassl

242

float

0.0001

-

widthtd

Obsolete.

name

number

type

default

unit

widthtd

295

float

60.

-

swmult

Obsolete.

name

number

type

default

unit

swmult

361

float

0.

-

Not clear what this parameter ever did. .. versionadded:: 14.50

Deprecated Since Version <15.0.0.

Device-Control Graphics Parameters

itvstart

Graphics device control parameter.

name

number

type

default

unit

itvstart

127

integer

0

-

value

result

-1

stop the X-window graphics display and reset itvstart (p 127) to 0

0

no graphics processes are active.

1

means start an X-window graphics display and reset itvstart (p 127) to 2.

2

keep the X-window display open and display graphs and timeplots as requested. This value is internally set.

3

initialize a portrait-orientation PostScript file and reset itvstart (p 127) to 5.

4

initialize a landscape-orientation PostScript file and reset itvstart (p 127) to 5.

5

keep the PostScript file open for further input (under development).

ipapsize

Paper dimensions in points (inch/72).

name

number

type

default

unit

ipapsize

384

integer

6120792

-

First 4 digits give width, last 4 digits give height. A value of 0 selects DIN A4 paper size. The default value is letter paper size.

New In Version 15.9.0.

npixedit

Graphics edits to the monitor are made every npixedit (p 64) KEPLER cycles (if itvstart (p 127) > 0).

name

number

type

default

unit

npixedit

64

integer

50

-

Other entry:

General Edit Control Parameters

iwinsize

Size of graphics window to be created in the form xxxxyyyy.

name

number

type

default

unit

iwinsize

42

integer

10240750

-

value

result

xxxx

window width (pixels)

yyyy

window height (pixels)

Note

Be sure to include leading zeros if yyyy is less than 4 digits.

iwinloc

Location of the top-left-hand corner of the graphics window relative to top-left corner of screen, given in the form xxxxyyyy.

name

number

type

default

unit

iwinloc

45

integer

0

-

value

result

xxxx

horizontal offset (pixels)

yyyy

vertical offset (pixels)

Note

Be sure to include leading zeros if yyyy is less than 4 digits.

ibackgnd

Graphics window background color is white if ibackgnd (p 296) < 0 and black if ibackgnd (p 296) < 0.

name

number

type

default

unit

ibackgnd

296

integer

-1

-

The foreground color is always the inverse of the background color.

ipdtmin

Minimum time between plot outputs in seconds.

name

number

type

default

unit

ipdtmin

497

integer

0

-

This is useful to limit output in interactive mode, especially on remote hosts so that the run is not slowed down by the graphical output.

New In Version 16.72.0.

Plot-Type Graphics Parameter

ipixtype

Graphics picture-type control parameter:.

name

number

type

default

unit

ipixtype

113

integer

31

-

value

result

<0

graphics window is not updated, but is still open.

0

only header info is displayed.

1

thermodynamics (TD) graph only

2

velocity graph only

3

mass-fraction graph only

4

entropy graph only

5

density-temperature graph only

6

isotopic mass-fraction graph (use the setiso command first to determine the ions to be displayed).

7

angular velocity (\omega), specific angular momentum (j) and total diffusion coefficient for mixing of chemical species.

8

angular velocity (\omega), specific angular momentum (j), contributions of the different rotationally induced mixing coefficients and the total diffusion coefficient for mixing of chemical species.

9

production factor/yield for the different isotopes from the BURN co-processing network. See parameters ipromin (p 396) through proymax (p 403) for details of the plot adjustment.

10-99

Two graphs are displayed in split-screen fashion with the type of the top graph determined by the value of the first digit and the type of the second graph determined by the value of second digit as specified above.

100-

Three graphs are displayed, two small, one big

1000-

Four graphs are displayed

10000-

Three graphs are displayed, below each other, the last 2 digits are ignored and should be zeros.

Changed In Version 15.22.0: Added abundance plot number 9

Changed In Version 15.2.0: Added diffusion and rotation plots number 7 and 8.

iplotb

Control isotope/network used in abundance plots, Plot 3.

name

number

type

default

unit

iplotb

443

integer

0

-

value

result

0

use APPROX/QSE/NSE abundances

1

only plot BURN abundances in the APPROX regime

2

plot BURN abundances everywhere where BURN is used, i.e., above bmasslow (p 419)

3

plot BURN abundances everywhere.

Additionally, data can be mapped to isobars or elements by adding the following values:

value

result

10

map to elements

20

map to isobars

New In Version 16.30.0.

Radial Coordinate-Control Graphics 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.

igridt

Grid choice for the radial coordinate (irtype (p 132) = 1).

name

number

type

default

unit

igridt

116

integer

370

-

value

result

\le10

linear in radius (radius)

>10

the radial coordinate will be log10 (radius)

jp0

Innermost zone to plot.

name

number

type

default

unit

jp0

119

integer

1

-

jp1

Outermost zone to plot is jm (outermost zone) - jp1 (p 120).

name

number

type

default

unit

jp1

120

integer

0

-

rpmino

Minimum radius plotted when jp0 (p 119) < 0.

name

number

type

default

unit

rpmino

121

float

1.e+7

cm

rpmaxo

Maximum radius plotted when jp1 (p 120) < 0.

name

number

type

default

unit

rpmaxo

122

float

1.e+14

cm

yplotmin

Minimum fractional mass coordinate (q) plotted (fraction of total mass).

name

number

type

default

unit

yplotmin

134

float

0.

-

yplotmax

Maximum fractional mass coordinate (q) plotted (fraction of total mass).

name

number

type

default

unit

yplotmax

135

float

1.

-

Thermodynamics-Graph Parameters

ymintd

Lower bound of thermodynamics graph ordinate shall be no greater than ymintd (p 123).

name

number

type

default

unit

ymintd

123

float

1.

g/cc

ymaxtd

Upper bound of thermodynamics graph ordinate shall be no less than ymaxtd (p 124).

name

number

type

default

unit

ymaxtd

124

float

1.e+8

g/cc

sscalem

Energy generation rate graph scale multiplier in the TD graph.

name

number

type

default

unit

sscalem

125

float

0.001

-

pscalem

Pressure graph scale multiplier in the TD graph.

name

number

type

default

unit

pscalem

126

float

0.1

-

vscalem

Velocity graph scale multiplier in the TD graph.

name

number

type

default

unit

vscalem

130

float

1.e-5

-

rscalem

Radius graph scale multiplier in the TD graph.

name

number

type

default

unit

rscalem

131

float

1.e-5

-

tscalem

Characteristic temperature for choosing the location of the temperature plotting grid in Thermodynamics (TD) graph.

name

number

type

default

unit

tscalem

115

float

1.e+7

K

Equivalent to the temperature plotted at the same ordinate value as a density of 1 g/cc.

convord

Ordinate value at which to plot convection sentinels in the TD graph.

name

number

type

default

unit

convord

133

float

3.

g/cc

Velocity And Abundance Graph Parameters

vlimset

The ordinate bounds of the velocity graph are \pm vlimset (p 191) if vlimset (p 191) > 0. Otherwise the ordinate bounds are rescaled automatically. :unit: cm/s.

name

number

type

default

unit

vlimset

191

float

-1.

-

abunlim

Least elemental mass fraction plotted or listed in a terminal ion edit.

name

number

type

default

unit

abunlim

128

float

0.001

-

Main entry:

General Edit Control Parameters

abunminb

Lower mass-fraction limit of the isotopic abundance plot.

name

number

type

default

unit

abunminb

316

float

0.0001

-

New In Version 7.0.0.

abunmaxb

Upper mass-fraction limit of the isotopic abundance plot.

name

number

type

default

unit

abunmaxb

317

float

1.

-

New In Version 7.0.0.

numiso

Number of BURN isotopes to be plotted, starting from the first one listed by the most recent setiso command.

name

number

type

default

unit

numiso

318

integer

0

-

Normally numiso (p 318) is set to the total number of isotopes listed in the setiso command at the time that command is processed and does not need to be set by the user.

New In Version 7.0.0.

Abundance Plot Parameters

ipromin

Minimum zone for production factor/yield plot.

name

number

type

default

unit

ipromin

396

integer

1

-

New In Version 15.22.0.

ipromax

Maximum zone for production factor/yield plot.

name

number

type

default

unit

ipromax

397

integer

99999

-

New In Version 15.22.0.

iprownd

Take into account wind when computing production factors/yields.

name

number

type

default

unit

iprownd

398

integer

1

-

value

result

0

off

1

on

New In Version 15.22.0.

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.

minapro

Minimum mass number for production factor/yield plot; automatic determination if set -99.

name

number

type

default

unit

minapro

400

integer

-1000

-

New In Version 15.22.0.

maxapro

Maximum mass number for production factor/yield plot; automatic determination if set LE -99.

name

number

type

default

unit

maxapro

401

integer

-1000

-

New In Version 15.22.0.

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.

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.

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.

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.

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.

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.

Graphics Labeling Parameters

charsizg

Graphics character size for grid labels (relative to MONGO’s default character size).

name

number

type

default

unit

charsizg

291

float

1.

-

charsizc

Graphics character size for curve labels (relative to MONGO’s default character size).

name

number

type

default

unit

charsizc

292

float

0.85

-

charsizz

Graphics character size for zone sentinels (relative to MONGO’s default character size).

name

number

type

default

unit

charsizz

293

float

0.85

-

charsizh

Graphics character size for header info (relative to MONGO’s default character size).

name

number

type

default

unit

charsizh

294

float

1.

-

nplotsym

Label each curve with nplotsym (p 114) character symbols.

name

number

type

default

unit

nplotsym

114

integer

8

-

fracneut

If the semi convective test parameter, W, is < 0. but greater than - fracneut (p 59) * abs(log(T1/T0)), then the zonal interface is flagged convectively neutral (“NEUT” or “,”).

name

number

type

default

unit

fracneut

59

float

0.05

-

See subroutine update.

Main entry:

Convection Parameters

Post-Processor Graphics Parameters

Deprecated Since Version <15.0.0: No longer implemented.

idtmaxl

Maximum number of post-processor dump cycles beyond the currently-specified dump cycle (LTIME) that readq will search to try to get values for each point in the ‘advanced’ grid formed from dump variable values at or beyond ltime.

name

number

type

default

unit

idtmaxl

301

integer

40

-

In plotmap, idtmaxl (p 301) is used as a flag for the plot and interpolation mode to be used:

value

result

0

strips of retarded-value rectangles are plotted, based on the reconstructed grids (best for very discontinuous variables, esp. convect).

1

forward and backward facing triangles are plotted for each dump point. These triangles have a uniform color determined by the value at their most retarded vertex (best for moderately discontinuous variables, such as abundances).

>1

forward and backward triangles are plotted for each dump point which are Gouraud-shaded to interpolate between the variable values at each corner (fastest and smoothest for continuous variables, worst for discontinuous variables).

idtlook

Default number of post-processor dump cycles between LOOK plots or prints or reconstructed TIMEMAP grids.

name

number

type

default

unit

idtlook

302

integer

10

-

vminmap

Minimum value of the time map variable to be mapped.

name

number

type

default

unit

vminmap

328

float

1.e+99

-

If vminmap (p 328) > 1.e+98, then the actual minimum value of the current variable is used as the map limit, except as limited by vratmap (p 330).

New In Version 10.0.0.

vmaxmap

Maximum value of the timemap variable to be mapped.

name

number

type

default

unit

vmaxmap

329

float

-1.e+99

-

If vmaxmap (p 329) < -1.e+98, then the actual maximum value of the current variable is used as the map limit.

New In Version 10.0.0.

vratmap

Minimum ratio of the minimum timemap variable limit to the maximum timemap variable limit in the case when the actual minimum value of the current timemap variable would otherwise be used as the minimum timemap limit.

name

number

type

default

unit

vratmap

330

float

1.e-99

-

New In Version 10.0.0.

Time-Coordinate Graphics Parameters

Deprecated Since Version <15.0.0: No longer implemented.

maptime

Flag indicating the desired time coordinate in timeplots and timemaps.

name

number

type

default

unit

maptime

327

integer

2

-

See subroutines plot and timemap.

value

result

0

use cycle number

1

use linear time (sec)

2

use negative logarithmic time (-log (sec))

3

use positive logarithmic time (+log (sec))

Note

The time coordinate is calculated relative to timeref (p 319) + tosetref (p 320).

timecmin

Minimum value of the time-coordinate to be plotted in timeplots and timemaps (time coordinate units, see maptime (p 327)).

name

number

type

default

unit

timecmin

321

float

0.

-

If both timecmin (p 321) = 0 and timecmax (p 322) = 0, all available time-points will be plotted.

New In Version 8.0.0.

timecmax

Maximum value of the time-coordinate to be plotted in timeplots and timemaps (time coordinate units, see maptime (p 327)).

name

number

type

default

unit

timecmax

322

float

0.

-

If both timecmin (p 321) = 0 and timecmax (p 322) = 0, all available time-points will be plotted.

New In Version 8.0.0.

timeref

Reference time used in calculating the time coordinate in timeplots and timemaps.

name

number

type

default

unit

timeref

319

float

-1.e+99

sec

If timeref (p 319) < -1.e+98, then a time 10 timesteps beyond the last timepoint is used in its place.

New In Version 8.0.0.

tosetref

Reference offset time used in calculating the time-coordinate for timeplots and timemaps.

name

number

type

default

unit

tosetref

320

float

0.

sec

If timeref (p 319) < -1.e+98, then the value of toffset (p 315) prevailing for the last timestep is used for tosetref (p 320).

New In Version 8.0.0.

Physics Parameters

hstatm

Multiplier on the inertial terms in the momentum balance equation.

name

number

type

default

unit

hstatm

43

float

1.

-

Nominally forces hydrostatic equilibrium for for hstatm (p 43) = 0., but may result in convergence and consistency problems.

Warning

This parameter should be kept set to 1. (normal hydrodynamics) unless the user is prepared to make a very careful study of its actual effects (see subroutines regess and update).

hstatxm

Interior mass coordinate above which hydrostatic stratification is assumed.

name

number

type

default

unit

hstatxm

385

float

1.e+99

g

New In Version 15.10.0.

hstatym

Surface mass coordinate above which hydrostatic stratification is assumed.

name

number

type

default

unit

hstatym

386

float

-1.e+99

g

New In Version 15.11.0.

dynfac

Multiplier on dynamic time-scale used to determine whether to treat problem (zones) as “dynamic” or “static” in subroutine update.

name

number

type

default

unit

dynfac

453

float

1.

-

A value of 0. means that all zones are always treated hydrostatic.

New In Version 16.35.0.

relmult

Multiplier on GR corrections.

name

number

type

default

unit

relmult

358

float

0.

-

GR is turned off if set to 0..

Typical use is to set it to 1. to switch GR corrections on.

New In Version 14.0.0.

geemult

Multiplier on gravitational constant.

name

number

type

default

unit

geemult

359

float

1.

-

New In Version 14.50.0.

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

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

use old nu loss (old3)

4

use old (1997) nu loss and ME estimates (bad)

8

use old (1975) Iben electron conductivity. The revised version fixes a factor 2

16

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

32

do not use fix in \nu loss energies for APPROX PP chains

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.

ifallbk

Activate fallback treatment.

name

number

type

default

unit

ifallbk

486

integer

0

-

value

result

0

fallback disabled (default)

>0

switch on fallback

1

simple outflow condition

2

pressure matching (experimental)

New In Version 16.61.0.

xnumu12

Neutrino magnetic moment in units of 10^{-12}\mu_{\mathrm{B}}.

name

number

type

default

unit

xnumu12

487

float

0.

-

Changes neutrino loss rates (only plasma neutrinos for now).

New In Version 16.62.0.

axion

Axion mass eV.

name

number

type

default

unit

axion

489

float

0.

-

Add energy loss similar to neutrino loss. The loss rate is proportional to the square of axion (p 489).

New In Version 16.65.0.

tnumin

Minimum temperature for neutrino losses if APPROX and BURN are not active.

name

number

type

default

unit

tnumin

522

float

1.e+7

-

New In Version 16.84.0.

Other entry:

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

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.

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.

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.

psurfmlt

Multiplier atmosphere boundary pressure.

name

number

type

default

unit

psurfmlt

575

float

1.

-

See isurf (p 523)

New In Version 17.9.0.

X-ray Burst Parameters

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.

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.

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.

Supernova Parameters

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.

timex0

Time at which any ni56 present in low temperature regions (as determined by dypmin (p 89) and tnucmin (p 65)) of the star is assumed to have been produced and begun to decay, first to $^{56}\mathrm{Co}$ and then to $^{56}\mathrm{Fe}$.

name

number

type

default

unit

timex0

38

float

-1.e+99

sec

If timex0 (p 38) \ge -1.e+50 and the zonal ni56 abundance, yni \ge 3.e-5, then the nuclear energy generation is take equal to that generated by an initial ni56 abundance yni after having decayed for a time interval time (p 2) - timex0 (p 38). This can be switched off using nidecay (p 557).

Note

The value of yni in the abundance array is not changed by this “decay”, and always represents the initial amount produced.

Warning

Do not set timex0 (p 38) > time (p 2).

xkapgam

Assumed effective opacity for the deposition of gamma ray energy from the radioactive decay of $^{56}\mathrm{Ni}$ and $^{56}\mathrm{Co}$, as controlled by timex0 (p 38).

name

number

type

default

unit

xkapgam

341

float

0.054

cm**2/g

New In Version 12.0.0.

egamp

Dimensionless correction factor used in calculating the escape of gamma rays from the radioactive decay of Ni56 and $^{56}\mathrm{Co}$, as controlled by timex0 (p 38).

name

number

type

default

unit

egamp

342

float

0.6

-

See subroutine sdot for details.

New In Version 12.0.0.

GRB / Magnetar Simulation Parameters

grbparm

Energy deposition for GRB modelling.

name

number

type

default

unit

grbparm

360

float

0.

?

The source code says “the following is a kludge for grb modelling only. Do not use any other place. Using this with nuclear burning on will double count neutrino losses.” It also sets xk1=xkmin for zone jm-1.

New In Version 14.50.0.

pulse051

Initial pulsar rotational energy.

name

number

type

default

unit

pulse051

515

float

0.

B

Pulsar energy is deposited in the innermost nzpuls (p 517) zones at a rate

L_{\mathrm{pulsar}} = 10^{49}\, B^2_{15}\,(E_{51}/20)^2

where

E_{51} = 1/((B^2_{15}\, t\, 2.5\times10^{-5})+1/E_{51,0})

B_{15} (pulsb15 (p 516)) is the pulsar magnetic field in 1.e+15 G, E_{51,0} (pulse051 (p 515)) is the initial :pulsar energy in 1.e+51 erg, and t is the time :since timex0 (p 38), i.e., math:t = ( time (p 2) - :timex0 (p 38) ).

This is derived from

E = 2\times10^{52}\,P_\mathrm{ms}^{-2},

\frac{\mathrm{d}E}{\mathrm{d}t} = 10^{49} B_{15}^2 P_\mathrm{ms}^{-4}.

Note

If set to 0. no pulsar energy deposition is implemented and Radioactive $^{56}\mathrm{Ni}$ decay is used instead.

Warning

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

New In Version 16.81.0.

pulsb15

Asymptotic pulsar magnetic field at late times.

name

number

type

default

unit

pulsb15

516

float

0.

1.e+15 G

If set to 0. no pulsar energy deposition is implemented.

See pulse051 (p 515).

New In Version 16.81.0.

nzpuls

Number of zones over which to distribute pulsar energy.

name

number

type

default

unit

nzpuls

517

integer

10

-

If set to 0 no pulsar energy deposition is implemented.

See pulse051 (p 515).

New In Version 16.81.0.

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.

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.

Nova simulation Parameters

xmixnova

Extent (in mass) of a linear composition gradient between substrate and newly accreted material.

name

number

type

default

unit

xmixnova

459

float

0.

-

The surface material is taken from compsurf/compsurfb, the substrate material from the outermost layer of the hydrogen-free core (X<10^{-5}).

Used for nova simulation with FLASH group.

Check code for details.

New In Version 16.38.0.

WIMP Parameters

wimp

WIMP mass.

name

number

type

default

unit

wimp

496

float

0.

GeV

WIMP annihilation is disabled if set to 0..

New In Version 16.71.0.

wimpsip

Spin-independent cross section of WIMPs on protons.

name

number

type

default

unit

wimpsip

502

float

1.e-43

cm**2

New In Version 16.76.0.

wimpsin

Spin-independent cross section of WIMPs on protons.

name

number

type

default

unit

wimpsin

503

float

1.e-43

cm**2

New In Version 16.76.0.

wimpsdp

Spin-dependent cross section of WIMPs on protons.

name

number

type

default

unit

wimpsdp

504

float

1.e-38

cm**2

New In Version 16.76.0.

wimpsdn

Spin-dependent cross section of WIMPs on protons.

name

number

type

default

unit

wimpsdn

505

float

1.e-38

cm**2

New In Version 16.76.0.

wimprho0

WIMP density.

name

number

type

default

unit

wimprho0

506

float

1.e+13

GeV/cc

New In Version 16.76.0.

wimpv0

WIMP velocity dispersion.

name

number

type

default

unit

wimpv0

507

float

1.e+6

cm/sec

New In Version 16.76.0.

wimpvelo

Velocity of star relative to WIMP dark matter halo.

name

number

type

default

unit

wimpvelo

508

float

0.

cm/sec

New In Version 16.76.0.

iwimpb

Network to use for WIMP cross section calculations.

name

number

type

default

unit

iwimpb

509

integer

1

-

value

result

0

APPROX abundances

1

BURN abundances

New In Version 16.76.0.

Convection Plot Binary Files

ncnvout

Write out convection plot file data (*.cnv) every ncnvout (p 376) cycles. Off when 0.

name

number

type

default

unit

ncnvout

376

integer

0

-

New In Version 15.4.0.

Other entry:

Various Files

levcnv

Number of levels per dex for .cnv output file.

name

number

type

default

unit

levcnv

447

integer

1

-

New In Version 16.33.0.

mingain

log of minimum energy generation (nuclear + neutrinos) for .cnv output file.

name

number

type

default

unit

mingain

448

integer

-1

-

New In Version 16.33.0.

minloss

log of minimum energy loss (nuclear + neutrinos) for .cnv output file.

name

number

type

default

unit

minloss

449

integer

-1

-

New In Version 16.33.0.

minnucl

log of minimum nuclear energy loss for .cnv output file.

name

number

type

default

unit

minnucl

450

integer

-1

-

New In Version 16.33.0.

minnucg

log of minimum nuclear energy generation for .cnv output file.

name

number

type

default

unit

minnucg

474

integer

-1

-

New In Version 16.52.0.

mingaind

log of minimum energy generation (nuclear + neutrinos) per cm for .cnv output file.

name

number

type

default

unit

mingaind

475

integer

21

-

New In Version 16.52.0.

minlossd

name

number

type

default

unit

minlossd

476

integer

21

-

log of minimum energy loss (nuclear + neutrinos) per cm for .cnv output file.

New In Version 16.52.0.

minnucgd

log of minimum nuclear energy generation per cm for .cnv output file.

name

number

type

default

unit

minnucgd

477

integer

21

-

New In Version 16.52.0.

minnucld

log of minimum nuclear energy loss per cm for .cnv output file. output file.

name

number

type

default

unit

minnucld

478

integer

21

-

New In Version 16.52.0.

minneug

log of minimum neutrino energy generation (deposition?) for .cnv output file.

name

number

type

default

unit

minneug

498

integer

-1

-

New In Version 16.75.0.

minneul

log of minimum neutrino energy loss (deposition?) for .cnv output file.

name

number

type

default

unit

minneul

499

integer

-1

-

New In Version 16.75.0.

minneugd

log of minimum neutrino energy generation (deposition?) per cm for .cnv output file.

name

number

type

default

unit

minneugd

500

integer

21

-

New In Version 16.75.0.

minneuld

log of minimum neutrino energy loss per cm for .cnv output file.

name

number

type

default

unit

minneuld

501

integer

21

-

New In Version 16.75.0.

nconvers

Recent version> Version of the current convection output file.

name

number

type

default

unit

nconvers

493

integer

<most

-

This is to allow compatibility of newer KEPLER versions with older runs - do not change the data file version during the run. Usually you would not want to change the value of this parameter by hand unless you really know what your are doing.

Purpose: When starting an old run with a newer version of KEPLER, it will continue to append data in the old output format.

Similar to nwndvers (p 494).

New In Version 16.68.0.

Binary Data Output Parameters

icutbin

Truncate binary output files on restart/generation.

name

number

type

default

unit

icutbin

492

integer

1

-

value

result

0

off

1

on

This is done at the end of the first time step, before new records are written to the binary output files.

Note

This should always be left at 1 unless you want to create a big mess.

New In Version 16.67.0.

Various Files

ncnvout

Write out convection plot file data (*.cnv) every ncnvout (p 376) cycles. Off when 0.

name

number

type

default

unit

ncnvout

376

integer

0

-

New In Version 15.4.0.

Main entry:

Convection Plot Binary Files

nenout

Write out total energies in file nameprob.ent every nenout cycles. Set to zero to turn off.

name

number

type

default

unit

nenout

395

integer

0

-

New In Version 15.21.0.

nenuout

Cycle frequency used to write *.enu data file.

name

number

type

default

unit

nenuout

407

integer

0

-

New In Version 15.26.0.

nstrout

Write out structure data file nameprob.str every nstrout (p 432) time steps.

name

number

type

default

unit

nstrout

432

integer

0

-

No data is written if nstrout (p 432) = 0.

New In Version 16.21.0.

lcout

Number of outer layers to be written in light curve output file, .lc.

name

number

type

default

unit

lcout

437

integer

0

-

No file is written if the value is 0.

New In Version 16.25.0.

mixout

Write out mixing file nameprob.mix every mixout (p 481) cycles.

name

number

type

default

unit

mixout

481

integer

0

-

New In Version 16.55.0.

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.

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.

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.

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.

Main entry:

Rotation Parameters

Wind Files

nwndout

Write out wind data to wind file nameprob.wnd every nwndout (p 390) cycles. Off when 0.

name

number

type

default

unit

nwndout

390

integer

0

-

New In Version 15.19.0.

nwndvers

Recent version> Version of the current wind output file.