include/Geant4/G4FPYTreeStructures.hh

0001 //
0002 // ********************************************************************
0003 // * License and Disclaimer                                           *
0004 // *                                                                  *
0005 // * The  Geant4 software  is  copyright of the Copyright Holders  of *
0006 // * the Geant4 Collaboration.  It is provided  under  the terms  and *
0007 // * conditions of the Geant4 Software License,  included in the file *
0008 // * LICENSE and available at  http://cern.ch/geant4/license .  These *
0009 // * include a list of copyright holders.                             *
0010 // *                                                                  *
0011 // * Neither the authors of this software system, nor their employing *
0012 // * institutes,nor the agencies providing financial support for this *
0013 // * work  make  any representation or  warranty, express or implied, *
0014 // * regarding  this  software system or assume any liability for its *
0015 // * use.  Please see the license in the file  LICENSE  and URL above *
0016 // * for the full disclaimer and the limitation of liability.         *
0017 // *                                                                  *
0018 // * This  code  implementation is the result of  the  scientific and *
0019 // * technical work of the GEANT4 collaboration.                      *
0020 // * By using,  copying,  modifying or  distributing the software (or *
0021 // * any work based  on the software)  you  agree  to acknowledge its *
0022 // * use  in  resulting  scientific  publications,  and indicate your *
0023 // * acceptance of all terms of the Geant4 Software license.          *
0024 // ********************************************************************
0025 //
0026 /*
0027  * File:   G4FPYTreeStructures.hh
0028  * Author: B. Wendt (wendbryc@isu.edu)
0029  *
0030  * Created on September 8, 2011, 10:43 AM
0031  */
0032
0033 #ifndef G4FPYTREESTRUCTURES_HH
0034 #define G4FPYTREESTRUCTURES_HH
0035
0036 #include "G4Ions.hh"
0037 #include "globals.hh"
0038
0039 /** ProbabilityBranch is a tree hierarchy storage method. Each 'branch'
0040  *  stores information for the isotope/isomer that is stores, as well as the
0041  *  probability segment in the (0,1] range references it for use in random
0042  *  fission product sampling.
0043  *  \n ProbabilityBranch branches 'up' and 'down' to other branches that
0044  *  have a probability segment either higher or lower in the (0,1] range.
0045  */
0046 struct ProbabilityBranch
0047 {
0048     /** Pointer to the \p G4Ions definition that contains the data for
0049      *  the isotope/isomer for this ProbabilityBranch
0050      */
0051     G4Ions* Particle;
0052
0053     /** Number of different incident energies are available */
0054     G4int IncidentEnergiesCount;
0055     /** The different energies available */
0056     G4double* IncidentEnergies;
0057     /** The upper limit of the probability segment, indexed by incident energy*/
0058     G4double* ProbabilityRangeBottom;
0059     /** The lower limit of the probability segment, indexed by incident energy */
0060     G4double* ProbabilityRangeTop;
0061
0062     /** Pointer to the branch that has a higher probability */
0063     ProbabilityBranch* Right;
0064     /** Pointer to the branch that has a lower probability */
0065     ProbabilityBranch* Left;
0066 };
0067
0068 /** ProbabilityTree is the 'root' for each tree hierarchy, and contains
0069  *  pointer to the first ProbabilityBranch, or 'trunk', or each tree.
0070  *  \n ProbabilityTree also stores the value of the highest probability
0071  *  segment that is stored in the tree. This enables trees that are out of
0072  *  range to be easily skipped over.
0073  */
0074 struct ProbabilityTree
0075 {
0076     /** Number of different incident energies are available */
0077     static G4int IncidentEnergiesCount;
0078     /** The different energies available */
0079     static G4double* IncidentEnergies;
0080
0081     /** First branch, or 'trunk', in the tree */
0082     ProbabilityBranch* Trunk;
0083     /** The value of the highest probability segment stored in this tree */
0084     G4double* ProbabilityRangeEnd;
0085     /** Counter for the number of branches that this tree has **/
0086     G4int BranchCount;
0087     /** Variable to identify if this is the last tree in or not */
0088     G4bool IsEnd;
0089 };
0090
0091 #endif /* G4FPYTREESTRUCTURES_HH */