include/Geant4/G4ENDFYieldDataContainer.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:   G4ENDFYieldDataContainer.hh
0028  * Author: B. Wendt (wendbryc@isu.edu)
0029  *
0030  * Created on September 6, 2011, 10:19 AM
0031  */
0032
0033 #ifndef G4ENDFYIELDDATACONTAINER_HH
0034 #define G4ENDFYIELDDATACONTAINER_HH
0035
0036 #include "G4FFGEnumerations.hh"
0037 #include "globals.hh"
0038
0039 /** G4ENDFYieldDataContainer is a simple data storage class that handles
0040  *  the memory management internally. One instance stores the information
0041  *  for one fission product. In the event of a non-spontaneous fission, it
0042  *  can store the yield probabilities and errors at each of the fission-
0043  *  inducing particles energy levels. For ENDF data and neutron-induced
0044  *  fission these energies are typically 0.0253 eV, 1 MeV, and 5 MeV.
0045  */
0046 class G4ENDFYieldDataContainer
0047 {
0048   public:
0049     // Constructor
0050     /** Default constructor */
0051     G4ENDFYieldDataContainer(G4int YieldSlots);
0052
0053     // Functions
0054     /** Get the meta state */
0055     G4FFGEnumerations::MetaState GetMetaState();
0056     /** Get the product */
0057     G4int GetProduct();
0058     /** Get the yield error */
0059     G4double* GetYieldError();
0060     /** Get the yield probability */
0061     G4double* GetYieldProbability();
0062     /** Get the number of yield slots */
0063     G4int GetYieldSlots();
0064     /** Set the meta state */
0065     void SetMetaState(G4FFGEnumerations::MetaState MetaState);
0066     /** Set the product */
0067     void SetProduct(G4int Product);
0068     /** Set the yield error */
0069     void SetYieldError(G4double* YieldError);
0070     /** Set the yield probability */
0071     void SetYieldProbability(G4double* YieldProbability);
0072     /** Set the number of yield slots */
0073     void SetYieldSlots(G4int NumberOfSlots);
0074
0075   protected:
0076     // Data members
0077     /** The number of energy groups, or yield slots, that are stored */
0078     G4int YieldSlots_;
0079     /** ZZZAAA identifier of the stored isotope */
0080     G4int Product_;
0081     /** Metastable state information of the stored isotope */
0082     G4FFGEnumerations::MetaState MetaState_;
0083     /** Array of yield probabilities, one per yield slot */
0084     G4double* YieldProbability_;
0085     /** Array of the yield probability errors, one per yield slot */
0086     G4double* YieldError_;
0087
0088     // Destructor function(s)
0089   public:
0090     /** Default deconstructor */
0091     ~G4ENDFYieldDataContainer();
0092 };
0093
0094 #endif /* G4ENDFYIELDDATACONTAINER_HH */