Geant4 Cross Reference

Cross-Referencing   Geant4
Geant4/processes/hadronic/models/particle_hp/include/G4ShiftedGaussian.hh

Version: [ ReleaseNotes ] [ 1.0 ] [ 1.1 ] [ 2.0 ] [ 3.0 ] [ 3.1 ] [ 3.2 ] [ 4.0 ] [ 4.0.p1 ] [ 4.0.p2 ] [ 4.1 ] [ 4.1.p1 ] [ 5.0 ] [ 5.0.p1 ] [ 5.1 ] [ 5.1.p1 ] [ 5.2 ] [ 5.2.p1 ] [ 5.2.p2 ] [ 6.0 ] [ 6.0.p1 ] [ 6.1 ] [ 6.2 ] [ 6.2.p1 ] [ 6.2.p2 ] [ 7.0 ] [ 7.0.p1 ] [ 7.1 ] [ 7.1.p1 ] [ 8.0 ] [ 8.0.p1 ] [ 8.1 ] [ 8.1.p1 ] [ 8.1.p2 ] [ 8.2 ] [ 8.2.p1 ] [ 8.3 ] [ 8.3.p1 ] [ 8.3.p2 ] [ 9.0 ] [ 9.0.p1 ] [ 9.0.p2 ] [ 9.1 ] [ 9.1.p1 ] [ 9.1.p2 ] [ 9.1.p3 ] [ 9.2 ] [ 9.2.p1 ] [ 9.2.p2 ] [ 9.2.p3 ] [ 9.2.p4 ] [ 9.3 ] [ 9.3.p1 ] [ 9.3.p2 ] [ 9.4 ] [ 9.4.p1 ] [ 9.4.p2 ] [ 9.4.p3 ] [ 9.4.p4 ] [ 9.5 ] [ 9.5.p1 ] [ 9.5.p2 ] [ 9.6 ] [ 9.6.p1 ] [ 9.6.p2 ] [ 9.6.p3 ] [ 9.6.p4 ] [ 10.0 ] [ 10.0.p1 ] [ 10.0.p2 ] [ 10.0.p3 ] [ 10.0.p4 ] [ 10.1 ] [ 10.1.p1 ] [ 10.1.p2 ] [ 10.1.p3 ] [ 10.2 ] [ 10.2.p1 ] [ 10.2.p2 ] [ 10.2.p3 ] [ 10.3 ] [ 10.3.p1 ] [ 10.3.p2 ] [ 10.3.p3 ] [ 10.4 ] [ 10.4.p1 ] [ 10.4.p2 ] [ 10.4.p3 ] [ 10.5 ] [ 10.5.p1 ] [ 10.6 ] [ 10.6.p1 ] [ 10.6.p2 ] [ 10.6.p3 ] [ 10.7 ] [ 10.7.p1 ] [ 10.7.p2 ] [ 10.7.p3 ] [ 10.7.p4 ] [ 11.0 ] [ 11.0.p1 ] [ 11.0.p2 ] [ 11.0.p3, ] [ 11.0.p4 ] [ 11.1 ] [ 11.1.1 ] [ 11.1.2 ] [ 11.1.3 ] [ 11.2 ] [ 11.2.1 ] [ 11.2.2 ] [ 11.3.0 ]

  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:   G4ShiftedGaussian.hh
 28  * Author: B. Wendt (wendbryc@isu.edu)
 29  *
 30  * Created on July 20, 2011, 11:55 AM
 31  */
 32 
 33 #ifndef G4SHIFTEDGAUSSIAN_HH
 34 #define G4SHIFTEDGAUSSIAN_HH
 35 
 36 #include "globals.hh"
 37 
 38 #include <utility>
 39 #include <vector>
 40 
 41 /** G4ShiftedGaussian is a class for storing the shifted values used for
 42  *  sampling a Gaussian distribution and returning only positive values; it is
 43  *  integrated into G4FPYSamplingOps
 44  */
 45 class G4ShiftedGaussian
 46 {
 47   public:
 48     // Constructor definition
 49     /** Default constructor
 50      *  - Usage: No arguments required
 51      *  - Notes:
 52      */
 53     G4ShiftedGaussian();
 54     /** Overloaded constructor
 55      *  - Usage:
 56      *      - \p Verbosity: Verbosity level
 57      *  - Notes:
 58      */
 59     G4ShiftedGaussian(G4int Verbosity);
 60 
 61   protected:
 62     /** Initialize is a common function called by all constructors. */
 63     void Initialize();
 64 
 65   public:
 66     // Functions
 67     /** Returns the shifted mean that correlates to a \p RequestedMean and
 68      *  \p RequestedStdDev pair. 0 is returned if there is no associated value.
 69      */
 70     G4double G4FindShiftedMean(G4double RequestedMean, G4double RequestedStdDev);
 71     /** Inserts a \p ShiftedMean indexed by the \p RequestedMean and
 72      * \p RequestedStdDev
 73      */
 74     void G4InsertShiftedMean(G4double ShiftedMean, G4double RequestedMean,
 75                              G4double RequestedStdDev);
 76     /** Sets the verbosity levels
 77      *  - Usage:
 78      *      - \p WhichVerbosity: Combination of  levels
 79      *
 80      *  - Notes:
 81      *      - \p SILENT: All verbose output is repressed
 82      *      - \p UPDATES: Only high-level internal changes are reported
 83      *      - \p DAUGHTER_INFO: Displays information about daughter product sampling
 84      *      - \p NEUTRON_INFO: Displays information about neutron sampling
 85      *      - \p GAMMA_INFO: Displays information about gamma sampling
 86      *      - \p ALPHA_INFO: Displays information about alpha sampling
 87      *      - \p MOMENTUM_INFO: Displays information about momentum balancing
 88      *      - \p EXTRAPOLATION_INTERPOLATION_INFO: Displays information about any data extrapolation
 89      * or interpolation that occurs
 90      *      - \p DEBUG: Reports program flow as it steps through functions
 91      *      - \p PRINT_ALL: Displays any and all output
 92      */
 93     void G4SetVerbosity(G4int WhatVerbosity);
 94 
 95   protected:
 96     /** Contains the adjusted mean of the POSITIVE only Gaussian distribution
 97      *  associated with a \p RequestedMean and \p RequestedStdDev pair.
 98      */
 99     std::vector<std::pair<std::pair<G4double, G4double>, G4double>> ShiftedMean_;
100     /** Verbosity level */
101     G4int Verbosity_;
102 
103     // Destructor function(s)
104   public:
105     /** Default deconstructor. */
106     ~G4ShiftedGaussian();
107 };
108 
109 #endif /* G4SHIFTEDGAUSSIAN_HH */
110