| Geant4 Cross Reference |
1 // 1 //
2 // ******************************************* 2 // ********************************************************************
3 // * License and Disclaimer 3 // * License and Disclaimer *
4 // * 4 // * *
5 // * The Geant4 software is copyright of th 5 // * The Geant4 software is copyright of the Copyright Holders of *
6 // * the Geant4 Collaboration. It is provided 6 // * the Geant4 Collaboration. It is provided under the terms and *
7 // * conditions of the Geant4 Software License 7 // * conditions of the Geant4 Software License, included in the file *
8 // * LICENSE and available at http://cern.ch/ 8 // * LICENSE and available at http://cern.ch/geant4/license . These *
9 // * include a list of copyright holders. 9 // * include a list of copyright holders. *
10 // * 10 // * *
11 // * Neither the authors of this software syst 11 // * Neither the authors of this software system, nor their employing *
12 // * institutes,nor the agencies providing fin 12 // * institutes,nor the agencies providing financial support for this *
13 // * work make any representation or warran 13 // * work make any representation or warranty, express or implied, *
14 // * regarding this software system or assum 14 // * regarding this software system or assume any liability for its *
15 // * use. Please see the license in the file 15 // * use. Please see the license in the file LICENSE and URL above *
16 // * for the full disclaimer and the limitatio 16 // * for the full disclaimer and the limitation of liability. *
17 // * 17 // * *
18 // * This code implementation is the result 18 // * This code implementation is the result of the scientific and *
19 // * technical work of the GEANT4 collaboratio 19 // * technical work of the GEANT4 collaboration. *
20 // * By using, copying, modifying or distri 20 // * By using, copying, modifying or distributing the software (or *
21 // * any work based on the software) you ag 21 // * any work based on the software) you agree to acknowledge its *
22 // * use in resulting scientific publicati 22 // * use in resulting scientific publications, and indicate your *
23 // * acceptance of all terms of the Geant4 Sof 23 // * acceptance of all terms of the Geant4 Software license. *
24 // ******************************************* 24 // ********************************************************************
25 // 25 //
26 /* 26 /*
27 * File: G4ShiftedGaussian.hh 27 * File: G4ShiftedGaussian.hh
28 * Author: B. Wendt (wendbryc@isu.edu) 28 * Author: B. Wendt (wendbryc@isu.edu)
29 * 29 *
30 * Created on July 20, 2011, 11:55 AM 30 * Created on July 20, 2011, 11:55 AM
31 */ 31 */
32 32
33 #ifndef G4SHIFTEDGAUSSIAN_HH 33 #ifndef G4SHIFTEDGAUSSIAN_HH
34 #define G4SHIFTEDGAUSSIAN_HH 34 #define G4SHIFTEDGAUSSIAN_HH
35 35
36 #include "globals.hh" 36 #include "globals.hh"
37 37
38 #include <utility> 38 #include <utility>
39 #include <vector> 39 #include <vector>
40 40
41 /** G4ShiftedGaussian is a class for storing t 41 /** G4ShiftedGaussian is a class for storing the shifted values used for
42 * sampling a Gaussian distribution and retur 42 * sampling a Gaussian distribution and returning only positive values; it is
43 * integrated into G4FPYSamplingOps 43 * integrated into G4FPYSamplingOps
44 */ 44 */
45 class G4ShiftedGaussian 45 class G4ShiftedGaussian
46 { 46 {
47 public: 47 public:
48 // Constructor definition 48 // Constructor definition
49 /** Default constructor 49 /** Default constructor
50 * - Usage: No arguments required 50 * - Usage: No arguments required
51 * - Notes: 51 * - Notes:
52 */ 52 */
53 G4ShiftedGaussian(); 53 G4ShiftedGaussian();
54 /** Overloaded constructor 54 /** Overloaded constructor
55 * - Usage: 55 * - Usage:
56 * - \p Verbosity: Verbosity level 56 * - \p Verbosity: Verbosity level
57 * - Notes: 57 * - Notes:
58 */ 58 */
59 G4ShiftedGaussian(G4int Verbosity); 59 G4ShiftedGaussian(G4int Verbosity);
60 60
61 protected: 61 protected:
62 /** Initialize is a common function called 62 /** Initialize is a common function called by all constructors. */
63 void Initialize(); 63 void Initialize();
64 64
65 public: 65 public:
66 // Functions 66 // Functions
67 /** Returns the shifted mean that correlat 67 /** Returns the shifted mean that correlates to a \p RequestedMean and
68 * \p RequestedStdDev pair. 0 is returned 68 * \p RequestedStdDev pair. 0 is returned if there is no associated value.
69 */ 69 */
70 G4double G4FindShiftedMean(G4double Reques 70 G4double G4FindShiftedMean(G4double RequestedMean, G4double RequestedStdDev);
71 /** Inserts a \p ShiftedMean indexed by th 71 /** Inserts a \p ShiftedMean indexed by the \p RequestedMean and
72 * \p RequestedStdDev 72 * \p RequestedStdDev
73 */ 73 */
74 void G4InsertShiftedMean(G4double ShiftedM 74 void G4InsertShiftedMean(G4double ShiftedMean, G4double RequestedMean,
75 G4double Requeste 75 G4double RequestedStdDev);
76 /** Sets the verbosity levels 76 /** Sets the verbosity levels
77 * - Usage: 77 * - Usage:
78 * - \p WhichVerbosity: Combination o 78 * - \p WhichVerbosity: Combination of levels
79 * 79 *
80 * - Notes: 80 * - Notes:
81 * - \p SILENT: All verbose output is 81 * - \p SILENT: All verbose output is repressed
82 * - \p UPDATES: Only high-level inte 82 * - \p UPDATES: Only high-level internal changes are reported
83 * - \p DAUGHTER_INFO: Displays infor 83 * - \p DAUGHTER_INFO: Displays information about daughter product sampling
84 * - \p NEUTRON_INFO: Displays inform 84 * - \p NEUTRON_INFO: Displays information about neutron sampling
85 * - \p GAMMA_INFO: Displays informat 85 * - \p GAMMA_INFO: Displays information about gamma sampling
86 * - \p ALPHA_INFO: Displays informat 86 * - \p ALPHA_INFO: Displays information about alpha sampling
87 * - \p MOMENTUM_INFO: Displays infor 87 * - \p MOMENTUM_INFO: Displays information about momentum balancing
88 * - \p EXTRAPOLATION_INTERPOLATION_I 88 * - \p EXTRAPOLATION_INTERPOLATION_INFO: Displays information about any data extrapolation
89 * or interpolation that occurs 89 * or interpolation that occurs
90 * - \p DEBUG: Reports program flow a 90 * - \p DEBUG: Reports program flow as it steps through functions
91 * - \p PRINT_ALL: Displays any and a 91 * - \p PRINT_ALL: Displays any and all output
92 */ 92 */
93 void G4SetVerbosity(G4int WhatVerbosity); 93 void G4SetVerbosity(G4int WhatVerbosity);
94 94
95 protected: 95 protected:
96 /** Contains the adjusted mean of the POSI 96 /** Contains the adjusted mean of the POSITIVE only Gaussian distribution
97 * associated with a \p RequestedMean and 97 * associated with a \p RequestedMean and \p RequestedStdDev pair.
98 */ 98 */
99 std::vector<std::pair<std::pair<G4double, 99 std::vector<std::pair<std::pair<G4double, G4double>, G4double>> ShiftedMean_;
100 /** Verbosity level */ 100 /** Verbosity level */
101 G4int Verbosity_; 101 G4int Verbosity_;
102 102
103 // Destructor function(s) 103 // Destructor function(s)
104 public: 104 public:
105 /** Default deconstructor. */ 105 /** Default deconstructor. */
106 ~G4ShiftedGaussian(); 106 ~G4ShiftedGaussian();
107 }; 107 };
108 108
109 #endif /* G4SHIFTEDGAUSSIAN_HH */ 109 #endif /* G4SHIFTEDGAUSSIAN_HH */
110 110