BURN Generator Cards¶

BURN generator files must always include

a network definition (combination of net and/or netw cards),
a mixture definition (m cards), and
a grid definition (g cards or one gg card).

All other cards will be passed on to regular input processing. But in particular p cards may be useful and c cards should be used to document the file contents in comments.

BURN Generator Input File Naming

it is custom to have the filename end in bg.

Required Cards¶

net

Network Card(s).

name

parameters

net

NETNUMB ( ISOSYM )+
net 1 nt1 h1 h2 h3 he3 he4 li7 be7 b10 b11
NETNUMB

is the identification number of the network being specified. For the current version of KEPLER, only one network may be specified, and its BURN network number (NETNUMB) must be 1.

ISOSYM

is the symbol for an isotope in the network. (See the m card description for how to format these symbols). They can be specified in any order. If there are more than 10 isotopes in the network, continue on a new net card with the same BURN network number. The limits and contents of the network depends of the information currently available in the BDAT nuclear data deck stored in the bdat file (see Chapter XXX).

netw

Network Card(s), alternate form.

name

parameters

netw

NETNUMB ELSYM ( ASTART AEND )+
netw 1 h    1   3
netw 1 he   3   4
netw 1 li   6   9
netw 1 be   7   7   8  11
NETNUMB

is the identification number of the network being specified. For the current version of KEPLER, only one network may be specified, and its BURN network number (NETNUMB) must be 1 .

ELSYM

is the symbol for an element for which to add isotopes to the network. Elements can be specified in any order.

ASTART AEND

specify range of isotopes to be added for the given element.

Several ranges can be specified in the same line. If there is more than about 4 ranges, extra cards may be used. Otherwise similar to the net card.

New In Version >15.0.0.

m

Materials Card(s).

name

parameters

m

MIXNAMEB ( MASSFRAC ISOSYM )+
m solcomp 7.0S7e-1 h1 4.801e-8 h5 2.929e-5 he3
MIXNAMEB
is the name of this mixture of isotopes ( $\le8$ characters).

MASSFRAC
is the mass-fraction of an isotope in the mixture.

ISOSYM
is the symbol for an isotope in the mixture and consists of an elemental symbol followed by the atomic weight (without a space), e.g., he4. Also, each ISOSYM listed here must be one of the isotopes in the specific BURN network specified by the net card(s).

Pairs of such mass fractions and isotope symbols are listed for each isotope in the mixture. Continue if necessary on a new m card with the same MIXNAMEB. After all such cards have been read, the code renormalizes the sum of the mass fractions to insure it equals 1.

g

Grid Cards. (At least 2 required).

name

parameters

g

ZONENUM NETNUMB MIXNAMEB
g 0 1 solcomp
ZONENUM

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

NETNUMB

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

MIXNAMEB

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

Note

Unless different mixtures are set up for the same star, use the gg card instead for better portability of the generator.

gg

Master Network Card.

name

parameters

gg

NETNUMB MIXNAMEB
gg 1 sollo09
NETNUMB

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

MIXNAMEB

name of the material (as specified by the appropriate m cards).

Sets all zones to BURN network number NETNUMB and BURN composition MIXNAMEB. Otherwise similar to the g card. The important difference is that the same generator can be used independent of the number of zones in the problem generator file.

New In Version >15.0.0.

abu

Raw Abundance Card.

name

parameters

abu

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

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

FIRSTZONE

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

LASTZONE

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

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

New In Version 17.9.2.

Useful Input Cards¶

Note

The following cards are not specific to generators.

c

Comment - ignored.

name

parameters

c

[ COMMENT ]
c the parameter settings below make the run more smooth
Comment Card.

COMMENT
is an arbitrary alphanumeric string that is ignored by the code. Note that it must be separated from the c by at least one space.
Main entry:
Normal Program Managment Commands

p

Edit changable (‘P’) parameters.

name

parameters

p

[ ( PARAMETER [ ( ( - | .. ) PARAMETER ) | ( VALUE [ OPERATION ] ) ] ) | ( LISTVALUE [ list ] ) ]
p
p 1
p 1 1.e-5
p 1 2. *
p 1 - 3
p 1 .. 3
p 1 .0001 %
p 1 list
p 1.d-14
p *time
PARAMETER

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

VALUE

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

OPERATION

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

LISTVALUE

Value for parameter list by value. Integer or float.

Note

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

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

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

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

Parameters can be changed by specifying the new value or using one of the operations “*”, “-“, “+”, “/”, or “%” on the current value.
parmetercard ::=  "p" listspec | setspec | vallistspec
listspec     ::=  [ parameter [ rangeop parameter ] ] | wildspec
rangeop      ::=  "-" | ".."
wildspec     ::=  "*"string | string"*" | "*"string"*"
setspec      ::=  parameter value [ operation ]
vallistspec  ::=  value [ "list" ]
parameter    ::=  name | number
name         ::=  string
number       ::=  integer
value        ::=  float | integer | string
operation    ::=  "add" | "mul" | "div" | "sub" | "mod" | "*" | "-" | "+" | "/" | "%"
Changed In Version >15.0.0: Added matching by wildchard and parameter range.

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

Changed In Version 17.0.2: List parameters by value.
Main entry:
Normal Program Managment Commands

Note

All forms of the p card are allowed in generators, however, only setting values has any useful impact.

Changed In Version 17.0.0: generator p cards used to allow only setting parameters and only allowed to specify parameters by number.; now any form of the p card is allowed in generators (as they are processed by the same routine as other input).