.. _c4:

Card 4: Output options
----------------------

The following old/legacy entries to this card are deprecated and no longer perform any function: ``IPRTB1``, ``IPRTB2``, ``RPRTB2``, and ``IPRTB3`` (and the old Card 8 and its dependent variables ``ANCZA`` and ``HANCZA``)

.. _`param:iyild`:

.. rst-class:: no-caption-number

.. list-table:: **IYILD** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, D\ :sub:`P`\ =2)
     - Option to output region-wise nuclide yield file [#]_ (\*.yld) at the end of the final output time step.
   * - = 0
     - No effect (yield file not generated)
   * - = 1
     - Final inventories of the nuclides produced are outputted.
   * - = 2
     - Final inventories of all nuclides are outputted, including the initial inventories of the target nuclides listed in Card 9a/9b.

.. _`param:iggrp`:

.. rst-class:: no-caption-number

.. list-table:: **IGGRP** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=3, requires ``IMODE``\ :math:`\geq`\ 2)
     - Selection of gamma-ray spectrum’s energy group structure for output.
   * - = 0
     - Not valid (default if ``IMODE``\ :math:`<`\ 2)
   * - = 1
     - 22-group structure of the HILO86-R library. (20.0\ :math:`\sim`\ 0.01 [MeV])
   * - = 2
     - 41-group structure of the BREMUDA library with 3 additional groups. (20.0\ :math:`\sim`\ 0.0 [MeV])
   * - = 3
     - 42-group structure of the VITAMIN-J library. (50.0\ :math:`\sim`\ 0.001 [MeV])
   * - = 4
     - 54-group structure of the THIDA-2 code. (3.0\ :math:`\sim`\ 0.03 [MeV])
   * - = 5
     - 78-group structure of the THIDA-2 code. (7.6\ :math:`\sim`\ 0.03 [MeV])
   * - = 6
     - 40-group structure used in the FNS facility. (14.0\ :math:`\sim`\ 0.01 [MeV])
   * - = 99
     - 23-group structure of the FISPACT3 code. (20.0\ :math:`\sim`\ 0.01 [MeV])

.. _`param:ibetap`:

.. rst-class:: no-caption-number

.. list-table:: **IBETAP** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=1)
     - Toggle consideration of annihilation photons (:math:`\gamma`-rays) accompanying positron (:math:`\beta^+`) decays/emissions.
   * - = 0
     - Annihilation photons not counted.
   * - = 1
     - Two annihilation photons counted per emitted positron.

.. _`param:acmin`:

.. rst-class:: no-caption-number

.. list-table:: **ACMIN** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0.0, D\ :sub:`P`\ =10\ :math:`^{-20}`)
     - Threshold/cut-off value of radioactivity/inventory which must be exceeded for a nuclide to be reported in output.
   * - = 0.0
     - Threshold automatically set to the total radioactivity times 10\ :math:`^{-10}`.
   * - :math:`>` 0.0
     - Threshold radioactivity in [Bq].
   * - :math:`<` 0.0
     - -1 :math:`\times` The threshold inventory per unit volume in [atoms/cm\ :math:`^3`].

.. _`param:istabl`:

.. rst-class:: no-caption-number

.. list-table:: **ISTABL** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0)
     - Toggle printing of stable nuclides in the output files.
   * - = 0
     - Not printed (default)
   * - = 1
     - Printed

.. _`param:igsdef`:

.. rst-class:: no-caption-number

.. list-table:: **IGSDEF** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IMODE``\ :math:`\geq`\ 2 and ``IGGRP``\ :math:`>`\ 0)
     - Toggle printing of an MCNP source (SDEF) card to the \*.gsd output file for the :math:`\gamma`-ray spectrum.
   * - = 0
     - Not printed
   * - = 1
     - Printed (default)

.. _`param:igsorg`:

.. rst-class:: no-caption-number

.. list-table:: **IGSORG** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IMODE``\ :math:`\geq`\ 2 and ``IGGRP``\ :math:`>`\ 0)
     - Toggle printing of the source nuclides of the :math:`\gamma`-ray spectrum to the \*.gso output file.
   * - = 0
     - Not printed
   * - = 1
     - Printed (default)

.. _`param:iwrtchn`:

.. rst-class:: no-caption-number

.. list-table:: **IWRTCHN** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, D\ :sub:`P`\ =1)
     - Toggle printing of the decay chain information \*.dcs output file, showing schemes of each relevant decay chain and it’s contribution to the change in nuclide inventory at every calculation time step (irradiation/cooling and output times), further explained in Section :ref:`4.10 <dcsfile>`.
   * - = 0
     - Not printed
   * - = 1
     - Printed

.. _`param:chrlvth`:

.. rst-class:: no-caption-number

.. list-table:: **CHRLVTH** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=-1.0, requires ``IWRTCHN``\ =1)
     - Specify inventory/radioactivity change “relevancy” threshold [#]_ that each chain must meet in each calculation time step to be printed to the \*.dcs output file.
   * - :math:`<` 0.0
     - -1 :math:`\times` Threshold change in inventory per unit volume in [atoms/cm\ :math:`^3`].
   * - = 0.0
     - No threshold (print all chains constructed by DCHAIN).
   * - :math:`>` 0 & :math:`\leq` 10
     - Threshold fractional change in nuclide’s inventory.
   * - :math:`>` 10.0
     - Threshold change in nuclide’s absolute activity in [Bq].

.. _`param:iwrchdt`:

.. rst-class:: no-caption-number

.. list-table:: **IWRCHDT** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IWRTCHN``\ =1)
     - Toggle printing of contribution of each link (nuclide) in each decay chain to the change in inventory of each end-nuclide to the \*.dcs output file.
   * - = 0
     - Not printed
   * - = 1
     - Printed

.. _`param:iwrchss`:

.. rst-class:: no-caption-number

.. list-table:: **IWRCHSS** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IWRTCHN``\ =1)
     - Toggle printing decay chain data for the first ``IDIVS``\ ``-1`` time substeps [#]_ in each irradiation step to the \*.dcs output file.
   * - = 0
     - Not printed
   * - = 1
     - Printed

.. _`param:iwrchnuc`:

.. rst-class:: no-caption-number

.. list-table:: **IWRCHNUC** :phits-not-settable:`PHITS: not settable`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IWRTCHN``\ =1)
     - Select specific end-nuclides whose decay chain info are to be written to the \*.dcs output file.
   * - = 0
     - All nuclides can be printed normally (default behavior)
   * - = :math:`n`
     - Only :math:`n` end-nuclides will be considered for the \*.dcs file. Immediately after this line, the next :math:`n` lines must each contain a nuclide name formatted as ``TGNZAS`` or ``HTGNZAS`` shown in :ref:`Card 9b <c9b>`\  [#]_.

.. _`param:idosecf`:

.. rst-class:: no-caption-number

.. list-table:: **IDOSECF** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=1)
     - Select what set of photon fluence to effective dose :math:`E` (or ambient dose equivalent :math:`H^*(10)`) rate coefficients are used when calculating the photon dose values [#]_ printed to the various output files.
   * - = 0
     - Old defaults (unknown origin and seemingly faulty)
   * - = 1
     - AP, antero-posterior, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 2
     - PA, postero-anterior, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 3
     - LLAT, left lateral, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 4
     - RLAT, right lateral, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 5
     - ROT, rotational, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 6
     - ISO, isotropic, fluence to effective dose, ICRP 116 :cite:`ICRP116_ref`
   * - = 7
     - :math:`H^*(10)`, fluence to ambient dose equivalent, ICRP 74 :cite:`ICRP74_ref` [#]_

.. _`param:idosunit`:

.. rst-class:: no-caption-number

.. list-table:: **IDOSUNIT** :phits-same:`PHITS: same name`
   :header-rows: 1

   * - Value
     - Digit
     - Description
   * - (D=333, :math:`\mu`\ Sv\ :math:`\cdot`\ m\ :math:`^2`/hr)
     -
     - Select what units for photon effective dose :math:`E` (or ambient dose equivalent :math:`H^*(10)`) rates [#]_ are printed to the various output files. This is a three-digit number ``XYZ`` whose digits signify the units for dose, area, and time, respectively; e.g. 121 = pSv\ :math:`\cdot`\ cm\ :math:`^2`/sec.
   * - = 1
     - ``X`` [dose units]
     - pSv
   * - = 2
     - ``X`` [dose units]
     - nSv
   * - = 3
     - ``X`` [dose units]
     - :math:`\mu`\ Sv
   * - = 4
     - ``X`` [dose units]
     - mSv
   * - = 5
     - ``X`` [dose units]
     - Sv
   * - = 1
     - ``Y`` [area units]
     - mm\ :math:`^2`
   * - = 2
     - ``Y`` [area units]
     - cm\ :math:`^2`
   * - = 3
     - ``Y`` [area units]
     - m\ :math:`^2`
   * - = 1
     - ``Z`` [time units]
     - 1/sec
   * - = 2
     - ``Z`` [time units]
     - 1/min
   * - = 3
     - ``Z`` [time units]
     - 1/hr
   * - = 4
     - ``Z`` [time units]
     - 1/day

.. _`param:imtcard`:

.. rst-class:: no-caption-number

.. list-table:: **IMTCARD** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, D\ :sub:`P`\ =1)
     - Toggle printing of nuclide inventories to PHITS/MCNP-formatted materials cards to the \*.mat output file(s).
   * - = 0
     - Not written
   * - = 1
     - Written all to one file
   * - = 2
     - Written to separate files for each output time ``ITOUT`` (very convenient for use with PHITS insert file “infl:” functionality)

.. _`param:imtcnum`:

.. rst-class:: no-caption-number

.. list-table:: **IMTCNUM** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, requires ``IMTCARD``\ =1)
     - Toggle whether the material number [#]_ in each region is constant or if it is incremented for each output time ``ITOUT``.
   * - = 0
     - Material number is constant for all times.
   * - = 1
     - Material number is adjusted and incremented for each output time ``ITOUT``.

.. _`param:imtcmeta`:

.. rst-class:: no-caption-number

.. list-table:: **IMTCMETA** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=0, D\ :sub:`P`\ =2, requires ``IMTCARD``\ =1)
     - Determine handling of metastable isotopes when writing materials cards to the \*.mat output file(s).
   * - = 0
     - Do not write metastable nuclides at all.
   * - = 1
     - Output :math:`ZZZAAA` number in the MCNP-style format [#]_ where :math:`AAA^\prime = AAA + 300 + 100\cdot M` where :math:`M` denotes the metastable/isomeric state and is 1 or 2 [#]_.
   * - = 2
     - All metastable nuclide inventories are added to the ground state inventory.

.. _`param:thmatnd`:

.. rst-class:: no-caption-number

.. list-table:: **THMATND** :phits-same:`PHITS: same name`
   :header-rows: 0

   * - Value
     - Description
   * - (D=-1.0, D\ :sub:`P`\ =1.0E-6, requires ``IMTCARD``\ =1)
     - Threshold number density each nuclide must have for inclusion in the \*.mat file(s) materials cards.
   * - :math:`\leq` 0
     - -1 :math:`\times` Threshold number density in [atoms/cm\ :math:`^3`]
   * - :math:`>` 0 and :math:`\leq` 1
     - Threshold fraction of total atomic number density

.. [#]
   Includes only nuclides with number density at least :math:`10^{-12}` times the total. ``IYILD`` = 1 or 2 controls whether the original target nuclide number densities are not or are included in this total, respectively.

.. [#]
   The inventory of each nuclide is calculated using the sum of all of the various production, reaction, and decay channels resulting in that nuclide; these are parts of linear “chains.” This parameter controls how significant each chain’s contribution to the change in a nuclide’s inventory must be to be printed.

.. [#]
   Each irradiation step is subdivided into ``IDIVS`` (D=50) calculation substeps. This toggles display of all substeps versus just the last substep. This is further explained in Section :ref:`4.8 <runtime-impact-of-xs-lib-size>`.

.. [#]
   Must include atomic mass info. (ex. “Fe-55” and “26055.0” work while “Fe” and “26000.0” do not)

.. [#]
   The meaning and derivation of DCHAIN’s dose rate output is discussed in detail in Section :ref:`4.9 <dchain-dose>`.

.. [#]
   ICRP 74 :cite:`ICRP74_ref` is used for photons 10 MeV and below, and Pelliccioni :cite:`Pelliccioni2000` is used for photons above 10 MeV with a discontinuity at this transition.

.. [#]
   The meaning and derivation of DCHAIN’s dose rate output is discussed in detail in Section :ref:`4.9 <dchain-dose>`.

.. [#]
   In PHITS, the material number is restricted to five digits. In general, the material number for each region will match the cell number (for reg meshes) or region index (for other mesh types) when ``IMTCNUM``\ \ =0. When ``IMTCNUM``\ \ =1, the index of the output time is appended to the end of the material number. In cases with enough regions/output time steps or cell numbers high enough to cause issues with assigning a 5-digit number, this number assignment methodology is adjusted as best as possible to accommodate the 5-digit limitation.

.. [#]
   This format is only supported by MCNP; PHITS would see these nuclides as just being very heavy. Presently, PHITS does not have the capability of accepting metastable nuclides in the Materials section.

.. [#]
   This is 1, 2, 3, or 4 in MCNP, but DCHAIN currently only supports first and second isomeric states.