7.9. [ T-Product ] section

This tally gives particles and nuclei produced by nuclear reactions, decays, and fission, and also tallies source particles. It differs from [t-yield] in that the energy and time distributions of produced particles and nuclei can be obtained in [t-product]. No residual nuclei calculated by nuclear data libraries are scored. Note that nuclei produced by neutrons with energies below dmax(2) are scored by setting e-mode>=1.

Table 7.9.1 mesh

value

explanation

reg, r-z, xyz, tet

Mesh type. A mesh type subsection is required below this option.

Table 7.9.2 part

value

explanation

all (default), particle name

Produced particle.

Table 7.9.3 material

value

explanation

(optional)

Specify materials for scoring.

all

all is the default, same as no definition.

number of materials

To set number of materials, define the material numbers in the next line. The number of materials can be set as a negative value, in which case the specified materials are not included for scoring.

(next line)

2 5 8 Material numbers.

Table 7.9.4 mother

value

explanation

(optional)

Specify mother nuclei.

all

all is the default, same as no definition.

number of mother nuclei

When setting the number of mother nuclei, define the mothers in the next line. The number of mother can be set as a negative value, in which case the specified mothers are not included for scoring. When output=atomic, mother cannot be specified.

(next line)

208Pb Pb Nucleus if specified using mass. Without mass, all nuclei are isotopes of Pb. To specify multiple mother groups, use multiple [t-product] tallies.

When specifying mother , use the format described in Section 4.7 .

Table 7.9.5 e-type

value

explanation

1, 2, 3, 4, 5

Energy mesh. See Section 6.6.1 for mesh subsection format.

Table 7.9.6 e-unit

value

explanation

MeV (default), keV, eV, nm, A0, keV/um

Unit of energy mesh. nm specifies wavelength in nanometers, A0 specifies wavelength in angstroms. For massive particles, the de Broglie wavelength is used. When using nm or A0, unit must be 1, 2, 11, 12, 21, 22, 31, or 32. keV/um converts the energy axis to LET (equivalent to eng2let=1).

Table 7.9.7 eng2let

value

explanation

(optional)

0, default: do not convert energy defined by e-type to LET. 1: convert energy to LET, keV/um. Set eng2let=1 and axis=let when you want to output the results as a function of LET.

Table 7.9.8 t-type

value

explanation

1, 2, 3, 4, 5 (optional)

Time mesh. See Section 6.6.1 for mesh subsection format.

Table 7.9.9 a-type

value

explanation

1, 2, -1, -2

Angle mesh with \(\theta\) degrees of freedom for mesh=r-z. See Section 6.6.1 for mesh subsection format.

Isomeric nuclei are supported as valid inputs for the part parameter. Isomers can be specified by placing m, n, or g at the end of isotope names such as Na-24m, first isomer, In-116m, first isomer, In-116n, second isomer, or In-116g, ground state. To score isomers, do not forget to set igamma=3 in the [parameters] section. Even if igamma=3, part=Na-24 means that the sum of the Na-24 ground state and Na-24m isomer is scored.

Table 7.9.10 unit

value

explanation

1, 2, 3, 4, 5, 6

1: [1/source] 2: [1/cm^3/source] 3: [1/MeV/source] 4: [1/cm^3/MeV/source] 5: [1/Lethargy/source] 6: [1/cm^3/Lethargy/source]

11, 12, 13, 14, 15, 16

11: [1/nsec/source] 12: [1/cm^3/nsec/source] 13: [1/MeV/nsec/source] 14: [1/cm^3/MeV/nsec/source] 15: [1/Lethargy/nsec/source] 16: [1/cm^3/Lethargy/nsec/source]

21, 22, 23, 24, 25, 26

21: [1/sr/source] 22: [1/cm^3/sr/source] 23: [1/MeV/sr/source] 24: [1/cm^3/MeV/sr/source] 25: [1/Lethargy/sr/source] 26: [1/cm^3/Lethargy/sr/source]

31, 32, 33, 34, 35, 36

31: [1/nsec/sr/source] 32: [1/cm^3/nsec/sr/source] 33: [1/MeV/nsec/sr/source] 34: [1/cm^3/MeV/nsec/sr/source] 35: [1/Lethargy/nsec/sr/source] 36: [1/cm^3/Lethargy/nsec/sr/source]

Table 7.9.11 axis

value

explanation

eng, let, reg, x, y, z, r

x axis value of output data.

tet

x axis value of output data, only active with mesh=tet.

cos, the

Angle, cosine, theta in degree, mesh.

xy, yz, xz, rz

2-dimensional.

t

Time axis.

Table 7.9.12 samepage

value

explanation

(optional, D=part)

The type of data to be displayed on the same page of the image output file. Parameters that can be defined in axis can be specified.

Table 7.9.13 file

value

explanation

file name

Define output file names. This is required by each setting of axis.

Table 7.9.14 resfile

value

explanation

(optional, D=file)

Define a file name of the past tally in the restart calculation. Even if several axis parameters were defined, specify only one resfile.

Lethargy in unit=5, 6, 15, 16, 25, 26, 35, 36 is the natural logarithmic unit of energy defined by \(\ln(E_{\rm ref}/E)\) using a reference energy \(E_{\rm ref}\) and the particle energy \(E\). Setting these units enables obtaining results in units of Lethargy, which are given as Lethargy widths, \(\ln(E_{\rm high}/E_{\rm low})\), for each energy bin in the energy mesh subsection. Here \(E_{\rm high}\) and \(E_{\rm low}\) are the maximum and minimum values of the energy bins, respectively.

In unit=21-26 or 31-36, sr denotes steradians as the solid angle unit.

Table 7.9.15 output

value

explanation

source

Source particles defined in [source] section.

nuclear (default)

Particles from nuclear reaction, including elastic.

nonela

Particles from nonelastic collision.

elastic

Particles from elastic collision.

decay

Particles from decay. Particles generated from RI source are not included.

fission

Particles from fission. Particles generated from fission neutron source are not included.

atomic

Particles from atomic interaction.

Table 7.9.16 primary

value

explanation

1 (optional), 0

1: both primary and secondary particles at the end of reactions are tallied. 0: only secondary particles are tallied. This parameter is valid for output=nuclear, elastic, atomic. Otherwise, it is treated as 0.

Table 7.9.17 factor

value

explanation

(optional, D=1.0)

Normalization factor.

Table 7.9.18 title

value

explanation

(optional)

Title.

Table 7.9.19 angel

value

explanation

(optional)

ANGEL parameters.

Table 7.9.20 sangel

value

explanation

(optional)

Special format for ANGEL parameters.

Table 7.9.21 2d-type

value

explanation

1, 2, 3, 4, 5, 6, 7

Options for 2-dimensional plot.

(optional, D=3)

Table 7.9.22 gshow

value

explanation

0 (default), 1, 2, 3, 4, 5

When mesh=xyz and axis=xy,yz,xz, region border (1), material name (2), region name (3), and LAT number (4) are plotted using this option. gshow=5 outputs only material colors in pixel style when icntl=8.

Table 7.9.23 rshow

value

explanation

0 (default), 1, 2, 3

When mesh=reg,tet and axis=xy,yz,xz, region border (1), material name (2), and region name (3) are plotted using this option. A xyz mesh section must be added below this option.

Table 7.9.24 x-txt

value

explanation

(optional)

\(x\) axis title.

Table 7.9.25 y-txt

value

explanation

(optional)

\(y\) axis title.

Table 7.9.26 z-txt

value

explanation

(optional)

\(z\) axis title.

Table 7.9.27 resol

value

explanation

1 (default)

This option multiplies the region line resolution by a factor of resol with the gshow or rshow option set to define the line thickness.

Table 7.9.28 width

value

explanation

0.5 (default)

The option defines the line thickness.

In the case of output=decay or output=source, the primary parameter is invalid because no primary particle exists. No particles are excluded from tally by primary. In the case of output=nonela or output=fission, the primary particle can survive, but the primary parameter is invalid because primary and secondary particles are indistinguishable. No particles are excluded from tally by primary. In the case of output=atomic with primary=1, the primary particle is scored at every atomic reaction in track structure mode. Please ensure that this operation aligns with your intent. output=nuclear is the sum of nonela and elastic. primary only affects elastic, whereas nonela is not affected.

Table 7.9.29 volume

value

explanation

(optional)

This option defines the volume for each region for reg mesh. Volume definitions are required below this option. Values defined in [volume] are used in the case of no definition. If special description such as using (  ) is used to specify a region in reg=, its internally defined region number is output in input echo when this volume subsection is not defined.

reg vol

Volume definition. For details see the [volume] section.

Table 7.9.30 iechrl

value

explanation

72 (default)

Maximum number of columns for volume input echo.

Table 7.9.31 volmat

value

explanation

(optional, D=9)

This option corrects the volume value for each mesh when material is defined by the xyz mesh. 0 means no correction. Value of volmat is the number of scans per one xyz mesh side.

Table 7.9.32 epsout

value

explanation

0 (default), 1, 2

When epsout=1, results are plotted into eps files. The eps file is named by replacing the extension with .eps. When epsout=2, error bars are also displayed in the eps file, except for the 2-dimensional type, axis=xy, yz, xz, rz.

Table 7.9.33 bmpout

value

explanation

0 (default), 1

Generate Bitmap figure of 2-dimensional tally output. This file is named by replacing the extension with .bmp. When mesh=xyz and axis=xy, yz, xz, it is available.

Table 7.9.34 vtkout

value

explanation

0 (default), 1

Output the tally results in the xyz mesh in the input format of ParaView. This file is named by replacing the extension with .vtk. When mesh=xyz and axis=xy, yz, xz, it is available.

Table 7.9.35 vtkfmt

value

explanation

0 (default), 1

Format of output file for ParaView. 0: ascii, 1: binary.

Table 7.9.36 foamout

value

explanation

0 (default), 1, 2

When foamout=1, generate a file of outputs, numerical data, with OpenFOAM field data format. This file is named by replacing the extension with .foam. When foamout=2, generate a file of outputs, element number, center of mass x coordinate, y coordinate, z coordinate, volume, output data, relative error, with CSV format. This file is named by replacing the extension with .csv. When mesh=tet and axis=tet, it is available.

Table 7.9.37 maxangel

value

explanation

Number of part (default)

Specify the number of part shown in the eps file. This parameter limits the number of particles shown in a tally eps file, while it does not limit them in a numerical data file.

Table 7.9.38 ctmin(i)

value

explanation

(optional, D=-9999)

Minimum value for the i-th counter.

Table 7.9.39 ctmax(i)

value

explanation

(optional, D=9999)

Maximum value for the i-th counter.

Table 7.9.40 chmin(i)

value

explanation

(optional, D=-9999)

Minimum value for the i-th history-counter. This parameter cannot be specified in the batch variance mode, istdev=1.

Table 7.9.41 chmax(i)

value

explanation

(optional, D=9999)

Maximum value for the i-th history-counter. This parameter cannot be specified in the batch variance mode, istdev=1.

Table 7.9.42 trcl

value

explanation

(optional)

Coordinate transformation number or definition for r-z or xyz mesh.

Table 7.9.43 dump

value

explanation

Number of data

For mesh=reg, the information is dumped on the file. If dump is negative, data are written by ascii, if positive, by binary.

(next line)

Data sequence. Define the data sequence. The history information, nocas and nobch, is necessary to use idmpmode=1.

Table 7.9.44 letmat

value

explanation

(optional)

Effective only when eng2let=1. Material id for LET, \(dE/dx\). If not defined, a real material is assumed. If a material not used in the geometry is selected, its material density must be defined in [material]. To calculate LET in water, define water with 1 g/cm^3 in [material]. When letmat<0 is set, PHITS automatically calculates \(dE/dx\) for water with 1 g/cm^3 for electrons and positrons. Please see ParticleTherapy in the recommendation setting for more details.

Table 7.9.45 gslat

value

explanation

2 (default)

Option to draw lattice or tetrahedral geometry boundary lines when gshow or rshow is specified.

0

Not drawing.

1

Drawing. Note that the line of voxel phantoms may not be drawn clearly.

2

Not drawing the lines in the same cell.

3

Not drawing the lines in the same material. In this case, the boundary of two adjacent cells filled with the same material is not also drawn, even if not lattice or tetrahedral geometry. When gshow>=3, cell and lattice numbers are now shown.

Table 7.9.46 stdcut

value

explanation

(optional, D=-1)

Threshold value of STD cut off.

When specifying stdcut, PHITS automatically stop the calculation depending on values of STD, standard deviation. This function is available when stdcut is positive and itall=0,1 is set in [parameters] section. When all relative values of STD of the tally result are larger than 0 and smaller than stdcut at the last of one batch, the calculation is stopped. If stdcut in two or more tally sections is set, all the results of the tally sections have to satisfy the conditions in order for the function to work.

When coll or reaction events belonging to coll are specified in [counter], the counter value changes before the particle information is tallied. Therefore, to tally the information at the moment the reaction event occurs, specify the counter value after the change.

In the [t-product] tally, the dump option can only be used. If the dump option is set, the meshes of e-type and t-type have only the meaning of the maximum and minimum values. When using this dump parameter, axis and file are restricted to one axis and one file, and unit is always 1. The dumped data are written onto a file named ***_dmp, where *** indicates the file name specified by file=*. The normal output of the tally is written on ***. From this file, information on the total normalization factor can be obtained; doing so requires setting one mesh each for e-type, a-type, and t-type. Note that constraints based on the history counter, chmin and chmax, do not work with the dump function because the particle information is output to the dump file immediately after particle generation. The history information, nocas and nobch, is necessary to use idmpmode=1 for continuous calculation using the dump file; in addition, both the dump file with _dmp and the normal output file specified by file= are required to use idmpmode=1. The option dumpall is not compatible with this dump tally option when shared memory parallelization is active.

[t-product] can tally source particles, and the function can be used to modify the dump file. Dump files can be read and information written to a new dump file through modifications made by setting the dump parameter and output=source in this tally section and icntl=6 in the [parameters] section.