| Geant4 Cross Reference |
1 //
2 // ********************************************************************
3 // * License and Disclaimer *
4 // * *
5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. *
10 // * *
11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitation of liability. *
17 // * *
18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Software license. *
24 // ********************************************************************
25 //
26 /*
27 * File: G4FPYTreeStructures.hh
28 * Author: B. Wendt (wendbryc@isu.edu)
29 *
30 * Created on September 8, 2011, 10:43 AM
31 */
32
33 #ifndef G4FPYTREESTRUCTURES_HH
34 #define G4FPYTREESTRUCTURES_HH
35
36 #include "G4Ions.hh"
37 #include "globals.hh"
38
39 /** ProbabilityBranch is a tree hierarchy storage method. Each 'branch'
40 * stores information for the isotope/isomer that is stores, as well as the
41 * probability segment in the (0,1] range references it for use in random
42 * fission product sampling.
43 * \n ProbabilityBranch branches 'up' and 'down' to other branches that
44 * have a probability segment either higher or lower in the (0,1] range.
45 */
46 struct ProbabilityBranch
47 {
48 /** Pointer to the \p G4Ions definition that contains the data for
49 * the isotope/isomer for this ProbabilityBranch
50 */
51 G4Ions* Particle;
52
53 /** Number of different incident energies are available */
54 G4int IncidentEnergiesCount;
55 /** The different energies available */
56 G4double* IncidentEnergies;
57 /** The upper limit of the probability segment, indexed by incident energy*/
58 G4double* ProbabilityRangeBottom;
59 /** The lower limit of the probability segment, indexed by incident energy */
60 G4double* ProbabilityRangeTop;
61
62 /** Pointer to the branch that has a higher probability */
63 ProbabilityBranch* Right;
64 /** Pointer to the branch that has a lower probability */
65 ProbabilityBranch* Left;
66 };
67
68 /** ProbabilityTree is the 'root' for each tree hierarchy, and contains
69 * pointer to the first ProbabilityBranch, or 'trunk', or each tree.
70 * \n ProbabilityTree also stores the value of the highest probability
71 * segment that is stored in the tree. This enables trees that are out of
72 * range to be easily skipped over.
73 */
74 struct ProbabilityTree
75 {
76 /** Number of different incident energies are available */
77 static G4int IncidentEnergiesCount;
78 /** The different energies available */
79 static G4double* IncidentEnergies;
80
81 /** First branch, or 'trunk', in the tree */
82 ProbabilityBranch* Trunk;
83 /** The value of the highest probability segment stored in this tree */
84 G4double* ProbabilityRangeEnd;
85 /** Counter for the number of branches that this tree has **/
86 G4int BranchCount;
87 /** Variable to identify if this is the last tree in or not */
88 G4bool IsEnd;
89 };
90
91 #endif /* G4FPYTREESTRUCTURES_HH */
92