Geant4_10
Public Member Functions | Protected Member Functions | List of all members
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)
 
G4doubleG4GetEnergyGroupValues (void)
 
G4int G4GetNumberOfEnergyGroups (void)
 
G4int G4GetNumberOfFissionProducts (void)
 
G4ENDFYieldDataContainerG4GetYield (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.

Here is the call graph for this function:

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.

Here is the call graph for this function:

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.

Here is the call graph for this function:

G4ENDFTapeRead::~G4ENDFTapeRead ( void  )

Default Deconstructor

Definition at line 551 of file G4ENDFTapeRead.cc.

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.

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.

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.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Here is the caller graph for this function:

void G4ENDFTapeRead::Initialize ( G4String  dataFile)
protected

Initialize is a common function called by all constructors.

Definition at line 88 of file G4ENDFTapeRead.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

void G4ENDFTapeRead::Initialize ( std::istringstream &  dataStream)
protected

Initialize is a common function calles by all constructors

Definition at line 97 of file G4ENDFTapeRead.cc.


The documentation for this class was generated from the following files: