#include <Library.h>

Inheritance diagram for Library:

Public Types

typedef std::shared_ptr< LibrarySP
 
typedef std::shared_ptr< const LibrarySCP
 
typedef bool(* InterpFunction) (const std::vector< float > &, float, std::vector< float > *)
 
typedef std::vector< SP_TransitionCoeffVec_SP_TransitionCoeff
 
typedef std::vector< SCP_TransitionCoeffVec_SCP_TransitionCoeff
 
typedef std::shared_ptr< Vec_SP_TransitionCoeffSP_Vec_SP_TransitionCoeff
 
typedef std::shared_ptr< const Vec_SP_TransitionCoeffSCP_Vec_SCP_TransitionCoeff
 

Public Member Functions

 Library ()
 
std::string to_string () const
 
Scale::Json::Value to_json () const
 
bool operator== (const Library &a) const
 
std::string print_compare (const Library &a) const
 
const LibraryHeaderdefinition () const
 return a const reference to definition More...
 
SCP_LibraryHeader scp_definition () const
 return a shared (read-only) definition pointer More...
 
bool has_definition () const
 return whether the class has a non-null definition More...
 
void get_definition (LibraryHeader &) const
 populate an existing LibraryHeader with a copy of definition More...
 
void set_definition (const LibraryHeader &)
 set the definition (copy operation) More...
 
void getptr_definition (const LibraryHeader *&) const
 retrieve pointer (read-only) to definition More...
 
void manageptr_definition (LibraryHeader *&)
 set the definition (ownership transfer) More...
 
const TagManagertag_manager () const
 return a const reference to tag_manager More...
 
SCP_TagManager scp_tag_manager () const
 return a shared (read-only) tag_manager pointer More...
 
bool has_tag_manager () const
 return whether the class has a non-null tag_manager More...
 
void get_tag_manager (TagManager &) const
 populate an existing TagManager with a copy of tag_manager More...
 
void set_tag_manager (const TagManager &)
 set the tag_manager (copy operation) More...
 
void getptr_tag_manager (const TagManager *&) const
 retrieve pointer (read-only) to tag_manager More...
 
void manageptr_tag_manager (TagManager *&)
 set the tag_manager (ownership transfer) More...
 
const DecayDatadecay_data () const
 return a const reference to decay_data More...
 
SCP_DecayData scp_decay_data () const
 return a shared (read-only) decay_data pointer More...
 
bool has_decay_data () const
 return whether the class has a non-null decay_data More...
 
void get_decay_data (DecayData &) const
 populate an existing DecayData with a copy of decay_data More...
 
void set_decay_data (const DecayData &)
 set the decay_data (copy operation) More...
 
void getptr_decay_data (const DecayData *&) const
 retrieve pointer (read-only) to decay_data More...
 
void manageptr_decay_data (DecayData *&)
 set the decay_data (ownership transfer) More...
 
const TransitionStructuretransition_structure () const
 return a const reference to transition_structure More...
 
SCP_TransitionStructure scp_transition_structure () const
 return a shared (read-only) transition_structure pointer More...
 
bool has_transition_structure () const
 return whether the class has a non-null transition_structure More...
 
void get_transition_structure (TransitionStructure &) const
 populate an existing TransitionStructure with a copy of transition_structure More...
 
void set_transition_structure (const TransitionStructure &)
 set the transition_structure (copy operation) More...
 
void getptr_transition_structure (const TransitionStructure *&) const
 retrieve pointer (read-only) to transition_structure More...
 
void manageptr_transition_structure (TransitionStructure *&)
 set the transition_structure (ownership transfer) More...
 
bool has_transition_coeff () const
 has a non-null transition_coeff vector More...
 
size_t transition_coeff_size () const
 size of transition_coeff vector More...
 
const TransitionCoefftransition_coeff_at (size_t) const
 return a const element for read-only access More...
 
SCP_TransitionCoeff scp_transition_coeff_at (size_t) const
 return a const std::shared_ptr for read-only access More...
 
bool has_transition_coeff_at (size_t) const
 has a non-null element of transition_coeff vector More...
 
void getptr_transition_coeff_at (const TransitionCoeff *&, size_t) const
 get a read-only pointer by index More...
 
void resize_transition_coeff (size_t)
 resize the vector More...
 
void get_transition_coeff_at (TransitionCoeff &, size_t) const
 get a copy of the element in-place More...
 
void set_transition_coeff_at (const TransitionCoeff &, size_t)
 set a new element by index More...
 
void add_transition_coeff (const TransitionCoeff &)
 add a new element to the end More...
 
void delete_transition_coeff_at (size_t)
 delete an element More...
 
void manageptr_transition_coeff_at (TransitionCoeff *&, size_t)
 manage an existing pointer in this class More...
 
TransitionMatrixPnewptr_transition_matrix_at (size_t) const
 
TransitionMatrixP::SP newsp_transition_matrix_at (size_t) const
 
void add_transition_matrix (const TransitionMatrixP &)
 
size_t total_nuclides () const
 
SP clone () const
 
virtual int serialize (Standard::AbstractStream *stream) const
 
virtual int deserialize (Standard::AbstractStream *stream)
 
virtual unsigned long getSerializedSize () const
 Obtain the size in bytes of this object when serialized This size does not contain the uid b_definition component size which each Standard::Serializable object MUST contain in its serialized definition. More...
 
virtual Standard::Serializable * getCopy () const
 
virtual Standard::Serializable::UID getUID () const
 Obtain the universal version identifier the uid should be unique for all Standard::Serializable objects such that an object factory can retrieve prototypes of the desired Standard::Serializable object and inflate the serial object into a manageable object. More...
 
virtual std::string toString () const
 
SP interpolate (std::vector< float > newBurnups)
 Return a new Library interpolated to the provided burnup grid. More...
 
SP interpolate_Interp1D (std::vector< double > newBurnups)
 
void regrid (std::vector< float > newBurnups)
 
void regrid_Interp1D (std::vector< double > newBurnups)
 
void set_interpolator (InterpFunction)
 

Static Public Attributes

static const Standard::Serializable::UID uid = 0x99359452b5b56031
 

Protected Member Functions

void canonicalize_definition ()
 
void canonicalize_tag_manager ()
 
void canonicalize_decay_data ()
 
void canonicalize_transition_structure ()
 
void canonicalize_transition_coeff_at (size_t)
 
void populate_transition_matrix (TransitionMatrixP *, size_t) const
 
void populate_transition_matrix_reaction (TransitionMatrixP *, size_t) const
 

Protected Attributes

SP_LibraryHeader b_definition
 
SP_TagManager b_tag_manager
 
SP_DecayData b_decay_data
 
SP_TransitionStructure b_transition_structure
 
SP_Vec_SP_TransitionCoeff b_transition_coeff
 
InterpFunction b_interp_func
 Function pointer to interpolator function to use. More...
 

Detailed Description

Member Typedef Documentation

typedef std::shared_ptr<Library> SP
typedef std::shared_ptr<const Library> SCP
typedef bool( * InterpFunction) (const std::vector< float > &, float, std::vector< float > *)
Examples:
tstLibrary.cpp.
typedef std::shared_ptr<const Vec_SP_TransitionCoeff> SCP_Vec_SCP_TransitionCoeff

Constructor & Destructor Documentation

Member Function Documentation

std::string to_string ( ) const
std::string print_compare ( const Library a) const
SCP_LibraryHeader scp_definition ( ) const

return a shared (read-only) definition pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_definition ( ) const

return whether the class has a non-null definition

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Library::clone(), and Library::total_nuclides().

void get_definition ( LibraryHeader definition) const

populate an existing LibraryHeader with a copy of definition

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void set_definition ( const LibraryHeader definition)

set the definition (copy operation)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:
tstLibraryIO.cpp, and tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::Library_random1(), LibraryIO_bof::read(), LibraryIO_s62b::read(), LibraryIO_s61::read(), scale61_fixup(), and TEST().

void getptr_definition ( const LibraryHeader *&  ) const

retrieve pointer (read-only) to definition

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void manageptr_definition ( LibraryHeader *&  definition)

set the definition (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

const TagManager & tag_manager ( ) const

return a const reference to tag_manager

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Invalid if this instance of Library goes out of scope.

Referenced by Library::deserialize(), Library::operator==(), Origen::printIdTags_json(), Origen::printInterpTags_json(), and LibraryIO_bof::write().

SCP_TagManager scp_tag_manager ( ) const

return a shared (read-only) tag_manager pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_tag_manager ( ) const

return whether the class has a non-null tag_manager

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Library::clone().

void get_tag_manager ( TagManager tag_manager) const

populate an existing TagManager with a copy of tag_manager

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void set_tag_manager ( const TagManager tag_manager)

set the tag_manager (copy operation)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:
tstinterp.cpp.

Referenced by LibraryIO_bof::read(), and TEST().

void getptr_tag_manager ( const TagManager *&  ) const

retrieve pointer (read-only) to tag_manager

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void manageptr_tag_manager ( TagManager *&  tag_manager)

set the tag_manager (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

SCP_DecayData scp_decay_data ( ) const

return a shared (read-only) decay_data pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_decay_data ( ) const

return whether the class has a non-null decay_data

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Library::clone().

void get_decay_data ( DecayData decay_data) const

populate an existing DecayData with a copy of decay_data

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void getptr_decay_data ( const DecayData *&  ) const

retrieve pointer (read-only) to decay_data

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void manageptr_decay_data ( DecayData *&  decay_data)

set the decay_data (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

const TransitionStructure & transition_structure ( ) const
SCP_TransitionStructure scp_transition_structure ( ) const

return a shared (read-only) transition_structure pointer

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_transition_structure ( ) const

return whether the class has a non-null transition_structure

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Referenced by Library::clone().

void get_transition_structure ( TransitionStructure transition_structure) const

populate an existing TransitionStructure with a copy of transition_structure

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void set_transition_structure ( const TransitionStructure transition_structure)

set the transition_structure (copy operation)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

Examples:
tstLibraryIO.cpp, and tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by LibraryBuilder::create_library(), FakeFactory::Library_random1(), LibraryIO_bof::read(), LibraryIO_s62b::read(), LibraryIO_s61::read(), scale61_fixup(), and TEST().

void getptr_transition_structure ( const TransitionStructure *&  ) const

retrieve pointer (read-only) to transition_structure

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

void manageptr_transition_structure ( TransitionStructure *&  transition_structure)

set the transition_structure (ownership transfer)

Auto-generated from macro #ORIGEN_ACCESSORS_SP_OBJECT().

bool has_transition_coeff ( ) const

has a non-null transition_coeff vector

Referenced by Library::to_json().

SCP_TransitionCoeff scp_transition_coeff_at ( size_t  i) const

return a const std::shared_ptr for read-only access

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

Examples:
tstLibrary.cpp.

Referenced by Library::interpolate(), Library::interpolate_Interp1D(), and TEST().

bool has_transition_coeff_at ( size_t  i) const

has a non-null element of transition_coeff vector

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

Referenced by Library::populate_transition_matrix_reaction().

void getptr_transition_coeff_at ( const TransitionCoeff *&  ,
size_t   
) const

get a read-only pointer by index

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

void resize_transition_coeff ( size_t  n)

resize the vector

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

Referenced by Origen::saveLibraries().

void get_transition_coeff_at ( TransitionCoeff element,
size_t  i 
) const

get a copy of the element in-place

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

void set_transition_coeff_at ( const TransitionCoeff element,
size_t  i 
)

set a new element by index

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

Examples:
tstLibraryIO.cpp, and tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by inject_fission_yields(), scale61_fixup(), Origen::setbuLibrary(), and TEST().

void add_transition_coeff ( const TransitionCoeff element)
void delete_transition_coeff_at ( size_t  i)

delete an element

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

Referenced by Origen::thinLibrary().

void manageptr_transition_coeff_at ( TransitionCoeff *&  element,
size_t  i 
)

manage an existing pointer in this class

Auto-generated from macro \ * #ORIGEN_ACCESSORS_SP_VECTOR_WITH_MANAGEMENT().

TransitionMatrixP * newptr_transition_matrix_at ( size_t  index) const
unsigned long getSerializedSize ( ) const
virtual

Obtain the size in bytes of this object when serialized This size does not contain the uid b_definition component size which each Standard::Serializable object MUST contain in its serialized definition.

Returns
unsigned long - the size in bytes of the object when serialized

References Library::b_decay_data, Library::b_definition, Library::b_tag_manager, Library::b_transition_coeff, and Library::b_transition_structure.

Referenced by Library::serialize().

Standard::Serializable * getCopy ( ) const
virtual

References Library::Library().

long getUID ( ) const
virtual

Obtain the universal version identifier the uid should be unique for all Standard::Serializable objects such that an object factory can retrieve prototypes of the desired Standard::Serializable object and inflate the serial object into a manageable object.

Returns
long - the uid of the object

References Library::uid.

Referenced by Library::deserialize(), and Library::serialize().

std::string toString ( ) const
virtual

References Library::to_string().

SP_Library interpolate_Interp1D ( std::vector< double >  newBurnups)
void regrid ( std::vector< float >  newBurnups)

Re-grid this library to the given burnup grid by interpolating from the old grid

Examples:
tstLibrary.cpp.

References Library::interpolate().

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

void regrid_Interp1D ( std::vector< double >  newBurnups)
void set_interpolator ( Library::InterpFunction  func)
Examples:
tstLibrary.cpp.

References Library::b_interp_func.

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

void canonicalize_definition ( )
protected
void canonicalize_tag_manager ( )
protected
void canonicalize_decay_data ( )
protected
void canonicalize_transition_structure ( )
protected
void canonicalize_transition_coeff_at ( size_t  i)
protected

Member Data Documentation

const Standard::Serializable::UID uid = 0x99359452b5b56031
static

Referenced by Library::getUID().

InterpFunction b_interp_func
protected

Function pointer to interpolator function to use.

to transition coefficients.

Referenced by Library::interpolate(), and Library::set_interpolator().


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