PoPI::NuclideGammaBranchInfo Class Reference

#include <PoPI.hpp>

Public Member Functions
	NuclideGammaBranchInfo (double a_probability, double a_photonEmissionProbability, double a_gammaEnergy, std::string const &a_residualState)
	NuclideGammaBranchInfo (NuclideGammaBranchInfo const &a_nuclideGammaBranchInfo)
double	probability () const
double	photonEmissionProbability () const
double	gammaEnergy () const
std::string const &	residualState () const

Detailed Description

Class storing information about the gamma (i.e., photon) decay of an excited nuclide state to a lower state.

Definition at line 548 of file PoPI.hpp.

Constructor & Destructor Documentation

NuclideGammaBranchInfo() [1/2]

PoPI::NuclideGammaBranchInfo::NuclideGammaBranchInfo	(	double	a_probability,
		double	a_photonEmissionProbability,
		double	a_gammaEnergy,
		std::string const &	a_residualState )

Parameters

a_probability	[in] The probability that the level decays to state a_residualState.
a_photonEmissionProbability	[in] The conditional probability the the decay emitted a photon.
a_gammaEnergy	[in] The energy of the emitted photon.
a_residualState	[in] The state the residual is left in after photon decay.

Definition at line 25 of file PoPI_nuclideGammaBranching.cc.

                                                   :
        m_probability( a_probability ),
        m_photonEmissionProbability( a_photonEmissionProbability ),
        m_gammaEnergy( a_gammaEnergy ),
        m_residualState( a_residualState ) {
 
}

Referenced by NuclideGammaBranchInfo().

NuclideGammaBranchInfo() [2/2]

PoPI::NuclideGammaBranchInfo::NuclideGammaBranchInfo

(

NuclideGammaBranchInfo const &

a_nuclideGammaBranchInfo

)

Copy constructor.

Parameters

a_nuclideGammaBranchInfo

[in] The NuclideGammaBranchInfo instance to copy.

Definition at line 40 of file PoPI_nuclideGammaBranching.cc.

                                                                                                       :
        m_probability( a_nuclideGammaBranchInfo.probability( ) ),
        m_photonEmissionProbability( a_nuclideGammaBranchInfo.photonEmissionProbability( ) ),
        m_gammaEnergy( a_nuclideGammaBranchInfo.gammaEnergy( ) ),
        m_residualState( a_nuclideGammaBranchInfo.residualState( ) ) {
 
}

Member Function Documentation

gammaEnergy()

double PoPI::NuclideGammaBranchInfo::gammaEnergy ( ) const

inline

Returns the value of the m_gammaEnergy member.

Definition at line 563 of file PoPI.hpp.

Referenced by PoPI::NuclideGammaBranchStateInfo::calculateDerivedData(), and NuclideGammaBranchInfo().

photonEmissionProbability()

double PoPI::NuclideGammaBranchInfo::photonEmissionProbability ( ) const

inline

Returns the value of the m_photonEmissionProbability member.

Definition at line 561 of file PoPI.hpp.

Referenced by PoPI::NuclideGammaBranchStateInfo::calculateDerivedData(), and NuclideGammaBranchInfo().

probability()

double PoPI::NuclideGammaBranchInfo::probability ( ) const

inline

Returns the value of the m_probability member.

Definition at line 560 of file PoPI.hpp.

Referenced by PoPI::NuclideGammaBranchStateInfo::calculateDerivedData(), and NuclideGammaBranchInfo().

residualState()

std::string const & PoPI::NuclideGammaBranchInfo::residualState ( ) const

inline

Returns the value of the m_residualState member.

Definition at line 564 of file PoPI.hpp.

Referenced by PoPI::NuclideGammaBranchStateInfo::calculateDerivedData(), MCGIDI::NuclideGammaBranchInfo::NuclideGammaBranchInfo(), and NuclideGammaBranchInfo().

---

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

• PoPI.hpp
• PoPI_nuclideGammaBranching.cc