#include <NuclideSet.h>

Inheritance diagram for NuclideSet:

Public Types
typedef std::shared_ptr< NuclideSet >	SP

typedef std::shared_ptr< const NuclideSet >	SCP

Public Member Functions
	NuclideSet ()

	NuclideSet (Vec_Int ids)

	NuclideSet (Vec_Int ids, bool sort)

	NuclideSet (int, int, int, Vec_Int)

	NuclideSet (int, int, int, size_t, int *)

void	set_ids_legacy (int, int, int, Vec_Int)

void	set_ids_legacy (int, int, int, size_t, int *)

int	sizzzaaa_at (size_t) const

int	izzzaaa_at (size_t) const

int	zzzaaai_at (size_t) const

std::string	symbol_at (size_t) const

int	s_at (size_t) const

int	i_at (size_t) const

int	z_at (size_t) const

int	a_at (size_t) const

size_t	lookup_index (int sizzzaaa, bool fortran_offset=false) const

size_t	lookup_index_guess (int izzzaaa, bool fortran_offset=false) const

bool	lookup_index_all (Vec_Int *index_list, int izzzaaa, bool fortran_offset=false) const

SP_IdMap	sizzzaaa_lookup (bool fortran_offset=false) const
	map of sizzzaaa to index; More...

bool	mapping_sets (const Vec_Int &user_ids, Vec_Int user_to_master, Vec_Int master_to_user, bool fortran_offset=false) const

bool	mapping_sets (size_t nu, int const user_ids, int user_to_master, size_t nm, int *master_to_user, bool fortran_offset=false) const

bool	match (const NuclideSet &) const

bool	operator== (const NuclideSet &) const

std::string	print_compare (const NuclideSet &) const
	Compares (and stores in string) comparison between two NuclideSets. More...

std::map< int, int >	compare_nucl_lists (const NuclideSet &a, std::map< int, int > &loc_a, std::map< int, int > &loc_b) const
	Construct a map comparing nuclides on this set with another set. More...

const Vec_Int &	ids () const
	return a const reference to ids More...

SCP_Vec_Int	scp_ids () const
	return a shared (read-only) ids pointer More...

int const *	ids_array () const
	return view of ids vector More...

size_t	ids_size () const
	return size of ids vector More...

bool	has_ids () const
	return whether the class has a non-null ids More...

void	set_ids (const Vec_Int &)
	set the ids (copy operation) More...

void	get_ids (Vec_Int &) const
	populate an existing Vec_Int with a copy of ids More...

void	manageptr_ids (Vec_Int *&)
	set the ids (ownership transfer) More...

void	getptr_ids (Vec_Int const *&) const
	retrieve pointer (read-only) to ids More...

void	get_ids_array (size_t, int *) const
	get array of ids vector (Fortran) More...

void	set_ids_array (size_t, int *)
	set ids vector from array (Fortran) More...

int	ids_at (size_t) const
	get element of ids vector by index More...

size_t	total_nuclides () const

bool	has_sublibs () const

bool	has_sublib (int) const

size_t	count_sublibs () const

size_t	num_in_sublib (int) const

size_t	sublib_begin (int, bool fortran_offset=false) const

size_t	sublib_end (int) const

std::string	to_string () const

Scale::Json::Value	to_json () const

virtual int	serialize (Standard::AbstractStream *stream) const

virtual int	deserialize (Standard::AbstractStream *stream)

virtual unsigned long	getSerializedSize () const

virtual NuclideSet *	getCopy () const

virtual long	getUID () const

virtual bool	childOf (long parentUID) const

virtual std::string	toString () const

Static Public Member Functions
static void	convert_zzzaaai_to_sizzzaaa (int, int, int, Vec_Int *)

static void	convert_zzzaaai_to_izzzaaa (Vec_Int *)

static void	convert_symbol_to_izzzaaa (const Vec_Str &, Vec_Int *)

static void	convert_izzzaaa_to_symbol (const Vec_Int &, Vec_Str *)

static void	convert_sizzzaaa_to_zzzaaai (Vec_Int *ids)

static int	symbol_to_izzzaaa (std::string)

static std::string	izzzaaa_to_symbol (int)

static size_t	NOT_FOUND (bool fortran_offset=false)

static SP_IdMap	sizzzaaa_lookup (const Vec_Int &ids, bool fortran_offset=false)
	map of sizzzaaa to index; More...

static SP_IdMap	sizzzaaa_lookup (size_t n, const int *ids, bool fortran_offset=false)

static bool	match (const NuclideSet &, const NuclideSet &)

static bool	has_sublibs (const Vec_Int &)

static bool	has_sublibs (size_t, int const *)

static bool	get_sublibs (Vec_Int , size_t, int const )

static void	sort_mass (Vec_Int *izzzaaa_list)

static void	sort_isomeric (Vec_Int *izzzaaa_list)

static void	sort_standard (Vec_Int *sizzzaaa_list)

static bool	looks_like_zzzaaai (const Vec_Int &ids)

Static Public Attributes
static const long	uid = 0x96516764f6b06c5d

Protected Member Functions
void	canonicalize_ids ()

Static Protected Member Functions
static bool	mapping_sets (const std::vector< int > &sublibs0, size_t nu, int const user_ids, int user_to_master, size_t nm, SCP_IdMap master_id_map, int *master_to_user, bool fortran_offset=false)

static bool	sublib_search_standard (const std::vector< int > &sublibs0, size_t i, int user_to_master, SCP_IdMap master_id_map, int master_to_user, int offset, int id)

Protected Attributes
SP_Vec_Int	b_ids

Private Attributes
bool	b_has_sublibs

Vec_Int	b_sublib_range

SCP_IdMap	b_map

bool	b_sort

Friends
class	ScaleUtils::IO::Accessor< NuclideSet >

Detailed Description

Examples:: tstConcentrations.cpp, tstLibrary.cpp, tstNuclideSet.cpp, tstStateSet.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

Member Typedef Documentation

typedef std::shared_ptr<NuclideSet> SP

typedef std::shared_ptr<const NuclideSet> SCP

Constructor & Destructor Documentation

NuclideSet ( )

NuclideSet ( Vec_Int ids )

References NuclideSet::b_ids, and NuclideSet::canonicalize_ids().

NuclideSet	(	Vec_Int	ids,
		bool	sort
	)

References NuclideSet::b_ids, and NuclideSet::canonicalize_ids().

NuclideSet	(	int	nlt,
		int	nac,
		int	nfp,
		Vec_Int	ids
	)

References NuclideSet::b_sort, NuclideSet::b_sublib_range, and NuclideSet::set_ids_legacy().

NuclideSet	(	int	nlt,
		int	nac,
		int	nfp,
		size_t	n,
		int *	ids
	)

References NuclideSet::b_sort, NuclideSet::b_sublib_range, and NuclideSet::set_ids_legacy().

Member Function Documentation

void set_ids_legacy	(	int	nlt,
		int	nac,
		int	nfp,
		Vec_Int	ids
	)

Examples:: tstLibrary.cpp.

Referenced by Origen::createNuclideSet_random1(), FakeFactory::newspLibrary_10nuclide(), FakeFactory::newspStateSet_10nuclide(), NuclideSet::NuclideSet(), StateSetIO_s62b::read(), and LibraryTest::SetUp().

void set_ids_legacy	(	int	nlt,
		int	nac,
		int	nfp,
		size_t	n,
		int *	ids
	)

References NuclideSet::b_ids, NuclideSet::canonicalize_ids(), and NuclideSet::convert_zzzaaai_to_sizzzaaa().

void convert_zzzaaai_to_sizzzaaa	(	int	nlt,
		int	nac,
		int	nfp,
		Vec_Int *	ids
	)

static

Referenced by NuclideSet::set_ids_legacy().

void convert_zzzaaai_to_izzzaaa ( Vec_Int * ids )

static

Referenced by TransitionMatrixP::find_nuclide(), TransitionMatrixP::find_nuclide_all(), and TransitionMatrixP::find_nuclide_guess().

void convert_symbol_to_izzzaaa	(	const Vec_Str &	symbols,
		Vec_Int *	ids
	)

static

Referenced by Origen_NuclideSet_convert_symbol_to_izzzaaa().

void convert_izzzaaa_to_symbol	(	const Vec_Int &	ids,
		Vec_Str *	symbols
	)

static

void convert_sizzzaaa_to_zzzaaai ( Vec_Int * ids )

static

Referenced by Origen_NuclideSet_convert_sizzzaaa_to_zzzaaai(), Origen::populateFissionables(), LibraryIO_s62b::write(), LibraryIO_s61::write(), and StateSetIO_s62b::write().

int symbol_to_izzzaaa ( std::string symbol )

static

Referenced by Origen::thinLibrary().

std::string izzzaaa_to_symbol ( int id )

static

Referenced by NuclideSet::symbol_at().

int sizzzaaa_at ( size_t i ) const

Examples:: tstTransitionSystemAdapter_DecayResource.cpp.

References NuclideSet::b_ids.

int izzzaaa_at ( size_t i ) const

Examples:: tstTransitionSystemAdapter_DecayResource.cpp.

References NuclideSet::b_ids.

Referenced by TransitionSystemAdapter_TransitionMatrix::extend(), gtestLibraryMasses(), Origen::populateLibraryHeader_YieldResource(), Origen::populateLibraryMass_NuclideResource(), and NuclideSet::symbol_at().

int zzzaaai_at ( size_t i ) const

References NuclideSet::b_ids.

Referenced by Origen::populateLibraryHeader_YieldResource().

std::string symbol_at ( size_t j ) const

References NuclideSet::izzzaaa_at(), and NuclideSet::izzzaaa_to_symbol().

int s_at ( size_t j ) const

References NuclideSet::b_ids.

Referenced by LibraryBuilder::create_library(), Origen::populateLibraryHeader_YieldResource(), and Origen::tabulateMaterialFission().

int i_at ( size_t j ) const

References NuclideSet::b_ids.

Referenced by Origen::tabulateReactionTransitions().

int z_at ( size_t j ) const

References NuclideSet::b_ids.

Referenced by DecayData::mass().

int a_at ( size_t j ) const

Examples:: tstTransitionSystemAdapter_DecayResource.cpp.

References NuclideSet::b_ids.

Referenced by gtestLibraryMasses().

size_t lookup_index	(	int	sizzzaaa,
		bool	fortran_offset = `false`
	)		const

Examples:: tstTransitionSystemAdapter_DecayResource.cpp.

References NuclideSet::b_map, and NuclideSet::NOT_FOUND().

Referenced by TEST_F().

size_t lookup_index_guess	(	int	izzzaaa,
		bool	fortran_offset = `false`
	)		const

References NuclideSet::ids(), NuclideSet::mapping_sets(), and NuclideSet::NOT_FOUND().

Referenced by TEST(), and Origen::thinLibrary().

bool lookup_index_all	(	Vec_Int *	index_list,
		int	izzzaaa,
		bool	fortran_offset = `false`
	)		const

References NuclideSet::ids(), and NuclideSet::mapping_sets().

size_t NOT_FOUND ( bool fortran_offset = false )

static

Referenced by NuclideSet::canonicalize_ids(), NuclideSet::lookup_index(), NuclideSet::lookup_index_guess(), Concentrations::lookup_val(), NuclideSet::mapping_sets(), TransitionMatrixP::NOT_FOUND(), and Origen_NuclideSet_NOT_FOUND().

SP_IdMap sizzzaaa_lookup ( bool fortran_offset = false ) const

map of sizzzaaa to index;

References NuclideSet::b_ids.

Referenced by NuclideSet::canonicalize_ids(), get_transition_data(), inject_fission_yields(), NuclideSet::mapping_sets(), and NuclideSet::sizzzaaa_lookup().

SP_IdMap sizzzaaa_lookup	(	const Vec_Int &	ids,
		bool	fortran_offset = `false`
	)

static

map of sizzzaaa to index;

References NuclideSet::sizzzaaa_lookup().

static SP_IdMap sizzzaaa_lookup	(	size_t	n,
		const int *	ids,
		bool	fortran_offset = `false`
	)

static

bool mapping_sets	(	const Vec_Int &	user_ids,
		Vec_Int *	user_to_master,
		Vec_Int *	master_to_user,
		bool	fortran_offset = `false`
	)		const

master[user_to_master[u]] += user_izzzaaa[u]; master[m] += user[master_to_user[m]];

References NuclideSet::ids_size(), and NuclideSet::NOT_FOUND().

Referenced by NuclideSet::lookup_index_all(), NuclideSet::lookup_index_guess(), and NuclideSet::mapping_sets().

bool mapping_sets	(	size_t	nu,
		int const *	user_ids,
		int *	user_to_master,
		size_t	nm,
		int *	master_to_user,
		bool	fortran_offset = `false`
	)		const

master[user_to_master[u]] += user_izzzaaa[u]; master[m] += user[master_to_user[m]];

References NuclideSet::b_ids, NuclideSet::b_map, NuclideSet::get_sublibs(), NuclideSet::has_sublib(), NuclideSet::has_sublibs(), NuclideSet::ids_size(), NuclideSet::mapping_sets(), and NuclideSet::sizzzaaa_lookup().

bool match	(	const NuclideSet &	a,
		const NuclideSet &	b
	)

static

References NuclideSet::match().

Referenced by NuclideSet::match().

bool match ( const NuclideSet & a ) const

References NuclideSet::b_ids.

bool operator== ( const NuclideSet & a ) const

References NuclideSet::b_ids, and NuclideSet::ids().

std::string print_compare ( const NuclideSet & a ) const

Compares (and stores in string) comparison between two NuclideSets.

Parameters

The	NuclideSet to compare to.

References NuclideSet::compare_nucl_lists().

std::map< int, int > compare_nucl_lists	(	const NuclideSet &	a,
		std::map< int, int > &	loc_a,
		std::map< int, int > &	loc_b
	)		const

Construct a map comparing nuclides on this set with another set.

Parameters

a	NuclideSet to compare to.

Returns: A map containing the results.

The resulting map will contain pairs that have the same IZA in the first and second position on if the nuclide exists on both sets. If it exists on only the first set, the second value on the pair will be -1. If it exists on only the second set, the second value on the pair will be -2.

References NuclideSet::b_ids.

Referenced by NuclideSet::print_compare().

const Vec_Int & ids ( ) const

return a const reference to ids

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Invalid if this instance of NuclideSet goes out of scope.

Examples:: tstConcentrations.cpp, tstNuclideSet.cpp, tstStateSet.cpp, and tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by Concentrations::accumulate_concs(), NuclideSet::canonicalize_ids(), TransitionSystemAdapter_TransitionMatrix::extend(), Material::get_concs_at(), get_decay_data(), get_transition_data(), Origen::graphvizLibrary(), inject_fission_yields(), NuclideSet::lookup_index_all(), NuclideSet::lookup_index_guess(), NuclideSet::operator==(), Origen::populateLibraryAbundance_NuclideResource(), Origen::populateLibraryDecayEnergy_DecayResource(), Origen::populateLibraryMass(), Origen::populateLibraryToxicity_DecayResource(), LibraryIO_s61::read(), LibraryIO_bof::read(), LibraryIO_s62b::read(), Material::set_concs_at(), Origen::tabulateFissionXs(), Origen::tabulateLossXs(), Origen::tabulateNuclideInfo(), TEST(), timing_ref(), timing_ref_at(), StateSetIO_bof::write(), StateSetIO_s62b::write(), LibraryIO_bof::write(), and LibraryIO_s62b::write().

SCP_Vec_Int scp_ids ( ) const

return a shared (read-only) ids pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:: tstNuclideSet.cpp.

Referenced by TEST().

Vec_Int::value_type const * ids_array ( ) const

return view of ids vector

Auto-generated from macro #ORIGEN_ACCESSORS_SP_VECTOR().

Referenced by StateSetIO_s62b::write().

size_t ids_size ( ) const

return size of ids vector

Auto-generated from macro #ORIGEN_ACCESSORS_SP_VECTOR().

Examples:: tstTransitionSystemAdapter_DecayResource.cpp.

Referenced by Origen::construct_coeff_map(), LibraryBuilder::create_library(), gtestLibrarySizes(), NuclideSet::mapping_sets(), DecayData::mass(), Origen::populateLibraryHeader_YieldResource(), Origen::tabulateFissionXs(), Origen::tabulateLossXs(), Origen::tabulateMaterialFission(), Origen::tabulateMaterialTransitionRates(), Origen::tabulateReactionTransitions(), Origen::tabulateTransitionCoeff(), and LibraryIO_s62b::write().

bool has_ids ( ) const

return whether the class has a non-null ids

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void set_ids ( const Vec_Int & ids )

set the ids (copy operation)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:: tstConcentrations.cpp, tstNuclideSet.cpp, and tstStateSet.cpp.

Referenced by Origen::populateLibraryHeader_YieldResource(), StateSetIO_bof::read(), StateSetIO_s62b::read(), LibraryIO_bof::read(), TEST(), and TEST_P().

void get_ids ( Vec_Int & ids ) const

populate an existing Vec_Int with a copy of ids

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Origen::diffConcentrations(), TransitionMatrixUpdater::load(), and LibraryIO_s61::write().

void manageptr_ids ( Vec_Int *& ids )

set the ids (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void getptr_ids ( Vec_Int const *& ids ) const

retrieve pointer (read-only) to ids

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:: tstNuclideSet.cpp.

void get_ids_array	(	size_t	,
		int *
	)		const

get array of ids vector (Fortran)

void set_ids_array	(	size_t	,
		int *
	)

set ids vector from array (Fortran)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_VECTOR().

Vec_Int::value_type ids_at ( size_t i ) const

get element of ids vector by index

Auto-generated from macro #ORIGEN_ACCESSORS_SP_VECTOR().

Examples:: tstConcentrations.cpp, tstNuclideSet.cpp, tstStateSet.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

Referenced by Origen::construct_coeff_map(), Origen::construct_neutron_prod_map(), Origen::construct_neutron_yields_map(), DecayResource::DecayResource(), Origen::tabulateFissionXs(), Origen::tabulateLossXs(), Origen::tabulateMaterialFission(), Origen::tabulateMaterialTransitionRates(), Origen::tabulateReactionTransitions(), Origen::tabulateTransitionCoeff(), TEST(), and TEST_F().

size_t total_nuclides ( ) const

Examples:: tstNuclideSet.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

Referenced by TransitionCoeff::capture_power(), Origen::createDecayData_random1(), Origen::createTransitionCoeff_random1(), Origen::createTransitionStructure_random1(), DecayResource::DecayResource(), TransitionCoeff::fission_power(), gtestLibraryMasses(), gtestLibrarySizes(), Origen::populateLibraryMass_NuclideResource(), TransitionCoeff::reaction_power(), TEST(), LibraryIO_s62b::write(), and LibraryIO_s61::write().

bool has_sublibs ( ) const

Examples:: tstConcentrations.cpp, and tstNuclideSet.cpp.

References NuclideSet::b_has_sublibs.

Referenced by NuclideSet::count_sublibs(), NuclideSet::has_sublibs(), NuclideSet::mapping_sets(), NuclideSet::num_in_sublib(), Origen::populateLibraryAbundance_NuclideResource(), NuclideSet::sublib_begin(), NuclideSet::sublib_end(), TEST(), and LibraryIO_s62b::write().

bool has_sublib ( int s ) const

Examples:: tstNuclideSet.cpp.

References NuclideSet::num_in_sublib().

Referenced by TransitionCoeff::fission_xs_index(), NuclideSet::mapping_sets(), Origen::populateLibraryAbundance_NuclideResource(), and LibraryIO_s61::write().

size_t count_sublibs ( ) const

References NuclideSet::has_sublibs(), and NuclideSet::num_in_sublib().

Referenced by Case::load_new_concentrations(), StateSetIO_s62b::write(), LibraryIO_s62b::write(), and LibraryIO_s61::write().

size_t num_in_sublib ( int s ) const

Examples:: tstNuclideSet.cpp, and tstTransitionSystemAdapter_DecayResource.cpp.

References NuclideSet::b_sublib_range, and NuclideSet::has_sublibs().

Referenced by NuclideSet::count_sublibs(), Origen::createDecayData_random1(), Origen::createTransitionCoeff_random1(), get_decay_data(), get_transition_data(), gtestLibrarySizes(), NuclideSet::has_sublib(), inject_fission_yields(), FakeFactory::newspLibrary_10nuclide(), Origen::populateLibraryAbundance_NuclideResource(), TEST(), LibraryIO_s61::write(), LibraryIO_s62b::write(), and StateSetIO_s62b::write().

size_t sublib_begin	(	int	s,
		bool	fortran_offset = `false`
	)		const

References NuclideSet::b_sublib_range, and NuclideSet::has_sublibs().

Referenced by TransitionSystemAdapter_TransitionMatrix::extend(), and TransitionCoeff::fission_xs_index().

size_t sublib_end ( int s ) const

References NuclideSet::b_sublib_range, and NuclideSet::has_sublibs().

Referenced by TransitionCoeff::fission_xs_index().

bool has_sublibs ( const Vec_Int & ids )

static

References NuclideSet::has_sublibs().

bool has_sublibs	(	size_t	n,
		int const *	ids
	)

static

bool get_sublibs	(	Vec_Int *	sublibs,
		size_t	n,
		int const *	ids
	)

static

Referenced by NuclideSet::mapping_sets().

std::string to_string ( ) const

Examples:: tstNuclideSet.cpp.

References NuclideSet::to_json().

Referenced by TEST().

Json::Value to_json ( ) const

References NuclideSet::b_ids, NuclideSet::b_sublib_range, and NuclideSet::uid.

Referenced by NuclideSet::to_string().

int serialize ( Standard::AbstractStream * stream ) const

virtual

Examples:: tstNuclideSet.cpp.

Referenced by TEST().

int deserialize ( Standard::AbstractStream * stream )

virtual

Examples:: tstNuclideSet.cpp.

Referenced by TEST().

unsigned long getSerializedSize ( ) const

virtual

NuclideSet * getCopy ( ) const

virtual

long getUID ( ) const

virtual

bool childOf ( long parentUID ) const

virtual

std::string toString ( ) const

virtual

void sort_mass ( Vec_Int * izzzaaa_list )

static

Referenced by main().

void sort_isomeric ( Vec_Int * izzzaaa_list )

static

void sort_standard ( Vec_Int * sizzzaaa_list )

static

References Origen::SUBLIB_3FP.

Referenced by NuclideSet::canonicalize_ids().

bool looks_like_zzzaaai ( const Vec_Int & ids )

static

Referenced by LibraryIO_s61::read(), StateSetIO_s62b::read(), and LibraryIO_s62b::read().

void canonicalize_ids ( )

protected

References NuclideSet::b_has_sublibs, NuclideSet::b_ids, NuclideSet::b_map, NuclideSet::b_sort, NuclideSet::b_sublib_range, NuclideSet::ids(), NuclideSet::NOT_FOUND(), NuclideSet::sizzzaaa_lookup(), and NuclideSet::sort_standard().

Referenced by NuclideSet::NuclideSet(), Accessor< Origen::NuclideSet >::read(), and NuclideSet::set_ids_legacy().

bool mapping_sets	(	const std::vector< int > &	sublibs,
		size_t	nu,
		int const *	user_ids,
		int *	user_to_master,
		size_t	nm,
		SCP_IdMap	master_id_map,
		int *	master_to_user,
		bool	fortran_offset = `false`
	)

staticprotected

master[user_to_master[u]] += user_izzzaaa[u]; master[m] += user[master_to_user[m]];

References NuclideSet::has_sublibs(), NuclideSet::NOT_FOUND(), and NuclideSet::sublib_search_standard().

bool sublib_search_standard	(	const std::vector< int > &	sublibs0,
		size_t	i,
		int *	user_to_master,
		SCP_IdMap	master_id_map,
		int *	master_to_user,
		int	offset,
		int	id
	)