ORIGEN API: YieldResource Class Reference

#include <YieldResource.h>

Inheritance diagram for YieldResource:

Public Member Functions
	YieldResource ()

	~YieldResource ()

YieldParent *	fissionable (int izzzaaa)
	get fissionable nuclide (null if not present) More...

const YieldParent *	fissionable (int izzzaaa) const
	get fissionable nuclide (null if not present) More...

YieldParent &	add_fissionable (int izzzaaa)
	add new fissionable nuclide (return if present) More...

int	num_fissionables () const
	num fissionable nuclides More...

bool	has_fissionable (int izzzaaa) const
	fissionable nuclide with that izzzaaa exists More...

int	fissionable_index (int izzzaaa) const
	index of fissionable (-1 if not present) More...

void	get_fissionable_ids (Vec_Int *) const
	get fissionable nuclide ids More...

const YieldParent &	fissionable_at (int index) const
	fissionable at More...

YieldParent &	fissionable_at (int index)
	fissionable at More...

void	clear ()
	clear contents More...

void	get_all_energies (Vec_Dbl *energies) const
	get all energies More...

int	num_fps (int izzzaaa) const
	num fission products More...

void	get_interp_data (Vec_Int fp_izzzaaa_list, Vec_Vec_Dbl yields, const double energy, const int interp=INTERP_PREFERRED) const
	compute fission yields for all isotopes from an energy More...

bool	has_fp (int izzzaaa, const int fp_izzzaaa) const
	fissionable nuclide has a yield defined More...

double	interp_yield (int izzzaaa, int fp_izzzaaa, double energy, int interp_method=INTERP_PREFERRED) const
	interp yield More...

bool	remove_fissionable (int izzzaaa)
	remove one fissionable More...

void	set_fissionable_ids (const Vec_Int &ids)
	keep only these fissionables More...

void	set_fp_ids (const Vec_Int &ids)
	keep only these fp across all fissionables More...

bool	check (Vec_Str &errors) const
	perform all checks More...

bool	check_consistency (Vec_Str &errors) const
	check consistency More...

bool	check_ids (Vec_Str &errors) const
	check ids More...

std::string	to_string () const
	convert to string More...

Scale::Json::Value	to_json () const
	deprecated More...

Protected Member Functions
const ParentMap_t &	fissionable_map () const
	get const parent map More...

ParentMap_t &	fissionable_map ()
	get parent map More...

const std::vector< YieldParent > &	fissionables () const
	get const fissionables vector More...

std::vector< YieldParent > &	fissionables ()
	get fissionables vector More...

Private Attributes
ParentMap_t	b_fissionable_map

std::vector< YieldParent >	b_fissionables

Detailed Description

Examples:: tstTransitionSystemAdapter_AmpxN.cpp, tstYieldResource.cpp, and tstYieldResourceIO.cpp.

Constructor & Destructor Documentation

YieldResource ( )

~YieldResource ( )

Member Function Documentation

YieldParent * fissionable ( int izzzaaa )

get fissionable nuclide (null if not present)

Examples:: tstYieldResource.cpp.

Referenced by YieldResource::has_fp(), inject_fission_yields(), YieldResource::interp_yield(), YieldResource::num_fps(), Origen::populateLibraryHeader_YieldResource(), Origen::printInterpolatedYields(), and TEST().

const YieldParent * fissionable ( int izzzaaa ) const

get fissionable nuclide (null if not present)

References YieldResource::b_fissionables, and YieldResource::fissionable_index().

YieldParent & add_fissionable ( int izzzaaa )

add new fissionable nuclide (return if present)

Examples:: tstYieldResource.cpp.

References YieldResource::b_fissionable_map, YieldResource::b_fissionables, YieldResource::fissionable_index(), and YieldResource::num_fissionables().

Referenced by main(), YieldResourceIO_stab1::read(), YieldResourceIO_ampx::read(), and TEST().

int num_fissionables ( ) const

num fissionable nuclides

References YieldResource::b_fissionables.

Referenced by YieldResource::add_fissionable(), YieldResource::fissionable_at(), YieldResource::get_all_energies(), ReactionResource::import_fission_yields(), Origen::loadMulti(), main(), print_yield_data(), Origen::printYieldEnergies(), Origen::printYields(), YieldResource::to_json(), YieldResourceIO_stab1::write(), and YieldResourceIO_ampx::write().

bool has_fissionable ( int izzzaaa ) const

fissionable nuclide with that izzzaaa exists

References YieldResource::fissionable_index().

Referenced by Origen::printInterpolatedYields().

int fissionable_index ( int izzzaaa ) const

index of fissionable (-1 if not present)

References YieldResource::b_fissionable_map.

Referenced by YieldResource::add_fissionable(), YieldResource::fissionable(), YieldResource::has_fissionable(), YieldResource::remove_fissionable(), and YieldResource::set_fissionable_ids().

void get_fissionable_ids ( Vec_Int * ids ) const

get fissionable nuclide ids

References YieldResource::b_fissionable_map.

Referenced by main(), Origen::printYieldEnergies(), and Origen::printYields().

const YieldParent & fissionable_at ( int index ) const

fissionable at

References YieldResource::b_fissionables, and YieldResource::num_fissionables().

Referenced by YieldResource::fissionable_at(), YieldResource::get_all_energies(), ReactionResource::import_fission_yields(), main(), print_yield_data(), Origen::printYieldEnergies(), Origen::printYields(), YieldResource::to_json(), YieldResourceIO_ampx::write(), and YieldResourceIO_stab1::write().

YieldParent & fissionable_at ( int index )

fissionable at

References YieldResource::fissionable_at().

void clear ( )

clear contents

References YieldResource::b_fissionable_map, and YieldResource::b_fissionables.

Referenced by YieldResourceIO_stab1::read().

void get_all_energies ( Vec_Dbl * energies ) const

get all energies

Examples:: tstYieldResource.cpp.

References YieldResource::fissionable_at(), YieldParent::get_energies(), and YieldResource::num_fissionables().

Referenced by TEST().

int num_fps ( int izzzaaa ) const

num fission products

References YieldResource::fissionable(), and YieldParent::num_fps().

Referenced by YieldResource::set_fp_ids().

void get_interp_data	(	Vec_Int *	fp_izzzaaa_list,
		Vec_Vec_Dbl *	yields,
		const double	energy,
		const int	interp = `INTERP_PREFERRED`
	)		const

compute fission yields for all isotopes from an energy

bool has_fp	(	int	izzzaaa,
		const int	fp_izzzaaa
	)		const

fissionable nuclide has a yield defined

References YieldResource::fissionable(), and YieldParent::has_fp().

double interp_yield	(	int	izzzaaa,
		int	fp_izzzaaa,
		double	energy,
		int	interp_method = `INTERP_PREFERRED`
	)		const

interp yield

References YieldResource::fissionable(), and YieldParent::interp_yield().

bool remove_fissionable ( int izzzaaa )

remove one fissionable

References YieldResource::b_fissionable_map, YieldResource::b_fissionables, YieldResource::fissionable_index(), and YieldResource::fissionable_map().

void set_fissionable_ids ( const Vec_Int & ids )

keep only these fissionables

References YieldResource::b_fissionable_map, YieldResource::b_fissionables, YieldResource::fissionable_index(), YieldResource::fissionable_map(), and YieldResource::fissionables().

void set_fp_ids ( const Vec_Int & ids )

keep only these fp across all fissionables

References YieldResource::b_fissionables, and YieldResource::num_fps().

Referenced by main().

bool check ( Vec_Str & errors ) const

perform all checks

References YieldResource::check_consistency(), and YieldResource::check_ids().

Referenced by main().

bool check_consistency ( Vec_Str & errors ) const

check consistency

References YieldResource::b_fissionable_map, YieldResource::b_fissionables, YieldParent::data(), YieldData::energy(), YieldParent::fp_map(), YieldParent::id(), Origen::IMPLICIT_BYPRODUCT_MAX_MASSNUMBER, Origen::YIELD_TOLERANCE, and YieldData::yields().

Referenced by YieldResource::check().

bool check_ids ( Vec_Str & errors ) const

check ids

References YieldResource::b_fissionable_map.

Referenced by YieldResource::check().

std::string to_string ( ) const

convert to string

References YieldResource::to_json().

Json::Value to_json ( ) const

deprecated

References YieldParent::data(), YieldResource::fissionable_at(), YieldParent::get_fp_ids(), YieldParent::id(), YieldParent::interp_method(), and YieldResource::num_fissionables().

Referenced by YieldResource::to_string().

const ParentMap_t & fissionable_map ( ) const

protected

get const parent map

References YieldResource::b_fissionable_map.

Referenced by YieldResource::remove_fissionable(), and YieldResource::set_fissionable_ids().

ParentMap_t & fissionable_map ( )

protected

get parent map

References YieldResource::b_fissionable_map.

const std::vector< YieldParent > & fissionables ( ) const

protected

get const fissionables vector

References YieldResource::b_fissionables.

Referenced by YieldResource::set_fissionable_ids().

std::vector< YieldParent > & fissionables ( )

protected

get fissionables vector

References YieldResource::b_fissionables.

Member Data Documentation

ParentMap_t b_fissionable_map

private

Referenced by YieldResource::add_fissionable(), YieldResource::check_consistency(), YieldResource::check_ids(), YieldResource::clear(), YieldResource::fissionable_index(), YieldResource::fissionable_map(), YieldResource::get_fissionable_ids(), YieldResource::remove_fissionable(), and YieldResource::set_fissionable_ids().

std::vector<YieldParent> b_fissionables

private

Referenced by YieldResource::add_fissionable(), YieldResource::check_consistency(), YieldResource::clear(), YieldResource::fissionable(), YieldResource::fissionable_at(), YieldResource::fissionables(), YieldResource::num_fissionables(), YieldResource::remove_fissionable(), YieldResource::set_fissionable_ids(), and YieldResource::set_fp_ids().

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

Core/re/YieldResource.h
Core/re/YieldResource.cpp