include/Geant4/G4FPYBiasedLightFragmentDist.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:   G4FPYBiasedLightFragmentDist.hh
0028  * Author: B. Wendt (wendbryc@isu.edu)
0029  *
0030  * Created on June 2, 2011, 11:02 AM
0031  */
0032
0033 #ifndef G4FPYBIASEDLIGHTFRAGMENTDIST_HH
0034 #define G4FPYBIASEDLIGHTFRAGMENTDIST_HH
0035
0036 #include "G4FFGEnumerations.hh"
0037 #include "G4FissionProductYieldDist.hh"
0038 #include "G4Ions.hh"
0039 #include "globals.hh"
0040
0041 /** G4FPYBiasedLightFragmentDist is an inherited class of G4FissionProductYield
0042  *  that only samples the 'light' fission fragments, defined by A \< 115
0043  *      - This inherited class of G4FissionProductYield samples only the lighter
0044  *      fission fragments, defined by A \< 115
0045  *      - This biasing was implemented because of an artifact that is introduced
0046  *      due to random sampling of fission fragments. Typically small fission
0047  *      fragments (neutrons, alphas, gammas) are sampled after the first
0048  *      fragment is sampled. If a heavy fragment (A \>= 115) is sampled first
0049  *      then the resulting lighter fission fragment, after all the other
0050  *      particles have been removed from the available mass, will most likely
0051  *      land far off the neutron drip line.
0052  *      - This implementation reduces the probability that such an improbable
0053  *      nucleus will be created by first sampling the lighter fission fragment
0054  *      and allowing the heavy fission fragment, which has a lot more
0055  *      flexibility for varying neutron populations, to make up the slack.
0056  */
0057 class G4FPYBiasedLightFragmentDist : public G4FissionProductYieldDist
0058 {
0059   public:
0060     // Constructor definition
0061     /** Default constructor
0062      *  - Usage:
0063      *      - \p WhichIsotope: Isotope number of the element in ZZZAAA form
0064      *      - \p WhichMetaState: \p GROUND_STATE, \p META_1, or \p META_2
0065      *      - \p WhichCause: \p SPONTANEOUS or \p N_INDUCED
0066      *      - \p WhichYieldType: \p INDEPENDENT or \p CUMULATIVE
0067      *
0068      *  - Notes:
0069      */
0070     G4FPYBiasedLightFragmentDist(G4int WhichIsotope, G4FFGEnumerations::MetaState WhichMetaState,
0071                                  G4FFGEnumerations::FissionCause WhichCause,
0072                                  G4FFGEnumerations::YieldType WhichYieldType,
0073                                  std::istringstream& dataStream);
0074     /** Overloaded constructor
0075      *  - Usage:
0076      *      - \p WhichIsotope: Isotope number of the element in ZZZAAA form
0077      *      - \p WhichMetaState: \p GROUND_STATE, \p META_1, or \p META_2
0078      *      - \p WhichCause: \p SPONTANEOUS or \p N_INDUCED
0079      *      - \p WhichYieldType: \p INDEPENDENT or \p CUMULATIVE
0080      *      - \p Verbosity: Verbosity level
0081      *
0082      *  - Notes:
0083      */
0084     G4FPYBiasedLightFragmentDist(G4int WhichIsotope, G4FFGEnumerations::MetaState WhichMetaState,
0085                                  G4FFGEnumerations::FissionCause WhichCause,
0086                                  G4FFGEnumerations::YieldType WhichYieldType, G4int Verbosity,
0087                                  std::istringstream& dataStream);
0088
0089   protected:
0090     /** Initialize is a common function called by all constructors. */
0091     void Initialize();
0092
0093   protected:
0094     // Variables
0095     /** Defines the half-weight of the fission isotope */
0096     G4int HalfWeight_;
0097     // Functions
0098     /** Selects a fission product from the probability tree, limited by the
0099      *  number of nucleons available to the system
0100      */
0101     G4Ions* GetFissionProduct() override;
0102
0103     // Destructor function(s)
0104   public:
0105     /** Default deconstructor. It is a virtual function since
0106      *  G4FPYBiasedLightFragmentDist inherits from G4FissionProductYieldDist
0107      */
0108     ~G4FPYBiasedLightFragmentDist() override;
0109 };
0110
0111 #endif /* G4FPYBIASEDLIGHTFRAGMENTDIST_HH */