include/Geant4/G4FPYNormalFragmentDist.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:   G4FPYNormalFragmentDist.hh
0028  * Author: B. Wendt (wendbryc@isu.edu)
0029  *
0030  * Created on July 26, 2011, 12:26 PM
0031  */
0032
0033 #ifndef G4FPYNORMALFRAGMENTDIST_HH
0034 #define G4FPYNORMALFRAGMENTDIST_HH
0035
0036 #include "G4FFGEnumerations.hh"
0037 #include "G4FissionProductYieldDist.hh"
0038 #include "G4Ions.hh"
0039 #include "globals.hh"
0040
0041 /** G4FPYNormalFragmentDist is an inherited class of G4FissionProductYield
0042  *  that samples fission fragments from the entire data set.
0043  */
0044 class G4FPYNormalFragmentDist : public G4FissionProductYieldDist
0045 {
0046   public:
0047     // Constructor definition
0048     /** Default constructor
0049      *  - Usage:
0050      *      - \p WhichIsotope: Isotope number of the element in ZZZAAA form
0051      *      - \p WhichMetaState: \p GROUND_STATE, \p META_1, or \p META_2
0052      *      - \p WhichCause: \p SPONTANEOUS or \p N_INDUCED
0053      *      - \p WhichYieldType: \p INDEPENDENT or \p CUMULATIVE
0054      *
0055      *  - Notes:
0056      */
0057     G4FPYNormalFragmentDist(G4int WhichIsotope, G4FFGEnumerations::MetaState WhichMetaState,
0058                             G4FFGEnumerations::FissionCause WhichCause,
0059                             G4FFGEnumerations::YieldType WhichYieldType,
0060                             std::istringstream& dataFile);
0061
0062     /** Overloaded constructor
0063      *  - Usage:
0064      *      - \p WhichIsotope: Isotope number of the element in ZZZAAA form
0065      *      - \p WhichMetaState: \p GROUND_STATE, \p META_1, or \p META_2
0066      *      - \p WhichCause: \p SPONTANEOUS or \p N_INDUCED
0067      *      - \p WhichYieldType: \p INDEPENDENT or \p CUMULATIVE
0068      *      - \p Verbosity: Verbosity level
0069      *
0070      *  - Notes:
0071      */
0072     G4FPYNormalFragmentDist(G4int WhichIsotope, G4FFGEnumerations::MetaState WhichMetaState,
0073                             G4FFGEnumerations::FissionCause WhichCause,
0074                             G4FFGEnumerations::YieldType WhichYieldType, G4int Verbosity,
0075                             std::istringstream& dataFile);
0076
0077   protected:
0078     /** Initialize is a common function called by all constructors. */
0079     void Initialize();
0080
0081   protected:
0082     // Functions
0083     /** Selects a fission product from the probability tree, limited by the
0084      *  number of nucleons available to the system.
0085      */
0086     G4Ions* GetFissionProduct() override;
0087
0088     // Destructor function(s)
0089   public:
0090     /** Default deconstructor. It is a virtual function since
0091      *  G4FPYNormalFragmentDist inherits from G4FissionProductYieldDist
0092      */
0093     ~G4FPYNormalFragmentDist() override;
0094 };
0095
0096 #endif /* G4FPYNORMALFRAGMENTDIST_HH */