Users Manual¶
Contents
Breakdown of Cards¶
1 - Output File¶
nout
- Desired tape number for the LEAPR output file. Must have an absolute value between 20 and 99 inclusively. Can be positive (ASCII) or negative (binary). For example, “24” will correspond to the thermal scattering file being written to “tape24”.
Note
In NJOY, unit numbers from 20 through 99 are used for storing results or linking modules, units 10 through 19 are reserved for scratch files, which will be destroyed after a module has completed its job, and units below 10 are reserved for the system. Negative unit numbers indicate binary mode.
2 - Title¶
title
- Used to label the input deck and the output listing for the user’s convenience. The title string does not go into the output ENDF file.
3 - General Run Control¶
ntempr
[default = 1] - Number of temperatures
iprint
[default = 1] - Print control.- Possible values include:
0 - Minimal verbosity
1 - Standard verbosity
2 - Most verbose
nphon
[default = 100] - Phonon-expansion order. All LEAPR runs include a continuous, solid-type calculation which uses the phonon expansion method to generate a scattering law. This dictates the upper limit of the phonon expansion sum.
4 - ENDF Output Information¶
mat
- ENDF material identification number. These numbers are available according to the ENDF standards.- Restrictions include:
Values corresponding to materials in the ENDF format.
za
- \(1000*z+a\) for the principal scatterer, where \(z\) is the atomic number and \(a\) is the mass number.isabt
[default = 0] - Flag indicating whether to output the non-symmetric or symmetric scattering law.- Possible values include:
0 - Non-symmetric
1 - Symmetric
ilog
[default = 0] - Flag indicating whether to output \(S(\alpha,\beta)\) or \(\mathrm{log}_{10}[S(\alpha,\beta)]\). Giving the log of the scattering law is the ENDF-sanctioned way of handling very small numbers in File 7.- Possible values include:
0 - \(S(\alpha,\beta)\)
1 - \(\mathrm{log}[S(\alpha,\beta)]\)
smin
[default = 1e-75] - Scattering law values lower than this will be set to 0.0. Only invoked ifilog=0
.
5 - Principal Scatterer Information¶
The “principal scatterer” may be hard to select for materials. For \(\mbox{H}_2\mbox{O}\), it’s \(\mbox{H}\). For \(\mbox{ZrH}\), it would be \(H\) for mat=7
and \(\mbox{Zr}\) for mat=58
. For mixed moderators like \(\mbox{BeO}\), it is typically the lighter material.
awr
- Atomic weight ratio between the neturon and the principal scatterer.spr
- Free atom cross section for principal scatterer (in units of barns). This value should be chosen by looking at the low-energy limit for MF=3/MT=2 (elastic scattering) on the neutron file to be used with the new evaluation.npr
- Number of principal scattering atoms in the compound. This would be 2 for \(\mbox{H}_2\mbox{O}\), and 1 for \(\mbox{BeO}\).iel
[default = 0] - Coherent elastic options. This should typically be equal to 0, except for solid moderators. Currently, only five materials are supported (listed below).- Possible values include:
0 - None (default)
1 - Graphite
2 - Beryllium
3 - Beryllium Oxide
4 - Aluminum (FCC)
5 - Lead (FCC)
6 - Iron (BCC)
ncold
[default = 0] - Cold hydrogen option. This should be set to 0 except when liquid hydrogen or liquid deuterium is considered.- Possible values include:
0 - None (default)
1 - Ortho Hydrogen
2 - Para Hydrogen
3 - Ortho Deuterium
4 - Para Deutrerium
nsk
[default = 0 (none)] - This should be set to 0 unless representation of intermolecular interference is desired. Ifnsk
is set to 1 or 2, Cards 17-19 will be required.- Possible values include:
0 - None (default)
1 - Vineyard
2 - Skold
6 - Secondary Scatterer Information¶
Note that if you only have a principal scatterer and no secondary scatterers, Card 6 entry line should simply consist of 0/
.
nss
- Number of secondary scatterers- Possible values include:
0 - No secondary scatterers
1 - 1 secondary scatterer type
b7
- Flag indicating the treatment that will be applied to the secondary scatterer.- Possible values include:
0 - SCT approximation. This is most suitable for mixed moderators such as BeO and Benzine. In these cases, the entire scattering law for the molecule is provideded in MF=7/MT=4, and is intended to be used with the neutron file for the primary scatterer. The secondary scatterer’s cross section, atomic weight ratio, and effective temperature are only used for extrending the scattering law with the SCT approximation.
1 - Free gas approximation.
2 - Diffusion Model
When
b7
is 1 or 2, only the scattering law for the primary scatterer is given, and the effects of the secondary scatterer are to be included later using an analytic law.
aws
- Atomic weight ratio between the neturon and the secondary scatterer.sps
- Free atom cross section for the secondary scatterer (units of barns).mss
- Number of secondary scatter atoms of this type in the compound. For \(\mbox{H}_2\mbox{O}\), the secondary scatterer would be \(\mbox{O}\) andmss
would be equal to 1.
7 - \(\alpha,\beta\) Input¶
nalpha
- Number of \(\alpha\) values that will be provided in Card 9nbeta
- Number of \(\beta\) values that will be provided in Card 8lat
[default=0] - Flag that indicates whether the \(\alpha\) and \(\beta\) values are scaled by \(0.0253/k_bT\), where \(k_bT\) is the temperature in eV.
In the ENDF thermal format, the values for \(S(\alpha,\beta)\) for higher temperatures are given on the same \(\alpha\) and \(\beta\) grids as is provided for the base temperature. However, \(\alpha\) and \(\beta\) are inversely proportional to temperature, so for high temperatures only the smaller \(\alpha\) and \(\beta\) values would be seen. This is a waster of space on the ENDF evaluation, so using a lat
value of 1 would spread the scattering law values for higher temperatures out, thereby giving a more accurate representation.
8 - \(\alpha\) Values¶
\(\alpha\) values are provided here in increasing order.
- Restrictions include:
The number of \(\alpha\) values provided must match the
nalpha
input from Card 7.
9 - \(\beta\) Values¶
\(\beta\) values are provided here in increasing order.
- Restrictions include:
The number of \(\beta\) values provided must match the
nbeta
input from Card 7.
10 - Temperature¶
For inputs with more than one temperature (ntempr
\(>0\)), LEAPR uses a temperature loop, where Cards 10-18 are repeated for each temperature. Further explanaion of the temperature loop is provided below.
For a given iteration in this temperature loop, Card 10 consists solely of the temperature in Kelvin.
11 - Phonon Distribution Control¶
The phonon distribution for the continuous, solid-type spectrum treatment is provided on an equally-spaced grid.
delta
- Spacing of the phonon distribution (ev). Since the phonon distribution is provided on an equally spaced grid, this is a single value.ni
- Number of phonon distribution values that will be provided on Card 12.
12 - Phonon Distribution¶
The phonon distribution is provided here. The phonon distribution does not need to be normalized, it will be normalized by LEAPR to the continuous, solid-type weight \(\omega_s\).
- Restrictions include:
This distribution must be provided on an equally spaced grid, with the energy spacing equal to
delta
from Card 11. The number of values provided here must match theni
input from Card 11.
13 - Translational Control and Continuout Weight¶
As mentioned in Inelastic Scattering, the phonon distribution is separated into a continuous contribution, and optional translational contribution, and an arbitrary number of discrete oscillators.
twt
- Weight for the translational/diffusive contribution (\(\omega_t\))c
- Diffusion constant for translational component.- Notes:
If
twt
is equal to zero,c
can be set to zeroIf
twt
is greater than zero, then a settingc
to zero corresponds to a free gas translational calculation.
tbeta
- Weight for the continuous, solid-type spectrum (\(\omega_s\)).
- Restrictions include:
The translational weight
twt
, the continuous, solid-type weighttbeta
, and the discrete oscillator weights (Card 14) must sum to 1.0.
14 - Discrete Oscillator Control¶
nd
- Number of discrete oscillators desired
15 - Discrete Oscillator Energies¶
Energy locations (in eV) for the discrete oscillators.
- Restrictions include:
Must be
nd
entries here.
16 - Discrete Oscillator Weights¶
Weights of the discrete oscillators.
- Restrictions include:
Must be
nd
entries here.The translational weight
twt
, the continuous, solid-type weighttbeta
(Card 13), and the discrete oscillator weights here must sum to 1.0.
17 - Static Structure Factor Control¶
This card is only given for liquid hydrogen or liquid deuterium cases. It controls the entry of the pair-correlation function used to account for intermolecular interference at very low neutron energies.
nka
- Number of \(S(\kappa)\) values that will be provided on Card 18.dka
- \(\kappa\) spacing for the \(S(\kappa)\) entry on Card 18.
- Restrictions include:
Note that
dka
is in units of inverse Angstrom
18 - Static Structure Factor¶
Static structure factor (pair correlation function) \(S(\kappa)\) is provided here.
- Restrictions include:
These values should correspond to an equally spaced, increasing \(\kappa\) grid.
\(\kappa\) is in units of inverse Angstrom.
19 - Coherent Scattering Fraction¶
cfrac
- Coherent scattering fraction. This is only invoked if nsk
from Card 5 is equal to 2.
20 - Comments¶
The final section of the input deck gives the new comment cards to be added to the section MF=1/MT=451 on the ENDF file generated by LEAPR. If this section is to be a part of a standard library like ENDF/B-VII, there are standard fields that must appear. An example of the appearance of such a formal section will be found in the graphite example below. Note that the comment cards are terminated by an empty card; the number of cards entered is counted by LEAPR.
Structure of LEAPR¶
The general structure of the LEAPR source code is displayed below. This is not only helpful for understanding the code itself, but also in understanding the input formats.
0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 |
----------------------------------------------------------
Read General Input Data
----------------------------------------------------------
Read in Cards 1-9
Begin Principal Scattering Calculation
===========================================
Temperature loop (do ntemp (# temperatures, Card 3) iterations:
----------------------------------------------------------
Read Input Data
----------------------------------------------------------
Read temperature from Card 10
If this is first temperature, or if temperature > 0:
Read Cards 11 - 14
if nd (# discrete oscillators) from Card 14 > 0:
Read Cards 15 - 16
if nsk (molecular interference flag, Card 5) > 0 or
ncold (cold hydrogen/deuterium flag, Card 5) > 0:
Read Cards 17 - 18
if nsk (molecular interference flag, Card 5) > 0:
Read Card 19
End If Statement
----------------------------------------------------------
Perform Calculations
----------------------------------------------------------
Perform Continuous Calculation
If twt (translational weight, Card 13) > 0:
Perform translational/diffusive calculation
If nd (# discrete oscillators, Card 14) > 0:
Perform discrete oscillator calculation
If ncold (cold hydrogen/deuterium flag, Card 5) > 0:
Perform cold hydrogen/deuterium calculation
Else if nsk (molecular interference flag, Card 5) == 2:
Perform Skold calculation
End Temperature Loop
If nss (number of secondary scatterers, Card 6) > 0 and
b7 (secondary scatterer type, Card 6) == 0 (SCT treatment):
Repeat temperature loop for secondary scatterer
================================================
|
There are a number of inputs that have the potential to change the structure of the LEAPR input file. We will walk through the ways in which the structure of the input file may vary according to calculations performed.
The inputs that can alter the format of the input file are
Trait
Dictated by…
Affects…
Multiple Temperatures
ntempr
Cards 10-19
Discrete Oscillators
nd
Cards 14-15
Molecular Interference
nsk
Cards 18-19
Cold Hydrogen/Deuterium
ncold
Card 18