Geant4.10
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions
G4ENDFTapeRead Class Reference

#include <G4ENDFTapeRead.hh>

Public Member Functions

 G4ENDFTapeRead (G4String FileLocation, G4String FileName, G4FFGEnumerations::YieldType WhichYield, G4FFGEnumerations::FissionCause WhichCause)
 
 G4ENDFTapeRead (G4String FileLocation, G4String FileName, G4FFGEnumerations::YieldType WhichYield, G4FFGEnumerations::FissionCause WhichCause, G4int Verbosity)
 
 G4ENDFTapeRead (std::istringstream &dataStream, G4FFGEnumerations::YieldType WhichYield, G4FFGEnumerations::FissionCause WhichCause, G4int Verbosity)
 
G4double * G4GetEnergyGroupValues (void)
 
G4int G4GetNumberOfEnergyGroups (void)
 
G4int G4GetNumberOfFissionProducts (void)
 
G4ENDFYieldDataContainer * G4GetYield (G4int WhichYield)
 
void G4SetVerbosity (G4int WhatVerbosity)
 
 ~G4ENDFTapeRead (void)
 

Protected Member Functions

void Initialize (G4String dataFile)
 
void Initialize (std::istringstream &dataStream)
 

Detailed Description

G4ENDFTapeRead is a class designed to read in data from unformatted ENDF data tapes for MT = 454 or MT = 459, which correspond to independent fission yields and cumulative fission yields, respectively. The data is stored internally and can be recalled one product at a time by calling G4GetNextYield().

Definition at line 48 of file G4ENDFTapeRead.hh.

Constructor & Destructor Documentation

G4ENDFTapeRead::G4ENDFTapeRead ( G4String  FileLocation,
G4String  FileName,
G4FFGEnumerations::YieldType  WhichYield,
G4FFGEnumerations::FissionCause  WhichCause 
)

Default constructor

  • Usage:
    • FileLocation: the absolute path to the file
    • FileName: the name of the data file
    • WhichYield: INDEPENDENT or CUMULATIVE
    • WhichCause: SPONTANEOUS or N_INDUCED
  • Notes: The data will be read in immediately upon construction.

Definition at line 48 of file G4ENDFTapeRead.cc.

References Initialize().

52 : /* Cause_(WhichCause),*/
53  Verbosity_(G4FFGDefaultValues::Verbosity),
54  YieldType_(WhichYield)
55 {
56  // Initialize the class
57  Initialize(FileLocation + FileName);
58 }
G4ENDFTapeRead::Initialize
void Initialize(G4String dataFile)
Definition: G4ENDFTapeRead.cc:88
G4ENDFTapeRead::G4ENDFTapeRead ( G4String  FileLocation,
G4String  FileName,
G4FFGEnumerations::YieldType  WhichYield,
G4FFGEnumerations::FissionCause  WhichCause,
G4int  Verbosity 
)

Overloaded constructor

  • Usage:
    • FileLocation: the absolute path to the file
    • FileName: the name of the data file
    • WhichYield: INDEPENDENT or CUMULATIVE
    • WhichCause: SPONTANEOUS or N_INDUCED
    • Verbosity: Verbosity level
  • Notes: The data will be read in immediately upon construction.

Definition at line 61 of file G4ENDFTapeRead.cc.

References Initialize().

66 : /*Cause_(WhichCause),*/
67  Verbosity_(Verbosity),
68  YieldType_(WhichYield)
69 {
70  // Initialize the class
71  Initialize(FileLocation + FileName);
72 }
G4ENDFTapeRead::Initialize
void Initialize(G4String dataFile)
Definition: G4ENDFTapeRead.cc:88
G4ENDFTapeRead::G4ENDFTapeRead ( std::istringstream &  dataStream,
G4FFGEnumerations::YieldType  WhichYield,
G4FFGEnumerations::FissionCause  WhichCause,
G4int  Verbosity 
)

Overloaded constructor

  • Usage:
    • DataFile: The absolute path to the data file
    • WhichYield: INDEPENDENT or CUMULATIVE
    • WhichCause: SPONTANEOUS or N_INDUCED
    • Verbosity: Verbosity level
  • Notes: The data will be read in immediately upon construction.

Definition at line 75 of file G4ENDFTapeRead.cc.

References Initialize().

79 : /*Cause_(WhichCause),*/
80  Verbosity_(Verbosity),
81  YieldType_(WhichYield)
82 {
83  // Initialize the class
84  Initialize(dataStream);
85 }
G4ENDFTapeRead::Initialize
void Initialize(G4String dataFile)
Definition: G4ENDFTapeRead.cc:88
G4ENDFTapeRead::~G4ENDFTapeRead ( void  )

Default Deconstructor

Definition at line 551 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, and G4FFG_FUNCTIONLEAVE__.

552 {
553 G4FFG_FUNCTIONENTER__
554 
555  delete[] EnergyGroupValues_;
556  delete YieldContainerTable_;
557 
558 G4FFG_FUNCTIONLEAVE__
559 }
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215

Member Function Documentation

G4double * G4ENDFTapeRead::G4GetEnergyGroupValues ( void  )

Returns and array containing the values of each of the energy groups

  • Usage: No arguments required
  • Notes:

Definition at line 121 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, and G4FFG_FUNCTIONLEAVE__.

122 {
123 G4FFG_FUNCTIONENTER__
124 
125 G4FFG_FUNCTIONLEAVE__
126  return EnergyGroupValues_;
127 }
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215
G4int G4ENDFTapeRead::G4GetNumberOfEnergyGroups ( void  )

Returns the number of energy yield groups that were extracted from the ENDF tape file

  • Usage: No arguments required
  • Notes:

Definition at line 130 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, and G4FFG_FUNCTIONLEAVE__.

131 {
132 G4FFG_FUNCTIONENTER__
133 
134 G4FFG_FUNCTIONLEAVE__
135  return EnergyGroups_;
136 }
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215
G4int G4ENDFTapeRead::G4GetNumberOfFissionProducts ( void  )

Returns the number of fission products that were extracted from the ENDF tape file

  • Usage: No arguments required
  • Notes:

Definition at line 139 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, G4FFG_FUNCTIONLEAVE__, and G4TableTemplate< T >::G4GetNumberOfElements().

Referenced by G4FissionProductYieldDist::MakeTrees(), and G4FissionProductYieldDist::ReadProbabilities().

140 {
141 G4FFG_FUNCTIONENTER__
142 
143  G4int NumberOfElements = YieldContainerTable_->G4GetNumberOfElements();
144 
145 G4FFG_FUNCTIONLEAVE__
146  return NumberOfElements;
147 }
G4TableTemplate::G4GetNumberOfElements
G4long G4GetNumberOfElements(void)
Definition: G4TableTemplate.hh:124
G4int
int G4int
Definition: G4Types.hh:78
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215
G4ENDFYieldDataContainer * G4ENDFTapeRead::G4GetYield ( G4int  WhichYield)

Returns the data for the requested fission product

  • Usage:
    • WhichYield: 0-based index of the fission product for which to get the yield data
  • Notes:
    • This will return a pointer to the next G4FissionYieldContainer. NULL will be returned if no more fission containers exist.

Definition at line 150 of file G4ENDFTapeRead.cc.

References G4FFG_DATA_FUNCTIONENTER__, G4FFG_DATA_FUNCTIONLEAVE__, and G4TableTemplate< T >::G4GetContainer().

Referenced by G4FissionProductYieldDist::ReadProbabilities().

151 {
152 G4FFG_DATA_FUNCTIONENTER__
153 
154  G4ENDFYieldDataContainer* Container = NULL;
155  if(WhichYield >= 0 && WhichYield < YieldContainerTable_->G4GetNumberOfElements())
156  {
157  Container = YieldContainerTable_->G4GetContainer(WhichYield);
158  }
159 
160 G4FFG_DATA_FUNCTIONLEAVE__
161  return Container;
162 }
G4FFG_DATA_FUNCTIONENTER__
#define G4FFG_DATA_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:218
G4FFG_DATA_FUNCTIONLEAVE__
#define G4FFG_DATA_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:222
G4TableTemplate::G4GetContainer
T * G4GetContainer(unsigned int WhichContainer)
Definition: G4TableTemplate.hh:94
void G4ENDFTapeRead::G4SetVerbosity ( G4int  WhatVerbosity)

Sets the verbosity levels

  • Usage:
    • WhichVerbosity: Combination of levels
  • Notes:
    • SILENT: All verbose output is repressed
    • UPDATES: Only high-level internal changes are reported
    • DAUGHTER_INFO: Displays information about daughter product sampling
    • NEUTRON_INFO: Displays information about neutron sampling
    • GAMMA_INFO: Displays information about gamma sampling
    • ALPHA_INFO: Displays information about alpha sampling
    • MOMENTUM_INFO: Displays information about momentum balancing
    • EXTRAPOLATION_INTERPOLATION_INFO: Displays information about any data extrapolation or interpolation that occurs
    • DEBUG: Reports program flow as it steps through functions
    • PRINT_ALL: Displays any and all output

Definition at line 165 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, and G4FFG_FUNCTIONLEAVE__.

Referenced by G4FissionProductYieldDist::G4SetVerbosity().

166 {
167 G4FFG_FUNCTIONENTER__
168 
169  this->Verbosity_ = WhatVerbosity;
170 
171 G4FFG_FUNCTIONLEAVE__
172 }
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215
void G4ENDFTapeRead::Initialize ( G4String  dataFile)
protected

Initialize is a common function called by all constructors.

Definition at line 88 of file G4ENDFTapeRead.cc.

References G4NeutronHPManager::GetDataStream(), and G4NeutronHPManager::GetInstance().

Referenced by G4ENDFTapeRead().

89 {
90  std::istringstream dataStream(std::ios::in);
91  G4NeutronHPManager::GetInstance()->GetDataStream(dataFile, dataStream);
92 
93  Initialize(dataStream);
94 }
G4ENDFTapeRead::Initialize
void Initialize(G4String dataFile)
Definition: G4ENDFTapeRead.cc:88
G4NeutronHPManager::GetInstance
static G4NeutronHPManager * GetInstance()
Definition: G4NeutronHPManager.hh:42
G4NeutronHPManager::GetDataStream
void GetDataStream(G4String, std::istringstream &iss)
Definition: G4NeutronHPManager.cc:64
void G4ENDFTapeRead::Initialize ( std::istringstream &  dataStream)
protected

Initialize is a common function calles by all constructors

Definition at line 97 of file G4ENDFTapeRead.cc.

References G4FFG_FUNCTIONENTER__, and G4FFG_FUNCTIONLEAVE__.

98 {
99 G4FFG_FUNCTIONENTER__
100 
101  EnergyGroups_ = 0;
102  EnergyGroupValues_ = NULL;
103 
104  YieldContainerTable_ = new G4TableTemplate< G4ENDFYieldDataContainer >;
105 
106  try
107  {
108  ReadInData(dataStream);
109  } catch (std::exception e)
110  {
111  delete YieldContainerTable_;
112 
113  G4FFG_FUNCTIONLEAVE__
114  throw e;
115  }
116 
117 G4FFG_FUNCTIONLEAVE__
118 }
G4FFG_FUNCTIONLEAVE__
#define G4FFG_FUNCTIONLEAVE__
Definition: G4FFGDebuggingMacros.hh:219
G4FFG_FUNCTIONENTER__
#define G4FFG_FUNCTIONENTER__
Definition: G4FFGDebuggingMacros.hh:215
The documentation for this class was generated from the following files:
Generated on Wed Apr 30 2014 15:56:23 for Geant4.10 by   doxygen 1.8.7