Public Types | Static Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
ChannelType Class Referenceabstract

#include <ChannelType.h>

Inheritance diagram for ChannelType:
Checkable ChannelType_Decay ChannelType_Fiss ChannelType_Reac

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

Public Types

typedef SP_ChannelType SP
 strong pointer More...
 
typedef WP_ChannelType WP
 weak pointer More...
 

INTERFACE<<Origen::ChannelType>>

See Origen::ChannelType for details.

int reaction_mt () const
 
void set_reaction_mt (int reaction_mt)
 
std::string reaction_mt_name () const
 
bool has_initialized_reaction_mt () const
 
int decay_mode () const
 
void set_decay_mode (int decay_mode)
 
std::string decay_mode_name () const
 
bool has_initialized_decay_mode () const
 
SP_Field field () const
 
void get_field (SP_Field &field) const
 
void set_field (SP_Field field)
 
bool has_initialized_field () const
 
bool is_reaction () const
 
bool is_decay () const
 
bool has_followon_decay () const
 
bool has_distribution_of_daughters () const
 
double num_residuals_per_event () const
 
int num_byproduct (const ByproductId byproduct_id) const
 
bool has_byproduct (const ByproductId byproduct_id) const
 
ByproductCount_t num_byproducts () const
 
void increment_num_byproducts (ByproductCount_t &num_byproducts) const
 
int delta_nucleus_protons () const
 
int delta_nucleus_neutrons () const
 
int delta_mass_number () const
 
int delta_charge_number () 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
 

Static Public Member Functions

static int channel_id (int decay_mode)
 channel id for decay only More...
 
static int channel_id (SP_Field field, int reaction_mt, int decay_mode=0)
 channel id for reaction+decay More...
 

Protected Member Functions

virtual bool good_impl (Vec_Str &errors) const
 useful to chain More...
 

Private Member Functions

virtual int reaction_mt_impl () const =0
 
virtual void set_reaction_mt_impl (int reaction_mt)=0
 
virtual std::string reaction_mt_name_impl () const
 
virtual int decay_mode_impl () const =0
 
virtual void set_decay_mode_impl (int decay_mode)=0
 
virtual std::string decay_mode_name_impl () const
 
virtual SP_Field field_impl () const =0
 
virtual void get_field_impl (SP_Field &field) const
 
virtual void set_field_impl (SP_Field field)=0
 
virtual bool is_reaction_impl () const
 
virtual bool is_decay_impl () const
 
virtual bool has_followon_decay_impl () const
 
virtual bool is_initialized_impl () const
 useful to chain More...
 
virtual bool has_initialized_field_impl () const
 
virtual bool has_initialized_decay_mode_impl () const
 
virtual bool has_initialized_reaction_mt_impl () const
 
virtual bool has_distribution_of_daughters_impl () const
 
virtual double num_residuals_per_event_impl () const
 
virtual int num_byproduct_impl (const ByproductId byproduct_id) const
 
virtual bool has_byproduct_impl (const ByproductId byproduct_id) const
 
virtual ByproductCount_t num_byproducts_impl () const =0
 
virtual int delta_nucleus_protons_impl () const =0
 
virtual int delta_nucleus_neutrons_impl () const =0
 
virtual int delta_mass_number_impl () const =0
 
virtual int delta_charge_number_impl () const =0
 
virtual std::string name_impl () const
 
virtual int id_impl () const
 
virtual Scale::Json::Value to_json_impl () const
 useful to chain More...
 

Detailed Description

Defines the channel type interface for the TransitionSystem.

The channel type, in the context of the transition system, manages three piece of data:

  1. field
  2. reaction mt
  3. decay mode

It provides information for each type of channel, e.g.

  1. the number of residuals/byproducts produced per event
  2. the change in number of protons/neutrons/mass/number charge number
See also
Channel

Member Typedef Documentation

typedef SP_ChannelType SP

strong pointer

typedef WP_ChannelType WP

weak pointer

Member Function Documentation

int reaction_mt ( ) const

Referenced by ChannelType_Fiss::good_impl(), ChannelType_Reac::good_impl(), ChannelType_Fiss::set_reaction_mt_impl(), and ChannelType_Reac::set_reaction_mt_impl().

void set_reaction_mt ( int  reaction_mt)

Referenced by ChannelType_Fiss::ChannelType_Fiss(), and ChannelType_Reac::ChannelType_Reac().

std::string reaction_mt_name ( ) const
bool has_initialized_reaction_mt ( ) const
int decay_mode ( ) const

Referenced by ChannelType_Decay::good_impl().

void set_decay_mode ( int  decay_mode)

Referenced by ChannelType_Decay::ChannelType_Decay().

std::string decay_mode_name ( ) const
bool has_initialized_decay_mode ( ) const
SP_Field field ( ) const

Referenced by ChannelType_Fiss::good_impl(), ChannelType_Reac::good_impl(), ChannelType_Fiss::set_field_impl(), and ChannelType_Reac::set_field_impl().

void get_field ( SP_Field &  field) const
void set_field ( SP_Field  field)

Referenced by ChannelType_Fiss::ChannelType_Fiss(), and ChannelType_Reac::ChannelType_Reac().

bool has_initialized_field ( ) const
bool is_reaction ( ) const
bool is_decay ( ) const
bool has_followon_decay ( ) const
bool has_distribution_of_daughters ( ) const
double num_residuals_per_event ( ) const
int num_byproduct ( const ByproductId  byproduct_id) const
bool has_byproduct ( const ByproductId  byproduct_id) const
ByproductCount_t num_byproducts ( ) const
void increment_num_byproducts ( ByproductCount_t &  num_byproducts) const
int delta_nucleus_protons ( ) const
int delta_nucleus_neutrons ( ) const
int delta_mass_number ( ) const
int delta_charge_number ( ) const
int channel_id ( int  decay_mode)
static

channel id for decay only

Referenced by TransitionSystem_Gen::channel_type_impl(), and TransitionSystemAdapter_AmpxN::update().

int channel_id ( SP_Field  field,
int  reaction_mt,
int  decay_mode = 0 
)
static

channel id for reaction+decay

virtual int reaction_mt_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual void set_reaction_mt_impl ( int  reaction_mt)
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

std::string reaction_mt_name_impl ( ) const
privatevirtual
virtual int decay_mode_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual void set_decay_mode_impl ( int  decay_mode)
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

std::string decay_mode_name_impl ( ) const
privatevirtual
virtual SP_Field field_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

void get_field_impl ( SP_Field &  field) const
privatevirtual
virtual void set_field_impl ( SP_Field  field)
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

bool is_reaction_impl ( ) const
privatevirtual

Reimplemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

References Origen::BAD_INT.

bool is_decay_impl ( ) const
privatevirtual

Reimplemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

References Origen::BAD_INT.

bool has_followon_decay_impl ( ) const
privatevirtual

Reimplemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

References Origen::BAD_INT.

bool is_initialized_impl ( ) const
privatevirtual

useful to chain

Reimplemented from Checkable.

bool has_initialized_field_impl ( ) const
privatevirtual
bool has_initialized_decay_mode_impl ( ) const
privatevirtual

References Origen::BAD_INT.

bool has_initialized_reaction_mt_impl ( ) const
privatevirtual

References Origen::BAD_INT.

bool has_distribution_of_daughters_impl ( ) const
privatevirtual

Reimplemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

double num_residuals_per_event_impl ( ) const
privatevirtual

Reimplemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

int num_byproduct_impl ( const ByproductId  byproduct_id) const
privatevirtual

Reimplemented in ChannelType_Fiss.

bool has_byproduct_impl ( const ByproductId  byproduct_id) const
privatevirtual

Reimplemented in ChannelType_Fiss.

virtual ByproductCount_t num_byproducts_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual int delta_nucleus_protons_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual int delta_nucleus_neutrons_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual int delta_mass_number_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

virtual int delta_charge_number_impl ( ) const
privatepure virtual

Implemented in ChannelType_Reac, ChannelType_Decay, and ChannelType_Fiss.

std::string name_impl ( ) const
privatevirtual

Reimplemented from Checkable.

int id_impl ( ) const
privatevirtual

Reimplemented from Checkable.

Json::Value to_json_impl ( ) const
privatevirtual

useful to chain

Reimplemented from Checkable.

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
bool good_impl ( Vec_Str &  errors) const
protectedvirtualinherited

useful to chain

Reimplemented in Nuclide, Channel, Null, Neutrino, Positron, Species, Transition, Electron, Field, Alpha, ChannelType_Reac, ChannelType_Decay, ChannelType_Fiss, Helion, TransitionSystem_Gen, Triton, Deuteron, Proton, and Neutron.

References ORIGEN_CHECKABLE_ERROR.

The documentation for this class was generated from the following files:
Generated by   doxygen 1.8.10