hadronic/FissionFragment/README.md

0001 \page       ExampleFissionFragment Example FissionFragment
0002
0003  This example demonstrates an application of the fission fragment model in the
0004  NeutronHP model. This example is capable of using both models, but is designed
0005  around the Wendt Fission Model. A warning will be shown if the environment
0006  variable that enables the Wendt fission model is not set.
0007
0008 \tableofcontents
0009
0010 <HR>
0011
0012 ## EXECUTION
0013
0014 ### ENVIRONMENT
0015   - `G4NEUTRONHP_PRODUCE_FISSION_FRAGMENTS`
0016     - Required
0017     - The example requires this enviroment variable to be set. An error will be
0018       displayed and the example will terminate if this environment variable is
0019       not set.
0020
0021   - `G4NEUTRON_HP_USE_WENDT_FISSION_MODEL`
0022     - Optional
0023     - This environment variable enables the Wendt fission model contained within
0024       the NeutronHP model for simulating fission events. The default model will
0025       be used otherwise. A warning will be displayed if this environment
0026       variable is not set.
0027
0028 ### COMMAND LINE ARGUMENTS
0029      The example can be run without any input arguments. However, a few options
0030      are available:
0031 ```
0032   -i ARG      : run in batch mode from script file ARG
0033   -o ARG      : write output to file ARG
0034                 (defaults to FF_Neutron_HP.out)
0035   -n ARG      : multithreading with ARG number of threads
0036                 (only works if Geant4 was compiled with multithreading enabled)
0037 ```
0038      No output is currently generated, although the argument is provided. It is
0039      anticipated that future versions will provide some form of output
0040      summarizing the results of the simulation.
0041
0042 ### INTERACTIVE
0043      No specialized UI commands are currently provided.
0044
0045      To run the simulation, use the standard UI command:
0046 ```
0047 /run/beamOn
0048 ```
0049
0050 ### BATCH
0051      Use the macro batch.in :
0052 ```
0053 ./FissionFragment batch.in
0054 ```
0055
0056 ## GEOMETRY
0057
0058    The geometry is constructed in the FFDetectorConstruction class. The setup is
0059    based on a subcritical assembly design.
0060
0061 ### MATERIALS
0062      This example requires a number of materials. They are loaded or constructed
0063      in the "DefineMaterials" function. A few of the materials are obtained from
0064      the NIST database. These materials are:
0065       - Air
0066       - Aluminum
0067       - Graphite
0068       - Polyethylene
0069       - Stainless steel
0070       - Water
0071
0072      For more information, visit: <A HREF="http://bit.ly/1rEHjhW"> Geant4 User's
0073      Guide for Application Developers, Appendix: Geant4 Materials Database </A>
0074
0075      Not all of the necessary materials were available from the NIST database,
0076      and were constructed manually from the estimated isotopics. These materials
0077      are:
0078       - 20% U235 enriched uranium
0079       - 93% B10 enriched BF3
0080
0081 ### VOLUMES
0082      The world is composed of air instead of a vacuum to provide room return.
0083
0084      The subcritical assembly is a water-filled aluminum tank.
0085
0086      The fuel plates are composed of aluminum-clad uranium meat, and are
0087      completely submersed in the water of the subcritical assembly.
0088
0089      An AmBe neutron source is placed in the exact center of the fuel plate
0090      loading configuration. The material is currently modeled as steel until
0091      more exact specifics of the AmBe isotopics can be obtained.
0092
0093      The subcritical assembly rests on top of a graphite pile for moderation and
0094      shielding.
0095
0096
0097 ## PHYSICS LIST
0098
0099    The particle's type and the physic processes which will be available
0100    in this example are set in the QGSP_BIC_HP physics list.
0101
0102
0103 ## PRIMARY GENERATOR
0104
0105    The primary generator is defined in the FFPrimaryGeneratorAction class.
0106    The default particle is a 4.5 MeV neutron originating from the
0107    "NeutronSource" volume. The particles initial direction is isotropically
0108    sampled.
0109
0110
0111 ## DETECTOR RESPONSE
0112
0113    The scoring method is yet to be implemented, although the BF3 detector is
0114    already included in the detector construction.
0115
0116
0117 ## VISUALISATION
0118    An example "vis.mac" will be included in a future release. For now, please
0119    refer to other examples for a few suggestions.
0120
0121 <HR>
0122
0123 \author     B. Wendt (brycen.linn.wendt@cern.ch)
0124 \date       June 26, 2014
0125