Public Types | Private Member Functions | List of all members
Channel Class Referenceabstract

#include <Channel.h>

Inheritance diagram for Channel:
Checkable Channel_Gen

Defines the channel interface for the TransitionSystem. More...

Public Types

typedef SP_Channel SP
 strong pointer More...
 
typedef WP_Channel WP
 weak pointer More...
 
typedef CWP_Channel CWP
 const weak pointer More...
 

INTERFACE<<Origen::Channel>>

See Origen::Channel for details.

int num_transitions () const
 
SP_Transition transition (int transition_id) const
 
void get_transition (int transition_id, SP_Transition &transition) const
 
void set_transition (SP_Transition transition)
 
SP_Transition add_transition (int transition_id)
 
SP_Transition add_transition (int transition_id, double yield)
 
std::vector< SP_Transition > transitions () const
 
void get_transitions (std::vector< SP_Transition > &transitions) const
 
void set_transitions (std::vector< SP_Transition > transitions)
 
std::vector< SP_Transition > byproduct_transitions () const
 
void get_byproduct_transitions (std::vector< SP_Transition > &transitions) const
 
void update_byproduct_transitions ()
 
SP_ChannelType channel_type () const
 
void get_channel_type (SP_ChannelType &channel_type) const
 
void set_channel_type (SP_ChannelType channel_type)
 
bool has_initialized_channel_type () const
 
double decay_constant () const
 
Channel & set_decay_constant (double decay_constant)
 
bool has_initialized_decay_constant () const
 
double xs () const
 
Channel & set_xs (double xs)
 
bool has_initialized_xs () const
 
CWP_Nuclide parent () const
 
void get_parent (WP_Nuclide &parent) const
 
void set_parent (WP_Nuclide parent)
 
bool has_initialized_parent () const
 
int daughter_mass_number () const
 
int daughter_charge_number () const
 
double coeff () const
 
double rate () const
 

INTERFACE<<Origen::Checkable>>

See Origen::Checkable for details.

std::string name () const
 
void get_name (std::string &name) const
 
void set_name (std::string name)
 
int id () const
 
void get_id (int &id) const
 
void set_id (int id)
 
bool has_initialized_id () const
 
std::string to_string () const
 
bool good () const
 
bool good (Vec_Str &errors) const
 
bool is_initialized () const
 
Scale::Json::Value to_json () const
 

Private Member Functions

virtual int num_transitions_impl () const =0
 
virtual int daughter_mass_number_impl () const
 
virtual int daughter_charge_number_impl () const
 
virtual SP_Transition transition_impl (int transition_id) const =0
 
virtual void get_transition_impl (int transition_id, SP_Transition &transition) const =0
 
virtual void set_transition_impl (SP_Transition transition)=0
 
virtual CWP_Nuclide parent_impl () const =0
 
virtual void get_parent_impl (WP_Nuclide &parent) const =0
 
virtual void set_parent_impl (WP_Nuclide parent)=0
 
virtual bool has_initialized_parent_impl () const
 
virtual double coeff_impl () const =0
 
virtual double rate_impl () const =0
 
virtual SP_ChannelType channel_type_impl () const =0
 
virtual void get_channel_type_impl (SP_ChannelType &channel_type) const =0
 
virtual void set_channel_type_impl (SP_ChannelType channel_type)=0
 
virtual bool has_initialized_channel_type_impl () const
 
virtual double decay_constant_impl () const =0
 
virtual void set_decay_constant_impl (double decay_constant)=0
 
virtual bool has_initialized_decay_constant_impl () const
 
virtual double xs_impl () const =0
 
virtual void set_xs_impl (double xs)=0
 
virtual bool has_initialized_xs_impl () const
 
virtual std::vector< SP_Transition > transitions_impl () const =0
 
virtual void get_transitions_impl (std::vector< SP_Transition > &transitions) const =0
 
virtual void set_transitions_impl (std::vector< SP_Transition > transitions)=0
 
virtual SP_Transition add_transition_impl (int transition_id)=0
 
virtual SP_Transition add_transition_impl (int transition_id, double yield)=0
 
virtual std::string name_impl () const
 
virtual int id_impl () const
 
virtual bool is_initialized_impl () const
 useful to chain More...
 
virtual bool good_impl (Vec_Str &errors) const
 useful to chain More...
 
virtual Scale::Json::Value to_json_impl () const
 useful to chain More...
 
virtual std::vector< SP_Transition > byproduct_transitions_impl () const =0
 
virtual void get_byproduct_transitions_impl (std::vector< SP_Transition > &transitions) const =0
 
virtual void update_byproduct_transitions_impl ()=0
 

Detailed Description

Defines the channel interface for the TransitionSystem.

The channel, in the context of the transition system, manages five main pieces of data:

  1. identification
  2. channel type
  3. transitions

The channel also has

  1. a strong pointer to a list of Transitions
  2. a weak pointer to a Nuclide
See also
Nuclide, Transition, Species, TransitionSystem

Member Typedef Documentation

typedef SP_Channel SP

strong pointer

typedef WP_Channel WP

weak pointer

typedef CWP_Channel CWP

const weak pointer

Member Function Documentation

int num_transitions ( ) const
SP_Transition transition ( int  transition_id) const

Referenced by Channel_Gen::add_transition_impl(), LibraryBuilder::create_reaction_transitions(), Channel_Gen::get_transition_impl(), Channel_Gen::set_transition_impl(), and Channel_Gen::update_byproduct_transitions_impl().

void get_transition ( int  transition_id,
SP_Transition &  transition 
) const
void set_transition ( SP_Transition  transition)
Transition::SP add_transition ( int  transition_id)

Referenced by Channel_Gen::add_transition_impl().

Transition::SP add_transition ( int  transition_id,
double  yield 
)
std::vector< SP_Transition > transitions ( ) const
void get_transitions ( std::vector< SP_Transition > &  transitions) const
void set_transitions ( std::vector< SP_Transition >  transitions)
std::vector< SP_Transition > byproduct_transitions ( ) const
void get_byproduct_transitions ( std::vector< SP_Transition > &  transitions) const
void update_byproduct_transitions ( )

Referenced by Channel_Gen::set_channel_type_impl(), and Channel_Gen::set_parent_impl().

SP_ChannelType channel_type ( ) const

Referenced by Channel_Gen::add_transition_impl(), Channel_Gen::coeff_impl(), LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), Channel_Gen::set_channel_type_impl(), and Channel_Gen::update_byproduct_transitions_impl().

void get_channel_type ( SP_ChannelType &  channel_type) const
void set_channel_type ( SP_ChannelType  channel_type)

Referenced by Channel_Gen::Channel_Gen().

bool has_initialized_channel_type ( ) const

Referenced by Channel_Gen::coeff_impl(), and Channel_Gen::update_byproduct_transitions_impl().

double decay_constant ( ) const

Referenced by Channel_Gen::coeff_impl(), and Channel_Gen::set_decay_constant_impl().

Channel & set_decay_constant ( double  decay_constant)
bool has_initialized_decay_constant ( ) const
double xs ( ) const

Referenced by Channel_Gen::coeff_impl(), and Channel_Gen::set_xs_impl().

Channel & set_xs ( double  xs)
bool has_initialized_xs ( ) const
CWP_Nuclide parent ( ) const
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by Channel_Gen::add_transition_impl(), Nuclide_Gen::append_gain_impl(), LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), Nuclide_Gen::gain_impl(), Channel_Gen::rate_impl(), Channel_Gen::set_parent_impl(), TEST_F(), and Channel_Gen::update_byproduct_transitions_impl().

void get_parent ( WP_Nuclide &  parent) const

Referenced by Channel_Gen::add_transition_impl().

void set_parent ( WP_Nuclide  parent)
bool has_initialized_parent ( ) const

Referenced by Channel_Gen::add_transition_impl(), Channel_Gen::rate_impl(), and Channel_Gen::update_byproduct_transitions_impl().

int daughter_mass_number ( ) const

Referenced by Channel_Gen::add_transition_impl().

int daughter_charge_number ( ) const

Referenced by Channel_Gen::add_transition_impl().

double coeff ( ) const

Referenced by Channel_Gen::rate_impl().

double rate ( ) const
virtual int num_transitions_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

int daughter_mass_number_impl ( ) const
privatevirtual

References Origen::BAD_INT.

int daughter_charge_number_impl ( ) const
privatevirtual

References Origen::BAD_INT.

virtual SP_Transition transition_impl ( int  transition_id) const
privatepure virtual

Implemented in Channel_Gen.

virtual void get_transition_impl ( int  transition_id,
SP_Transition &  transition 
) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_transition_impl ( SP_Transition  transition)
privatepure virtual

Implemented in Channel_Gen.

virtual CWP_Nuclide parent_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void get_parent_impl ( WP_Nuclide &  parent) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_parent_impl ( WP_Nuclide  parent)
privatepure virtual

Implemented in Channel_Gen.

bool has_initialized_parent_impl ( ) const
privatevirtual
virtual double coeff_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual double rate_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual SP_ChannelType channel_type_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void get_channel_type_impl ( SP_ChannelType &  channel_type) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_channel_type_impl ( SP_ChannelType  channel_type)
privatepure virtual

Implemented in Channel_Gen.

bool has_initialized_channel_type_impl ( ) const
privatevirtual
virtual double decay_constant_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_decay_constant_impl ( double  decay_constant)
privatepure virtual

Implemented in Channel_Gen.

bool has_initialized_decay_constant_impl ( ) const
privatevirtual

References Origen::BAD_DOUBLE.

virtual double xs_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_xs_impl ( double  xs)
privatepure virtual

Implemented in Channel_Gen.

bool has_initialized_xs_impl ( ) const
privatevirtual

References Origen::BAD_DOUBLE.

virtual std::vector<SP_Transition> transitions_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void get_transitions_impl ( std::vector< SP_Transition > &  transitions) const
privatepure virtual

Implemented in Channel_Gen.

virtual void set_transitions_impl ( std::vector< SP_Transition >  transitions)
privatepure virtual

Implemented in Channel_Gen.

virtual SP_Transition add_transition_impl ( int  transition_id)
privatepure virtual

Implemented in Channel_Gen.

virtual SP_Transition add_transition_impl ( int  transition_id,
double  yield 
)
privatepure virtual

Implemented in Channel_Gen.

std::string name_impl ( ) const
privatevirtual

Reimplemented from Checkable.

int id_impl ( ) const
privatevirtual

Reimplemented from Checkable.

References Origen::BAD_INT.

bool is_initialized_impl ( ) const
privatevirtual

useful to chain

Reimplemented from Checkable.

bool good_impl ( Vec_Str &  errors) const
privatevirtual

useful to chain

Reimplemented from Checkable.

References ORIGEN_CHECKABLE_ERROR.

Json::Value to_json_impl ( ) const
privatevirtual

useful to chain

Reimplemented from Checkable.

virtual std::vector<SP_Transition> byproduct_transitions_impl ( ) const
privatepure virtual

Implemented in Channel_Gen.

virtual void get_byproduct_transitions_impl ( std::vector< SP_Transition > &  transitions) const
privatepure virtual

Implemented in Channel_Gen.

virtual void update_byproduct_transitions_impl ( )
privatepure virtual

Implemented in Channel_Gen.

std::string name ( ) const
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), ChannelType_Fiss::good_impl(), ChannelType_Decay::good_impl(), ChannelType_Reac::good_impl(), and TEST().

void get_name ( std::string &  name) const
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_name ( std::string  name)
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by TEST().

int id ( ) const
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by TransitionSystem_Gen::add_nuclide_impl(), TransitionSystem_Gen::add_species_impl(), Channel_Gen::add_transition_impl(), LibraryBuilder::create_decay_transitions(), LibraryBuilder::create_reaction_transitions(), Nuclide_Gen::gain_impl(), LibraryBuilder::search_reaction_transitions(), Nuclide_Gen::set_losses_impl(), Channel_Gen::set_transition_impl(), TEST(), and TEST_F().

void get_id ( int &  id) const
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by TEST().

void set_id ( int  id)
inherited
Examples:
tstTransitionSystem_Gen.cpp.

Referenced by TEST().

bool has_initialized_id ( ) const
inherited

Referenced by Nuclide_Gen::set_losses_impl(), TransitionSystem_Gen::set_nuclides_impl(), and Channel_Gen::set_transitions_impl().

std::string to_string ( ) const
inherited
Examples:
tstTransitionSystemAdapter_AmpxN.cpp.

Referenced by TEST_F().

bool good ( ) const
inherited
bool good ( Vec_Str &  errors) const
inherited
bool is_initialized ( ) const
inherited

Referenced by ChannelType_Decay::good_impl(), and ChannelType_Decay::update_byproducts().

Scale::Json::Value to_json ( ) const
inherited
The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.10