PoPI::NuclideGammaBranchStateInfo Class Reference

#include <PoPI.hpp>

Public Member Functions
	NuclideGammaBranchStateInfo (std::string const &a_state, int a_intid, std::string const &a_kind, double a_nuclearLevelEnergy)
std::string const &	state () const
int	intid () const
std::string const &	kind () const
double	nuclearLevelEnergy () const
double	nuclearLevelEnergyWidth () const
void	setNuclearLevelEnergyWidth (double a_nuclearLevelEnergyWidth)
bool	derivedCalculated () const
double	multiplicity () const
double	averageGammaEnergy () const
std::vector< NuclideGammaBranchInfo > const &	branches () const
void	add (NuclideGammaBranchInfo const &a_nuclideGammaBranchInfo)
void	calculateDerivedData (NuclideGammaBranchStateInfos &a_nuclideGammaBranchStateInfos)

Detailed Description

Definition at line 573 of file PoPI.hpp.

Constructor & Destructor Documentation

NuclideGammaBranchStateInfo()

PoPI::NuclideGammaBranchStateInfo::NuclideGammaBranchStateInfo	(	std::string const &	a_state,
		int	a_intid,
		std::string const &	a_kind,
		double	a_nuclearLevelEnergy )

Definition at line 53 of file PoPI_nuclideGammaBranching.cc.

                                              :
        m_state( a_state ),
        m_intid( a_intid ),
        m_kind( a_kind ),
        m_nuclearLevelEnergy( a_nuclearLevelEnergy ),
        m_nuclearLevelEnergyWidth( 0.0 ),
        m_derivedCalculated( false ),
        m_multiplicity( 0.0 ),
        m_averageGammaEnergy( 0.0 ) {
 
}

Referenced by calculateDerivedData().

Member Function Documentation

add()

void PoPI::NuclideGammaBranchStateInfo::add

(

NuclideGammaBranchInfo const &

a_nuclideGammaBranchInfo

)

Definition at line 68 of file PoPI_nuclideGammaBranching.cc.

                                                                                              {
 
    m_branches.push_back( a_nuclideGammaBranchInfo );
}

Referenced by PoPI::DecayMode::calculateNuclideGammaBranchStateInfo(), and PoPI::GammaDecayData::calculateNuclideGammaBranchStateInfo().

averageGammaEnergy()

double PoPI::NuclideGammaBranchStateInfo::averageGammaEnergy ( ) const

inline

Returns the value of the m_averageGammaEnergy member.

Definition at line 599 of file PoPI.hpp.

Referenced by calculateDerivedData().

branches()

std::vector< NuclideGammaBranchInfo > const & PoPI::NuclideGammaBranchStateInfo::branches ( ) const

inline

Returns a reference to the m_branches member.

Definition at line 600 of file PoPI.hpp.

Referenced by PoPI::Nuclide::calculateNuclideGammaBranchStateInfos(), and MCGIDI::NuclideGammaBranchStateInfo::NuclideGammaBranchStateInfo().

calculateDerivedData()

void PoPI::NuclideGammaBranchStateInfo::calculateDerivedData

(

NuclideGammaBranchStateInfos &

a_nuclideGammaBranchStateInfos

)

Definition at line 75 of file PoPI_nuclideGammaBranching.cc.

                                                                                                                     {
 
    if( m_derivedCalculated ) return;
 
    for( std::size_t i1 = 0; i1 < m_branches.size( ); ++i1 ) {
        NuclideGammaBranchInfo &nuclideGammaBranchInfo = m_branches[i1];
 
        std::string const &residualState = nuclideGammaBranchInfo.residualState( );
        NuclideGammaBranchStateInfo *nuclideGammaBranchStateInfo = a_nuclideGammaBranchStateInfos.find( residualState );
 
        double chainedMultiplicity = 0.0;
        double chainedAverageGammaEnergy = 0.0;
        if( nuclideGammaBranchStateInfo != nullptr ) {
            nuclideGammaBranchStateInfo->calculateDerivedData( a_nuclideGammaBranchStateInfos );
            chainedMultiplicity = nuclideGammaBranchStateInfo->multiplicity( );
            chainedAverageGammaEnergy = nuclideGammaBranchStateInfo->averageGammaEnergy( );
        }
 
        m_multiplicity += nuclideGammaBranchInfo.probability( ) * ( nuclideGammaBranchInfo.photonEmissionProbability( ) + chainedMultiplicity );
        m_averageGammaEnergy += nuclideGammaBranchInfo.probability( ) * 
                ( nuclideGammaBranchInfo.photonEmissionProbability( ) * nuclideGammaBranchInfo.gammaEnergy( ) + chainedAverageGammaEnergy );
    }
 
    m_derivedCalculated = true;
}

Referenced by calculateDerivedData(), and PoPI::Database::calculateNuclideGammaBranchStateInfos().

derivedCalculated()

bool PoPI::NuclideGammaBranchStateInfo::derivedCalculated ( ) const

inline

Returns the value of the m_derivedCalculated member.

Definition at line 597 of file PoPI.hpp.

intid()

int PoPI::NuclideGammaBranchStateInfo::intid ( ) const

inline

Returns the value of the m_intid member.

Definition at line 590 of file PoPI.hpp.

kind()

std::string const & PoPI::NuclideGammaBranchStateInfo::kind ( ) const

inline

Returns the value of the m_kind member.

Definition at line 591 of file PoPI.hpp.

multiplicity()

double PoPI::NuclideGammaBranchStateInfo::multiplicity ( ) const

inline

Returns the value of the m_multiplicity member.

Definition at line 598 of file PoPI.hpp.

Referenced by GIDI::Functions::Branching1d::Branching1d(), and calculateDerivedData().

nuclearLevelEnergy()

double PoPI::NuclideGammaBranchStateInfo::nuclearLevelEnergy ( ) const

inline

Returns the value of the m_nuclearLevelEnergy member.

Definition at line 592 of file PoPI.hpp.

nuclearLevelEnergyWidth()

double PoPI::NuclideGammaBranchStateInfo::nuclearLevelEnergyWidth ( ) const

inline

Returns the value of the m_nuclearLevelEnergyWidth member.

Definition at line 593 of file PoPI.hpp.

setNuclearLevelEnergyWidth()

void PoPI::NuclideGammaBranchStateInfo::setNuclearLevelEnergyWidth ( double a_nuclearLevelEnergyWidth )

inline

Set the value of the m_nuclearLevelEnergyWidth member to a_nuclearLevelEnergyWidth.

Definition at line 595 of file PoPI.hpp.

state()

std::string const & PoPI::NuclideGammaBranchStateInfo::state ( ) const

inline

Returns the value of the m_state member.

Definition at line 589 of file PoPI.hpp.

Referenced by PoPI::DecayMode::calculateNuclideGammaBranchStateInfo(), PoPI::GammaDecayData::calculateNuclideGammaBranchStateInfo(), PoPI::NuclideGammaBranchStateInfos::find(), PoPI::NuclideGammaBranchStateInfos::find(), and MCGIDI::NuclideGammaBranchStateInfo::NuclideGammaBranchStateInfo().

---

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

• PoPI.hpp
• PoPI_nuclideGammaBranching.cc