include/Geant4/G4ShiftedGaussian.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:   G4ShiftedGaussian.hh
0028  * Author: B. Wendt (wendbryc@isu.edu)
0029  *
0030  * Created on July 20, 2011, 11:55 AM
0031  */
0032
0033 #ifndef G4SHIFTEDGAUSSIAN_HH
0034 #define G4SHIFTEDGAUSSIAN_HH
0035
0036 #include "globals.hh"
0037
0038 #include <utility>
0039 #include <vector>
0040
0041 /** G4ShiftedGaussian is a class for storing the shifted values used for
0042  *  sampling a Gaussian distribution and returning only positive values; it is
0043  *  integrated into G4FPYSamplingOps
0044  */
0045 class G4ShiftedGaussian
0046 {
0047   public:
0048     // Constructor definition
0049     /** Default constructor
0050      *  - Usage: No arguments required
0051      *  - Notes:
0052      */
0053     G4ShiftedGaussian();
0054     /** Overloaded constructor
0055      *  - Usage:
0056      *      - \p Verbosity: Verbosity level
0057      *  - Notes:
0058      */
0059     G4ShiftedGaussian(G4int Verbosity);
0060
0061   protected:
0062     /** Initialize is a common function called by all constructors. */
0063     void Initialize();
0064
0065   public:
0066     // Functions
0067     /** Returns the shifted mean that correlates to a \p RequestedMean and
0068      *  \p RequestedStdDev pair. 0 is returned if there is no associated value.
0069      */
0070     G4double G4FindShiftedMean(G4double RequestedMean, G4double RequestedStdDev);
0071     /** Inserts a \p ShiftedMean indexed by the \p RequestedMean and
0072      * \p RequestedStdDev
0073      */
0074     void G4InsertShiftedMean(G4double ShiftedMean, G4double RequestedMean,
0075                              G4double RequestedStdDev);
0076     /** Sets the verbosity levels
0077      *  - Usage:
0078      *      - \p WhichVerbosity: Combination of  levels
0079      *
0080      *  - Notes:
0081      *      - \p SILENT: All verbose output is repressed
0082      *      - \p UPDATES: Only high-level internal changes are reported
0083      *      - \p DAUGHTER_INFO: Displays information about daughter product sampling
0084      *      - \p NEUTRON_INFO: Displays information about neutron sampling
0085      *      - \p GAMMA_INFO: Displays information about gamma sampling
0086      *      - \p ALPHA_INFO: Displays information about alpha sampling
0087      *      - \p MOMENTUM_INFO: Displays information about momentum balancing
0088      *      - \p EXTRAPOLATION_INTERPOLATION_INFO: Displays information about any data extrapolation
0089      * or interpolation that occurs
0090      *      - \p DEBUG: Reports program flow as it steps through functions
0091      *      - \p PRINT_ALL: Displays any and all output
0092      */
0093     void G4SetVerbosity(G4int WhatVerbosity);
0094
0095   protected:
0096     /** Contains the adjusted mean of the POSITIVE only Gaussian distribution
0097      *  associated with a \p RequestedMean and \p RequestedStdDev pair.
0098      */
0099     std::vector<std::pair<std::pair<G4double, G4double>, G4double>> ShiftedMean_;
0100     /** Verbosity level */
0101     G4int Verbosity_;
0102
0103     // Destructor function(s)
0104   public:
0105     /** Default deconstructor. */
0106     ~G4ShiftedGaussian();
0107 };
0108
0109 #endif /* G4SHIFTEDGAUSSIAN_HH */