#include <LibraryIO_bof.h>

Inheritance diagram for LibraryIO_bof:

Public Member Functions
bool	read (Library &obj, std::istream &stream, ScaleUtils::IO::DB opts)
	The read function opens the Origen library file on the disk and pulls all of the data off and converts it from the BOF data format into the appropriate format for the library object and creates that library object. This is done for both the burn-up dependent and independent data. More...

bool	write (const Library &obj, std::ostream &stream, ScaleUtils::IO::DB opts)
	The write function opens the objects on an Origen library and puts them into the appropriate BOF data type and adds them to the library object. Once all of the parts are added, the object is written to the file. The burnup steps are written as a separate object from the rest. More...

Member Function Documentation

bool read	(	Library &	lib,
		std::istream &	stream,
		ScaleUtils::IO::DB	opts
	)

The read function opens the Origen library file on the disk and pulls all of the data off and converts it from the BOF data format into the appropriate format for the library object and creates that library object. This is done for both the burn-up dependent and independent data.

Parameters

lib	- Reference to the library object into which the data will be loaded.
stream	- Output stream.
opts	- Object into which errors and information about the library is stored.

Returns: bool - True if read was successful. False otherwise.

All data tags are the same as the write function.

bool write	(	const Library &	lib,
		std::ostream &	stream,
		ScaleUtils::IO::DB	opts
	)

The write function opens the objects on an Origen library and puts them into the appropriate BOF data type and adds them to the library object. Once all of the parts are added, the object is written to the file. The burnup steps are written as a separate object from the rest.

Parameters

lib	- A reference to the library object to be written.
stream	- Output stream.
opts	- A central point for errors and information about the file and operations in this function.

Returns: - True if successful write. False otherwise.

Burnup Independent Data:

Record 1 -
"tnu" - [int] Total number of nuclides.
"nle" - [int] Number of light nuclides.
"nan" - [int] Number of actinide nuclides.
"nfp" - [int] Number of fission product nuclides.
"ntc" - [int] Total number of transitions.
"mon" - [int] Month that the library was made.
"day" - [int] Day that the library was made.
"yrm" - [int] Year that the library was made.
"nne" - [int] Number of neutron energy groups.
"nfn" - [int] Number of fissionable nuclides.

Record 2 -
"ttl" - [string] Title as found on the library header.

Record 3 -
"nid" - [array[int]] List of nuclide IDs.

Record 4 -
"TagManager" "idn" - [array[string]] List of ID tag names.
"idv" - [array[string]] List of ID tag values.
"itn" - [array[string]] List of interpolatable tag names.
"itv" - [array[double]] List of interpolatable tag values.

Record 5 -
"fni" - [array[int]] List of fissionable nuclides.

Record 6 -
"nnp" - [array[int]] List of decay parent nuclides.

Record 7 -
"tpn" - [array[int]] Complete list of parent nuclides.

Record 8 -
"ppl" - [array[int]] Location of parents, tstruct of parent positions.

Record 9 -
"mtl" - [array[int]]

Record 10 -
"dcc" - [array[float]] List of decay constants.

Record 11 -
"rev" - [array[float]] List of recoverable energies.

Record 12 -
"qfp" - [array[float]]

Record 13 -
"rfa" - [array[float]] RCG for air.

Record 14 -
"rfw" - [array[float]] RCG for water.

Record 15 -
"aap" - [array[float]] Abundances.

Burnup Dependent Data:

Record 1 -
"bu" - [float] Burnup.

Record 2 -
"ma" - [array[float]] tstruct transitions.

Record 3 -
"tr" - [array[float]] Total capture cross sections.

Record 4 -
"fx" - [array[float]] Fission cross sections.

Record 5 -
"ny" - [array[float]] Neutron yields.

Record 6 -
"fl" - [array[float]] Flux spectrum used to generate the library.

References DecayData::abund_of_lite_nuclides, TransitionCoeff::burnup(), LibraryHeader::day_made(), DecayData::decay_constants, Library::decay_data(), Library::definition(), TransitionCoeff::fission_xs(), DecayData::fissionable_nuclide_ids, TransitionCoeff::flux(), TransitionCoeff::flux_size(), NuclideSet::ids(), TransitionCoeff::loss_xs(), DecayData::masses, TransitionCoeff::matrix(), LibraryHeader::month_made(), TransitionCoeff::neutron_yields(), LibraryHeader::nuclide_set(), TransitionStructure::num_decay_parents(), TransitionStructure::num_parents(), TransitionStructure::parent_positions(), DecayData::q_fractions_from_photons, DecayData::rcg_for_air, DecayData::rcg_for_water, DecayData::recoverable_energy_values, Origen::setAppVersionWrite(), Library::tag_manager(), LibraryHeader::title(), TransitionStructure::total_transitions(), Library::transition_coeff_at(), Library::transition_coeff_size(), TransitionStructure::transition_ids(), Library::transition_structure(), Origen::write(), and LibraryHeader::year_made().

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

Core/io/LibraryIO_bof.h
Core/io/LibraryIO_bof.cpp

Public Member Functions

Member Function Documentation