G4ENDFTapeRead Class Reference

#include <G4ENDFTapeRead.hh>

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

Protected Member Functions
void	Initialize (const 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 47 of file G4ENDFTapeRead.hh.

Constructor & Destructor Documentation

G4ENDFTapeRead() [1/3]

G4ENDFTapeRead::G4ENDFTapeRead	(	const G4String &	FileLocation,
		const 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 47 of file G4ENDFTapeRead.cc.

  : /* Cause_(WhichCause),*/
    Verbosity_(G4FFGDefaultValues::Verbosity),
    YieldType_(WhichYield)
{
  // Initialize the class
  Initialize(FileLocation + FileName);
}

G4ENDFTapeRead() [2/3]

G4ENDFTapeRead::G4ENDFTapeRead	(	const G4String &	FileLocation,
		const 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 58 of file G4ENDFTapeRead.cc.

  : /*Cause_(WhichCause),*/
    Verbosity_(Verbosity),
    YieldType_(WhichYield)
{
  // Initialize the class
  Initialize(FileLocation + FileName);
}

G4ENDFTapeRead() [3/3]

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 69 of file G4ENDFTapeRead.cc.

  : /*Cause_(WhichCause),*/
    Verbosity_(Verbosity),
    YieldType_(WhichYield)
{
  // Initialize the class
  Initialize(dataStream);
}

~G4ENDFTapeRead()

G4ENDFTapeRead::~G4ENDFTapeRead

(

)

Default Deconstructor

Definition at line 524 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  delete[] EnergyGroupValues_;
  delete YieldContainerTable_;
 
  G4FFG_FUNCTIONLEAVE__
}

Member Function Documentation

G4GetEnergyGroupValues()

G4double * G4ENDFTapeRead::G4GetEnergyGroupValues

(

)

const

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

• Usage: No arguments required
• Notes:

Definition at line 110 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  G4FFG_FUNCTIONLEAVE__
  return EnergyGroupValues_;
}

G4GetNumberOfEnergyGroups()

G4int G4ENDFTapeRead::G4GetNumberOfEnergyGroups

(

)

const

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

• Usage: No arguments required
• Notes:

Definition at line 118 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  G4FFG_FUNCTIONLEAVE__
  return EnergyGroups_;
}

G4GetNumberOfFissionProducts()

G4int G4ENDFTapeRead::G4GetNumberOfFissionProducts

(

)

const

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

• Usage: No arguments required
• Notes:

Definition at line 126 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  auto NumberOfElements = (G4int)YieldContainerTable_->G4GetNumberOfElements();
 
  G4FFG_FUNCTIONLEAVE__
  return NumberOfElements;
}

G4GetYield()

G4ENDFYieldDataContainer * G4ENDFTapeRead::G4GetYield

(

G4int

WhichYield

)

const

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 136 of file G4ENDFTapeRead.cc.

{
  G4FFG_DATA_FUNCTIONENTER__
 
  G4ENDFYieldDataContainer* Container = nullptr;
  if (WhichYield >= 0 && WhichYield < YieldContainerTable_->G4GetNumberOfElements()) {
    Container = YieldContainerTable_->G4GetContainer(WhichYield);
  }
 
  G4FFG_DATA_FUNCTIONLEAVE__
  return Container;
}

G4SetVerbosity()

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 149 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  this->Verbosity_ = WhatVerbosity;
 
  G4FFG_FUNCTIONLEAVE__
}

Initialize() [1/2]

void G4ENDFTapeRead::Initialize ( const G4String & dataFile )

protected

Initialize is a common function called by all constructors.

Definition at line 80 of file G4ENDFTapeRead.cc.

{
  std::istringstream dataStream(std::ios::in);
  G4ParticleHPManager::GetInstance()->GetDataStream(dataFile, dataStream);
 
  Initialize(dataStream);
}

Referenced by G4ENDFTapeRead(), G4ENDFTapeRead(), G4ENDFTapeRead(), and Initialize().

Initialize() [2/2]

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

protected

Initialize is a common function calles by all constructors

Definition at line 88 of file G4ENDFTapeRead.cc.

{
  G4FFG_FUNCTIONENTER__
 
  EnergyGroups_ = 0;
  EnergyGroupValues_ = nullptr;
 
  YieldContainerTable_ = new G4TableTemplate<G4ENDFYieldDataContainer>;
 
  try {
    ReadInData(dataStream);
  }
  catch (std::exception& e) {
    delete YieldContainerTable_;
 
    G4FFG_FUNCTIONLEAVE__
    throw e;
  }
 
  G4FFG_FUNCTIONLEAVE__
}

---

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

• G4ENDFTapeRead.hh
• G4ENDFTapeRead.cc