GIDI::Reaction Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Reaction:

Public Member Functions
	Reaction (int a_ENDF_MT, std::string const &a_fissionGenre)
	Reaction (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, Protare const &a_protare, Styles::Suite const *a_styles)
	~Reaction ()
bool	active () const
void	setActive (bool a_active)
std::size_t	reactionIndex () const
int	depth () const
int	ENDF_MT () const
int	ENDL_C () const
int	ENDL_S () const
std::string const &	fissionGenre () const
bool	isPairProduction () const
bool	isPhotoAtomicIncoherentScattering () const
bool	RutherfordScatteringPresent () const
bool	onlyRutherfordScatteringPresent () const
bool	nuclearPlusInterferencePresent () const
Component &	doubleDifferentialCrossSection ()
Component const &	doubleDifferentialCrossSection () const
Component &	crossSection ()
Component const &	crossSection () const
Component &	availableEnergy ()
Component const &	availableEnergy () const
Component &	availableMomentum ()
Component const &	availableMomentum () const
OutputChannel *	outputChannel () const
void	setOutputChannel (OutputChannel *a_outputChannel)
void	modifiedMultiGroupElasticForTNSL (std::map< std::string, std::size_t > const &a_maximumTNSL_MultiGroupIndex)
GUPI::Ancestry *	findInAncestry3 (std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (std::string const &a_item) const
std::string	xlinkItemKey () const
bool	hasFission () const
void	productIDs (std::set< std::string > &a_ids, Transporting::Particles const &a_particles, bool a_transportablesOnly) const
int	productMultiplicity (std::string const &a_productID) const
int	maximumLegendreOrder (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const
double	threshold () const
double	crossSectionThreshold () const
double	twoBodyThreshold () const
bool	areAllProductsTracked (Transporting::Particles const &a_particles) const
Vector	multiGroupCrossSection (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_label="") const
Vector	multiGroupQ (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, bool a_final) const
Vector	multiGroupMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const
Matrix	multiGroupProductMatrix (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, std::string const &a_productID, std::size_t a_order) const
Matrix	multiGroupFissionMatrix (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, std::size_t a_order) const
Vector	multiGroupAvailableEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo) const
Vector	multiGroupAverageEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const
Vector	multiGroupDepositionEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles) const
Vector	multiGroupAvailableMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo) const
Vector	multiGroupAverageMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const
Vector	multiGroupDepositionMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles) const
Vector	multiGroupGain (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID, std::string const &a_projectileID) const
void	delayedNeutronProducts (DelayedNeutronProducts &a_delayedNeutronProducts) const
void	incompleteParticles (Transporting::Settings const &a_settings, std::set< std::string > &a_incompleteParticles) const
void	continuousEnergyProductData (Transporting::Settings const &a_settings, std::string const &a_particleID, double a_energy, double &a_productEnergy, double &a_productMomentum, double &a_productGain, bool a_ignoreIncompleteParticles) const
void	mapContinuousEnergyProductData (Transporting::Settings const &a_settings, std::string const &a_particleID, std::vector< double > const &a_energies, std::size_t a_offset, std::vector< double > &a_productEnergies, std::vector< double > &a_productMomenta, std::vector< double > &a_productGains, bool a_ignoreIncompleteParticles) const
bool	modifyCrossSection (Functions::XYs1d const *a_offset, Functions::XYs1d const *a_slope, bool a_updateMultiGroup=false)
bool	modifiedCrossSection (Functions::XYs1d const *a_offset, Functions::XYs1d const *a_slope)
void	recalculateMultiGroupData (ProtareSingle const *a_protare, Styles::TemperatureInfo const &a_temperatureInfo)
void	calculateMultiGroupData (ProtareSingle const *a_protare, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_heatedMultiGroupLabel, MultiGroupCalulationInformation const &a_multiGroupCalulationInformation)
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GIDI::Form
	Form (FormType a_type)
	Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
	Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
	Form (Form const &a_form)
virtual	~Form ()
Form &	operator= (Form const &a_rhs)
Suite *	parent () const
std::string const &	label () const
void	setLabel (std::string const &a_label)
virtual std::string	actualMoniker () const
std::string const &	keyName () const
void	setKeyName (std::string const &a_keyName)
std::string const &	keyValue () const
virtual void	setKeyValue (std::string const &a_keyName) const
FormType	type () const
Form const *	sibling (std::string a_label) const
GUPI::Ancestry *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
Public Member Functions inherited from GUPI::Ancestry
	Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual	~Ancestry ()
Ancestry &	operator= (Ancestry const &a_ancestry)
std::string const &	moniker () const
void	setMoniker (std::string const &a_moniker)
Ancestry *	ancestor ()
Ancestry const *	ancestor () const
void	setAncestor (Ancestry *a_ancestor)
std::string	attribute () const
Ancestry *	root ()
Ancestry const *	root () const
bool	isChild (Ancestry *a_instance)
bool	isParent (Ancestry *a_parent)
bool	isRoot () const
Ancestry *	findInAncestry (std::string const &a_href)
Ancestry const *	findInAncestry (std::string const &a_href) const
virtual LUPI_HOST void	serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
std::string	toXLink () const
void	printXML () const

Friends
class	ProtareSingle

Additional Inherited Members
Static Public Member Functions inherited from GUPI::Ancestry
static std::string	buildXLinkItemKey (std::string const &a_name, std::string const &a_key)

Detailed Description

Definition at line 4245 of file GIDI.hpp.

Constructor & Destructor Documentation

Reaction() [1/2]

GIDI::Reaction::Reaction	(	int	a_ENDF_MT,
		std::string const &	a_fissionGenre )

Parses a <reaction> node.

Definition at line 21 of file GIDI_reaction.cc.

                                                                   :
        Form( FormType::reaction ),
        m_reactionIndex( 0 ),
        m_active( true ),
        m_ENDF_MT( a_ENDF_MT ),
        m_fissionGenre( a_fissionGenre ),
        m_QThreshold( 0.0 ),
        m_crossSectionThreshold( 0.0 ),
        m_twoBodyThreshold( 0.0 ),
        m_isPairProduction( false ),
        m_isPhotoAtomicIncoherentScattering( false ),
        m_RutherfordScatteringPresent( false ),
        m_onlyRutherfordScatteringPresent( false ),
        m_nuclearPlusInterferencePresent( false ),
        m_decayPositronium( false ),
        m_doubleDifferentialCrossSection( GIDI_doubleDifferentialCrossSectionChars, GIDI_labelChars ),
        m_crossSection( GIDI_crossSectionChars, GIDI_labelChars ),
        m_availableEnergy( GIDI_availableEnergyChars, GIDI_labelChars ),
        m_availableMomentum( GIDI_availableMomentumChars, GIDI_labelChars ),
        m_outputChannel( ) {
 
    setMoniker( GIDI_reactionChars );
 
    ENDL_CFromENDF_MT( m_ENDF_MT, &m_ENDL_C, &m_ENDL_S );
}

Reaction() [2/2]

GIDI::Reaction::Reaction	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		PoPI::Database const &	a_pops,
		PoPI::Database const &	a_internalPoPs,
		Protare const &	a_protare,
		Styles::Suite const *	a_styles )

Parses a <reaction> node.

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The reaction HAPI::Node to be parsed and used to construct the reaction.
a_setupInfo	[in] Information create my the Protare constructor to help in parsing.
a_pops	[in] The external PoPI::Database instance used to get particle indices and possibly other particle information.
a_internalPoPs	[in] The internal PoPI::Database instance used to get particle indices and possibly other particle information. This is the <PoPs> node under the <reactionSuite> node.
a_protare	[in] The GIDI::Protare this reaction belongs to.
a_styles	[in] The <styles> node under the <reactionSuite> node.

Definition at line 60 of file GIDI_reaction.cc.

                                                                                                            :
        Form( a_node, a_setupInfo, FormType::reaction ),
        m_active( true ),
        m_ENDF_MT( a_node.attribute_as_int( GIDI_ENDF_MT_Chars ) ),
        m_ENDL_C( 0 ),
        m_ENDL_S( 0 ),
        m_fissionGenre( a_node.attribute_as_string( GIDI_fissionGenreChars ) ),
        m_QThreshold( 0.0 ),
        m_crossSectionThreshold( 0.0 ),
        m_twoBodyThreshold( 0.0 ),
        m_isPairProduction( false ),
        m_isPhotoAtomicIncoherentScattering( false ),
        m_RutherfordScatteringPresent( false ),
        m_onlyRutherfordScatteringPresent( false ),
        m_nuclearPlusInterferencePresent( false ),
        m_decayPositronium( false ),
        m_doubleDifferentialCrossSection( a_construction, GIDI_doubleDifferentialCrossSectionChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, 
                a_internalPoPs, parseDoubleDifferentialCrossSectionSuite, a_styles ),
        m_crossSection( a_construction, GIDI_crossSectionChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseCrossSectionSuite, a_styles ),
        m_availableEnergy( a_construction, GIDI_availableEnergyChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseAvailableSuite, a_styles ),
        m_availableMomentum( a_construction, GIDI_availableMomentumChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseAvailableSuite, a_styles ),
        m_outputChannel( nullptr ) {
 
    m_isPairProduction = label( ).find( "pair production" ) != std::string::npos;
    m_decayPositronium = m_isPairProduction && a_construction.decayPositronium( );
    m_isPhotoAtomicIncoherentScattering = false;
    if( m_doubleDifferentialCrossSection.size( ) > 0 )
        m_isPhotoAtomicIncoherentScattering = m_doubleDifferentialCrossSection.get<Form>( 0 )->type( ) == FormType::incoherentPhotonScattering;
 
    m_doubleDifferentialCrossSection.setAncestor( this );
    m_crossSection.setAncestor( this );
    m_availableEnergy.setAncestor( this );
    m_availableMomentum.setAncestor( this );
 
    a_setupInfo.m_outputChannelLevel = 0;
    m_outputChannel = new OutputChannel( a_construction, a_node.child( GIDI_outputChannelChars ), a_setupInfo, a_pops, 
            a_internalPoPs, a_styles, hasFission( ), true );
    m_outputChannel->setAncestor( this );
 
    HAPI::Node const CoulombPlusNuclearElastic = a_node.child( GIDI_doubleDifferentialCrossSectionChars ).first_child( );
    if( CoulombPlusNuclearElastic.name( ) == GIDI_CoulombPlusNuclearElasticChars ) {    // Check RutherfordScattering.
        m_RutherfordScatteringPresent = true;
        m_onlyRutherfordScatteringPresent = true;
        for( HAPI::Node child = CoulombPlusNuclearElastic.first_child( ); !child.empty( ); child.to_next_sibling( ) ) {
            if( child.name( ) != GIDI_RutherfordScatteringChars ) m_onlyRutherfordScatteringPresent = false;
            if( child.name( ) == GIDI_nuclearPlusInterferenceChars ) m_nuclearPlusInterferencePresent = true;
        }
    }
 
    ENDL_CFromENDF_MT( m_ENDF_MT, &m_ENDL_C, &m_ENDL_S );
    if( a_setupInfo.m_isENDL_C_9 ) m_ENDL_C = 9;
    if( m_ENDL_C == 20 ) {
        Product *product = m_outputChannel->products( ).get<Product>( 0 );
        if( product->particle( ).ID( ) == "H1" ) m_ENDL_C = 21;
    }
    else if( m_ENDL_C == 22 ) {
        Product *product = m_outputChannel->products( ).get<Product>( 0 );
        if( product->particle( ).ID( ) == "H2" ) m_ENDL_C = 35;
    }
 
    if( ( a_construction.parseMode( ) != Construction::ParseMode::outline ) && ( a_construction.parseMode( ) != Construction::ParseMode::readOnly ) ) {
        double _Q = 0.0;
        Form const &QForm = *(m_outputChannel->Q( ).get<Form>( 0 ));
        switch( QForm.type( ) ) {
        case FormType::constant1d : {
            Functions::Constant1d const &constant1d = static_cast<Functions::Constant1d const &>( QForm );
            _Q = constant1d.value( );
            break; }
        case FormType::XYs1d : {
            Functions::XYs1d const &xys1d = static_cast<Functions::XYs1d const &>( QForm );
            _Q = xys1d.evaluate( 0.0 );
            break; }
        case FormType::gridded1d : {        // Should be a special reaction (e.g., summed multi-group data) and can be ignored.
            _Q = 0.0;
            break; }
        default :
            throw Exception( "Reaction::Reaction: unsupported Q form " + QForm.label( ) );
        }
        m_twoBodyThreshold = -_Q * a_protare.thresholdFactor( );
        _Q *= -1;
        if( _Q <= 0.0 ) _Q = 0.0;
        m_QThreshold = a_protare.thresholdFactor( ) * _Q;
 
        if( _Q > 0.0 ) {               // Try to do a better job determining m_crossSectionThreshold.
            std::vector<Suite::const_iterator> monikers = a_protare.styles( ).findAllOfMoniker( GIDI_griddedCrossSectionStyleChars );
            if( ( a_construction.parseMode( ) != Construction::ParseMode::multiGroupOnly ) && ( monikers.size( ) > 0 ) ) {
                Styles::GriddedCrossSection const &griddedCrossSection = static_cast<Styles::GriddedCrossSection const &>( **monikers[0] );
                Grid grid = griddedCrossSection.grid( );
 
                if( m_crossSection.has( griddedCrossSection.label( ) ) ) {
                    Functions::Ys1d const &ys1d = static_cast<Functions::Ys1d const &>( *m_crossSection.get<Functions::Ys1d>( griddedCrossSection.label( ) ) );
                    m_crossSectionThreshold = grid[ys1d.start( )];
                }
            }
            if( m_crossSectionThreshold == 0.0 ) {      // Should also check 'evaluate' style before using m_QThreshold as a default.
                m_crossSectionThreshold = m_QThreshold;
            }
        }
        if( m_twoBodyThreshold > 0.0 ) m_twoBodyThreshold = m_crossSectionThreshold;
    }
}

~Reaction()

GIDI::Reaction::~Reaction

(

)

Definition at line 166 of file GIDI_reaction.cc.

                     {
 
    if( m_outputChannel != nullptr ) delete m_outputChannel;
}

Member Function Documentation

active()

bool GIDI::Reaction::active ( ) const

inline

Returns the value of the m_active member.

Definition at line 4280 of file GIDI.hpp.

Referenced by GIDI::ProtareSingle::delayedNeutronProducts(), GIDI::ProtareSingle::hasFission(), GIDI::ProtareSingle::incompleteParticles(), GIDI::ProtareSingle::isDelayedFissionNeutronComplete(), GIDI::ProtareSingle::maximumLegendreOrder(), GIDI::ProtareSingle::multiGroupAverageEnergy(), GIDI::ProtareSingle::multiGroupAverageMomentum(), GIDI::ProtareSingle::multiGroupDepositionEnergy(), GIDI::ProtareSingle::multiGroupFissionGammaMultiplicity(), GIDI::ProtareSingle::multiGroupFissionMatrix(), GIDI::ProtareSingle::multiGroupFissionNeutronMultiplicity(), GIDI::ProtareSingle::multiGroupMultiplicity(), GIDI::ProtareSingle::multiGroupProductMatrix(), GIDI::ProtareSingle::numberOfInactiveReactions(), GIDI::ProtareSingle::productIDs(), GIDI::Protare::reactionIndicesMatchingENDLCValues(), and GIDI::ProtareSingle::reactionToMultiGroup().

areAllProductsTracked()

bool GIDI::Reaction::areAllProductsTracked

(

Transporting::Particles const &

a_particles

)

const

Returns true if all outgoing particles (i.e., products) are specifed in a_particles. That is, the user will be tracking all products of this reaction.

Parameters

a_particles

[in] The list of particles to be transported.

Returns

bool.

Definition at line 331 of file GIDI_reaction.cc.

                                                                                     {
 
    if( hasFission( ) || m_isPhotoAtomicIncoherentScattering ) return( false );
 
    return( m_outputChannel->areAllProductsTracked( a_particles ) );
}

Referenced by GIDI::ProtareSingle::multiGroupDepositionEnergy(), and multiGroupDepositionEnergy().

availableEnergy() [1/2]

Component & GIDI::Reaction::availableEnergy ( )

inline

Returns a reference to the m_availableEnergy member.

Definition at line 4302 of file GIDI.hpp.

Referenced by multiGroupDepositionEnergy().

availableEnergy() [2/2]

Component const & GIDI::Reaction::availableEnergy ( ) const

inline

Returns a reference to the m_availableEnergy member.

Definition at line 4303 of file GIDI.hpp.

availableMomentum() [1/2]

Component & GIDI::Reaction::availableMomentum ( )

inline

Returns a reference to the m_availableMomentum member.

Definition at line 4304 of file GIDI.hpp.

availableMomentum() [2/2]

Component const & GIDI::Reaction::availableMomentum ( ) const

inline

Returns a reference to the m_availableMomentum member.

Definition at line 4305 of file GIDI.hpp.

calculateMultiGroupData()

void GIDI::Reaction::calculateMultiGroupData	(	ProtareSingle const *	a_protare,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_heatedMultiGroupLabel,
		MultiGroupCalulationInformation const &	a_multiGroupCalulationInformation )

This methods calculates multi-group data for all needed components and adds each component's multi-group with label a_heatedMultiGroupLabel.

Parameters

a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_heatedMultiGroupLabel	[in] The label of the style for the multi-group data being added.
a_multiGroupCalulationInformation	[in] Store multi-group boundary and flux data used for multi-grouping.
a_crossSectionXYs1d	[in[ The cross section weight.

Definition at line 867 of file GIDI_reaction.cc.

                                                                                                                                     {
 
    Styles::Suite const &styles = a_protare->styles( );
    Transporting::MultiGroup multiGroup = a_multiGroupCalulationInformation.m_multiGroup;
 
    std::vector<double> flatValues { multiGroup[0], 1.0, multiGroup[multiGroup.size( ) - 1], 1.0 };
    Functions::XYs1d flatFunction( Axes( ), ptwXY_interpolationLinLin, flatValues );
 
    Functions::XYs1d const *crossSectionXYs1d = static_cast<Functions::XYs1d *>( 
                m_crossSection.findInstanceOfTypeInLineage( styles, a_temperatureInfo.heatedCrossSection( ), GIDI_XYs1dChars ) );
 
    calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_crossSection, flatFunction );
    calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_availableEnergy, *crossSectionXYs1d );
    calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_availableMomentum, *crossSectionXYs1d );
 
    if( m_outputChannel != nullptr ) 
        m_outputChannel->calculateMultiGroupData( a_protare, a_temperatureInfo, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, *crossSectionXYs1d );
}

Referenced by recalculateMultiGroupData().

continuousEnergyProductData()

void GIDI::Reaction::continuousEnergyProductData	(	Transporting::Settings const &	a_settings,
		std::string const &	a_particleID,
		double	a_energy,
		double &	a_productEnergy,
		double &	a_productMomentum,
		double &	a_productGain,
		bool	a_ignoreIncompleteParticles ) const

Returns, via arguments, the average energy and momentum, and gain for product with particle id a_particleID.

Parameters

a_settings	[in] Specifies the requested label.
a_particleID	[in] The particle id of the product.
a_energy	[in] The energy of the projectile.
a_productEnergy	[in] The average energy of the product.
a_productMomentum	[in] The average momentum of the product.
a_productGain	[in] The gain of the product.
a_ignoreIncompleteParticles	[in] If true, incomplete particles are ignore, otherwise a throw is executed.

Definition at line 666 of file GIDI_reaction.cc.

                                                                                {
 
    a_productEnergy = 0.0;
    a_productMomentum = 0.0;
    a_productGain = 0.0;
 
//    if( ENDF_MT( ) == 516 ) return;             // FIXME, may be something wrong with the way FUDGE converts ENDF to GNDS.
 
    if( m_outputChannel != nullptr )
        m_outputChannel->continuousEnergyProductData( a_settings, a_particleID, a_energy, a_productEnergy, a_productMomentum, a_productGain, 
                a_ignoreIncompleteParticles );
}

crossSection() [1/2]

Component & GIDI::Reaction::crossSection ( )

inline

Returns a reference to the m_crossSection member.

Definition at line 4299 of file GIDI.hpp.

crossSection() [2/2]

Component const & GIDI::Reaction::crossSection ( ) const

inline

Returns a reference to the m_crossSection member.

Definition at line 4300 of file GIDI.hpp.

crossSectionThreshold()

double GIDI::Reaction::crossSectionThreshold ( ) const

inline

Returns the value of the m_crossSectionThreshold member.

Definition at line 4324 of file GIDI.hpp.

delayedNeutronProducts()

void GIDI::Reaction::delayedNeutronProducts

(

DelayedNeutronProducts &

a_delayedNeutronProducts

)

const

Appends a DelayedNeutronProduct instance for each delayed neutron in m_delayedNeutrons.

Parameters

a_delayedNeutronProducts

[in/out] The list to append the delayed neutrons to.

Definition at line 636 of file GIDI_reaction.cc.

                                                                                              {
 
    if( m_outputChannel != nullptr ) m_outputChannel->delayedNeutronProducts( a_delayedNeutronProducts );
}

Referenced by GIDI::ProtareSingle::delayedNeutronProducts().

depth()

int GIDI::Reaction::depth ( ) const

inline

Returns the maximum product depth for this reaction.

Definition at line 4283 of file GIDI.hpp.

doubleDifferentialCrossSection() [1/2]

Component & GIDI::Reaction::doubleDifferentialCrossSection ( )

inline

Returns a reference to the m_doubleDifferentialCrossSection member.

Definition at line 4297 of file GIDI.hpp.

Referenced by MCGIDI::Distributions::parseGIDI().

doubleDifferentialCrossSection() [2/2]

Component const & GIDI::Reaction::doubleDifferentialCrossSection ( ) const

inline

Returns a reference to the m_doubleDifferentialCrossSection member.

Definition at line 4298 of file GIDI.hpp.

ENDF_MT()

int GIDI::Reaction::ENDF_MT ( ) const

inline

Returns the value of the m_ENDF_MT member.

Definition at line 4284 of file GIDI.hpp.

Referenced by toXMLList().

ENDL_C()

int GIDI::Reaction::ENDL_C ( ) const

inline

Returns the value of the m_ENDL_C member.

Definition at line 4285 of file GIDI.hpp.

Referenced by GIDI::Protare::reactionIndicesMatchingENDLCValues().

ENDL_S()

int GIDI::Reaction::ENDL_S ( ) const

inline

Returns the value of the m_ENDL_S member.

Definition at line 4286 of file GIDI.hpp.

findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::Reaction::findInAncestry3 ( std::string const & a_item )

virtual

Used by GUPI::Ancestry to tranverse GNDS nodes. This method returns a pointer to a derived class' a_item member or nullptr if none exists.

Parameters

a_item

[in] The name of the class member whose pointer is to be return.

Returns

The pointer to the class member or nullptr if class does not have a member named a_item.

Implements GUPI::Ancestry.

Definition at line 292 of file GIDI_reaction.cc.

                                                                 {
 
    if( a_item == GIDI_doubleDifferentialCrossSectionChars ) return( &m_doubleDifferentialCrossSection );
    if( a_item == GIDI_crossSectionChars ) return( &m_crossSection );
    if( a_item == GIDI_availableEnergyChars ) return( &m_availableEnergy );
    if( a_item == GIDI_availableMomentumChars ) return( &m_availableMomentum );
    if( a_item == GIDI_outputChannelChars ) return( m_outputChannel );
 
    return( nullptr );
}

findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::Reaction::findInAncestry3 ( std::string const & a_item ) const

virtual

Used by GUPI::Ancestry to tranverse GNDS nodes. This method returns a pointer to a derived class' a_item member or nullptr if none exists.

Parameters

a_item

[in] The name of the class member whose pointer is to be return.

Returns

The pointer to the class member or nullptr if class does not have a member named a_item.

Implements GUPI::Ancestry.

Definition at line 311 of file GIDI_reaction.cc.

                                                                             {
 
    if( a_item == GIDI_doubleDifferentialCrossSectionChars ) return( &m_doubleDifferentialCrossSection );
    if( a_item == GIDI_crossSectionChars ) return( &m_crossSection );
    if( a_item == GIDI_availableEnergyChars ) return( &m_availableEnergy );
    if( a_item == GIDI_availableMomentumChars ) return( &m_availableMomentum );
    if( a_item == GIDI_outputChannelChars ) return( m_outputChannel );
 
    return( nullptr );
}

fissionGenre()

std::string const & GIDI::Reaction::fissionGenre ( ) const

inline

Definition at line 4287 of file GIDI.hpp.

{ return( m_fissionGenre ); }

hasFission()

bool GIDI::Reaction::hasFission

(

)

const

Returns true if at least one output channel contains a fission channel.

Returns

true if at least one output channel is a fission channel.

Definition at line 246 of file GIDI_reaction.cc.

                                 {
 
    if( m_ENDF_MT == 18 ) return( true );
    if( m_ENDF_MT == 19 ) return( true );
    if( m_ENDF_MT == 20 ) return( true );
    if( m_ENDF_MT == 21 ) return( true );
    if( m_ENDF_MT == 38 ) return( true );
 
    return( false );
}

Referenced by areAllProductsTracked(), GIDI::ProtareSingle::delayedNeutronProducts(), GIDI::ProtareSingle::hasFission(), GIDI::ProtareSingle::isDelayedFissionNeutronComplete(), GIDI::ProtareSingle::multiGroupFissionGammaMultiplicity(), GIDI::ProtareSingle::multiGroupFissionMatrix(), multiGroupFissionMatrix(), GIDI::ProtareSingle::multiGroupFissionNeutronMultiplicity(), and Reaction().

incompleteParticles()

void GIDI::Reaction::incompleteParticles	(	Transporting::Settings const &	a_settings,
		std::set< std::string > &	a_incompleteParticles ) const

If this has an output channel, this output channel's **incompleteParticles* is called.

Parameters

a_settings	[in] Specifies the requested label.
a_incompleteParticles	[out] The list of particles whose completeParticle method returns false.

Definition at line 648 of file GIDI_reaction.cc.

                                                                                                                           {
 
    if( m_outputChannel != nullptr ) m_outputChannel->incompleteParticles( a_settings, a_incompleteParticles );
    if( m_isPairProduction ) a_incompleteParticles.erase( PoPI::IDs::photon );          // Kludge for old processed files.
}

Referenced by GIDI::ProtareSingle::incompleteParticles().

isPairProduction()

bool GIDI::Reaction::isPairProduction ( ) const

inline

Returns the value of the m_isPairProduction member.

Definition at line 4288 of file GIDI.hpp.

isPhotoAtomicIncoherentScattering()

bool GIDI::Reaction::isPhotoAtomicIncoherentScattering ( ) const

inline

Returns the value of the m_isPhotoAtomicIncoherentScattering member.

Definition at line 4289 of file GIDI.hpp.

mapContinuousEnergyProductData()

void GIDI::Reaction::mapContinuousEnergyProductData	(	Transporting::Settings const &	a_settings,
		std::string const &	a_particleID,
		std::vector< double > const &	a_energies,
		std::size_t	a_offset,
		std::vector< double > &	a_productEnergies,
		std::vector< double > &	a_productMomenta,
		std::vector< double > &	a_productGains,
		bool	a_ignoreIncompleteParticles ) const

Modifies the average product energies, momenta and gains for product with particle id a_particleID.

Parameters

a_settings	[in] Specifies user options.
a_particleID	[in] The particle id of the product.
a_energies	[in] The vector of energies to map the data to.
a_offset	[in] The index of the first energy whose data are to be added to the vectors.
a_productEnergies	[out] The vector of average energies of the product.
a_productMomenta	[out] The vector of average momenta of the product.
a_productGains	[out] The vector of gain of the product.
a_ignoreIncompleteParticles	[in] If true, incomplete particles are ignore, otherwise a throw is executed.

Definition at line 693 of file GIDI_reaction.cc.

                                                                                            {
 
//    if( ENDF_MT( ) == 516 ) return;             // FIXME, may be something wrong with the way FUDGE converts ENDF to GNDS.
 
    if( m_outputChannel != nullptr )
        m_outputChannel->mapContinuousEnergyProductData( a_settings, a_particleID, a_energies, a_offset, a_productEnergies, 
                a_productMomenta, a_productGains, a_ignoreIncompleteParticles );
}

maximumLegendreOrder()

int GIDI::Reaction::maximumLegendreOrder	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_productID ) const

Determines the maximum Legredre order present in the multi-group transfer matrix for a give product for a give label. Inspects all products produced by this reaction.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_productID	[in] Particle id of the requested product.

Returns

The maximum Legredre order. If no transfer matrix data are present for the requested product, -1 is returned.

Definition at line 208 of file GIDI_reaction.cc.

                                                                                                     {
 
    if( m_isPairProduction && ( a_productID == PoPI::IDs::photon ) ) return( 0 );
    return( m_outputChannel->maximumLegendreOrder( a_smr, a_settings, a_temperatureInfo, a_productID ) );
}

Referenced by GIDI::ProtareSingle::maximumLegendreOrder().

modifiedCrossSection()

bool GIDI::Reaction::modifiedCrossSection	(	Functions::XYs1d const *	a_offset,
		Functions::XYs1d const *	a_slope )

Thid methid is deprecated, use modifyCrossSection instead. See modifyCrossSection for useage.

Definition at line 820 of file GIDI_reaction.cc.

                                                                                                   {
 
    return modifyCrossSection( a_offset, a_slope, false );
}

modifiedMultiGroupElasticForTNSL()

void GIDI::Reaction::modifiedMultiGroupElasticForTNSL

(

std::map< std::string, std::size_t > const &

a_maximumTNSL_MultiGroupIndex

)

Only for internal use. Called by ProtareTNSL instance to zero the lower energy multi-group data covered by the TNSL ProtareSingle.

Parameters

a_maximumTNSL_MultiGroupIndex

[in] A map that contains labels for heated multi-group data and the last valid group boundary for the TNSL data for that boundary.

Definition at line 276 of file GIDI_reaction.cc.

                                                                                                                  {
 
    m_crossSection.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_availableEnergy.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_availableMomentum.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_outputChannel->modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
}

modifyCrossSection()

bool GIDI::Reaction::modifyCrossSection	(	Functions::XYs1d const *	a_offset,
		Functions::XYs1d const *	a_slope,
		bool	a_updateMultiGroup = false )

This method modifies the cross section for this reaction as

     crossSection = a_offset + a_slope * crossSection

Either or both of a_offset and a_slope can be an empty Functions::XYs1d instance or a nullptr. If both a_offset and a_slope are non-empty Functions::XYs1d instances, the domains of both must be the same. If the returned value is false, no data are changed.

Parameters

a_offset	[in] A pointer to a XYs1d function for the offset.
a_slope	[in] A pointer to a XYs1d function for the slope.
a_updateMultiGroup	[in] If true, the multi-group data are also modified.

Returns

true if data can be modified and false otherwise.

Definition at line 720 of file GIDI_reaction.cc.

                                                                                                                          {
/*
    -) FIXME, this does not modify the total cross section for the protare! Does it needed to be?
*/
 
    ProtareSingle &protare( dynamic_cast<ProtareSingle &>( *root( ) ) );
    Styles::Suite const &styles = protare.styles( );
    Functions::XYs1d const *offset1 = a_offset, *slope1 = a_slope;
 
    if( a_offset == nullptr ) offset1 = new Functions::XYs1d( );            // Handle nullptr cases.
    if( a_slope == nullptr ) slope1 = new Functions::XYs1d( );
 
    if( offset1->size( ) == 0 ) {                                           // Handle empty functions.
        if( slope1->size( ) == 0 ) {
            if( a_offset == nullptr ) delete offset1;
            if( a_slope == nullptr ) delete slope1;
            return( false );
        }
        Functions::XYs1d const *offset2 = Functions::XYs1d::makeConstantXYs1d( offset1->axes( ), slope1->domainMin( ), slope1->domainMax( ), 0.0 );
        if( a_offset == nullptr ) delete offset1;
        offset1 = offset2; }
    else if( slope1->size( )  == 0 ) {
        Functions::XYs1d const *slope2 = Functions::XYs1d::makeConstantXYs1d( slope1->axes( ), offset1->domainMin( ), offset1->domainMax( ), 1.0 );
        if( a_slope == nullptr ) delete slope1;
        slope1 = slope2;
    }
 
    double domainMin = offset1->domainMin( ), domainMax = offset1->domainMax( );
 
    if( domainMin != slope1->domainMin( ) ) throw Exception( "GIDI::Reaction::modifyCrossSection: offset and slope domainMins differ." );
    if( domainMax != slope1->domainMax( ) ) throw Exception( "GIDI::Reaction::modifyCrossSection: offset and slope domainMaxs differ." );
 
    Styles::TemperatureInfos temperatureInfos = protare.temperatures( );
 
    Functions::XYs1d *xys1d = static_cast<Functions::XYs1d *>(
            m_crossSection.findInstanceOfTypeInLineage( styles, temperatureInfos[0].heatedCrossSection( ), GIDI_XYs1dChars ) );
    if( xys1d == nullptr ) throw Exception( "GIDI::Reaction::modifyCrossSection: could not find XYs1d cross section." );
 
    if( ( xys1d->domainMin( ) >= domainMax ) || ( xys1d->domainMax( ) <= domainMin ) ) {
        if( a_offset == nullptr ) delete offset1;
        if( a_slope == nullptr ) delete slope1;
        return( false );
    }
 
    double crossSectionDomainMax = xys1d->domainMax( );
    if( xys1d->domainMin( ) > domainMin ) domainMin = xys1d->domainMin( );
    if( crossSectionDomainMax < domainMax ) domainMax = crossSectionDomainMax;
 
    Functions::XYs1d offset = offset1->domainSlice( domainMin, domainMax, true );
    Functions::XYs1d slope  = slope1->domainSlice( domainMin, domainMax, true );
    if( a_offset == nullptr ) delete offset1;
    if( a_slope == nullptr ) delete slope1;
 
    for( auto temperatureInfo = temperatureInfos.begin( ); temperatureInfo != temperatureInfos.end( ); ++temperatureInfo ) {
        xys1d = static_cast<Functions::XYs1d *>( 
                m_crossSection.findInstanceOfTypeInLineage( styles, temperatureInfo->heatedCrossSection( ), GIDI_XYs1dChars ) );
        Functions::XYs1d xys1dSliced = xys1d->domainSlice( domainMin, domainMax, true );
        if( xys1dSliced.interpolation( ) != ptwXY_interpolationLinLin ) {
            Functions::XYs1d *temp = xys1dSliced.asXYs1d( true, 1e-3, 1e-6, 1e-6 );
            xys1dSliced = (*temp);
            delete temp;
        }
        Functions::XYs1d modified = offset + slope * xys1dSliced;
 
        int64_t index1;
        ptwXYPoint *p1;
        ptwXYPoints *ptwXY = xys1d->ptwXY( );
        int64_t length = ptwXY_length( nullptr, ptwXY );
        for( index1 = 0, p1 = ptwXY->points; index1 < length; ++index1, ++p1 ) {
            if( p1->x  < domainMin ) continue;
            if( p1->x >= domainMax ) {
                if( ( p1->x != domainMax ) || ( p1->x != crossSectionDomainMax ) ) break;
            }
            p1->y = modified.evaluate( p1->x );
        }
 
        Functions::Ys1d *ys1d = m_crossSection.get<Functions::Ys1d>( temperatureInfo->griddedCrossSection( ) );
        std::vector<double> &Ys = ys1d->Ys( );
        Styles::GriddedCrossSection const griddedCrossSection = *styles.get<Styles::GriddedCrossSection>( temperatureInfo->griddedCrossSection( ) );
        nf_Buffer<double> const &grid = griddedCrossSection.grid( ).values( );
        std::size_t start = ys1d->start( ), size = ys1d->size( ), index2;
        for( index2 = 0; index2 < size; ++index2, ++start ) {
            double xValue = grid[start];
 
            if( xValue  < domainMin ) continue;
            if( xValue >= domainMax ) {
                if( ( xValue != domainMax ) || ( xValue != crossSectionDomainMax ) ) break;
            }
            Ys[index2] = modified.evaluate( xValue );
        }
        if( a_updateMultiGroup ) recalculateMultiGroupData( &protare, *temperatureInfo );
    }
 
    return( true );
}

Referenced by modifiedCrossSection().

multiGroupAvailableEnergy()

Vector GIDI::Reaction::multiGroupAvailableEnergy	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo ) const

Returns the multi-group, total available energy for the requested label. This is a cross section weighted available energy.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.

Returns

The requested multi-group available energy as a GIDI::Vector.

Definition at line 455 of file GIDI_reaction.cc.

                                                                       {
 
    Vector vector( 0 );
 
    Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( a_smr, m_availableEnergy, a_temperatureInfo, "available energy" ) );
    if( form != nullptr ) vector = form->data( );
 
    if( m_decayPositronium ) 
        vector -= m_outputChannel->multiGroupQ( a_smr, a_settings, a_temperatureInfo, false );
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupAvailableEnergy(), and multiGroupDepositionEnergy().

multiGroupAvailableMomentum()

Vector GIDI::Reaction::multiGroupAvailableMomentum	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo ) const

Returns the multi-group, total available momentum for the requested label. This is a cross section weighted available momentum.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.

Returns

The requested multi-group available momentum as a GIDI::Vector.

Definition at line 544 of file GIDI_reaction.cc.

                                                                       {
 
    Vector vector( 0 );
 
    Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( a_smr, m_availableMomentum, a_temperatureInfo, "available momentum" ) );
    if( form != nullptr ) vector = form->data( );
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupAvailableMomentum(), and multiGroupDepositionMomentum().

multiGroupAverageEnergy()

Vector GIDI::Reaction::multiGroupAverageEnergy	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_productID ) const

Returns the multi-group, total average energy for the requested label for the requested product. This is a cross section weighted average energy summed over all products for this reaction.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_productID	[in] Particle id for the requested product.

Returns

The requested multi-group average energy as a GIDI::Vector.

Definition at line 481 of file GIDI_reaction.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    if( m_decayPositronium ) {
        if( a_productID == PoPI::IDs::photon ) vector += multiGroupCrossSection( a_smr, a_settings, a_temperatureInfo ) * 2.0 * PoPI_electronMass_MeV_c2; }
    else {
        vector += m_outputChannel->multiGroupAverageEnergy( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupAverageEnergy(), and multiGroupDepositionEnergy().

multiGroupAverageMomentum()

Vector GIDI::Reaction::multiGroupAverageMomentum	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_productID ) const

Returns the multi-group, total average momentum for the requested label for the requested product. This is a cross section weighted average momentum.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_productID	[in] Particle id for the requested product.

Returns

The requested multi-group average momentum as a GIDI::Vector.

Definition at line 565 of file GIDI_reaction.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    if( !m_isPairProduction ) vector += m_outputChannel->multiGroupAverageMomentum( a_smr, a_settings, a_temperatureInfo, a_productID );
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupAverageMomentum(), and multiGroupDepositionMomentum().

multiGroupCrossSection()

Vector GIDI::Reaction::multiGroupCrossSection	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_label = "" ) const

Returns the multi-group, cross section for the requested label the reaction.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_label	[in] If not an empty string, this is used as the label for the form to return and the a_temperatureInfo labels are ignored.

Returns

The requested multi-group cross section as a GIDI::Vector.

Definition at line 349 of file GIDI_reaction.cc.

                                                                                                 {
 
    Vector vector( 0 );
 
    Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( 
            a_settings.form( a_smr, m_crossSection, a_temperatureInfo, "cross section", a_label ) );
    if( form != nullptr ) vector = form->data( );
 
    return( vector );
}

Referenced by multiGroupAverageEnergy(), GIDI::ProtareSingle::multiGroupCrossSection(), multiGroupGain(), multiGroupMultiplicity(), and multiGroupProductMatrix().

multiGroupDepositionEnergy()

Vector GIDI::Reaction::multiGroupDepositionEnergy	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		Transporting::Particles const &	a_particles ) const

Returns the multi-group, total deposition energy for the requested label for this reaction. This is a cross section weighted deposition energy. The deposition energy is calculated by subtracting the average energy from each transportable particle from the available energy. The list of transportable particles is specified via the list of particle specified in the a_settings argument. This method does not include any photon deposition energy for this reaction that is in the GNDS orphanProducts node.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label and the products that are transported.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_particles	[in] The list of particles to be transported.

Returns

The requested multi-group deposition energy as a GIDI::Vector.

Definition at line 509 of file GIDI_reaction.cc.

                                                                                                                 {
 
    std::map<std::string, Transporting::Particle> const &products = a_particles.particles( );
    Vector vector;
 
    if( moniker( ) != GIDI_orphanProductChars ) {
        if( ( a_settings.zeroDepositionIfAllProductsTracked( ) ) && areAllProductsTracked( a_particles ) && !m_isPairProduction ) return( vector );
 
        vector = multiGroupAvailableEnergy( a_smr, a_settings, a_temperatureInfo );
    }
 
    Vector availableEnergy( vector );
 
    for( std::map<std::string, Transporting::Particle>::const_iterator iter = products.begin( ); iter != products.end( ); ++iter ) {
        vector -= multiGroupAverageEnergy( a_smr, a_settings, a_temperatureInfo, iter->first );
    }
 
    for( std::size_t index = 0; index < availableEnergy.size( ); ++index ) {        // Check for values that should probably be 0.0.
        if( std::fabs( vector[index] ) < std::fabs( 1e-14 * availableEnergy[index] ) ) vector[index] = 0.0;
    }
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupDepositionEnergy().

multiGroupDepositionMomentum()

Vector GIDI::Reaction::multiGroupDepositionMomentum	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		Transporting::Particles const &	a_particles ) const

Returns the multi-group, total deposition momentum for the requested label for this reaction. This is a cross section weighted deposition momentum. The deposition momentum is calculated by subtracting the average momentum from each transportable particle from the available momentum. The list of transportable particles is specified via the list of particle specified in the a_settings argument. This method does not include any photon deposition momentum for this reaction that is in the GNDS orphanProducts node.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_particles	[in] The list of particles to be transported.

Returns

The requested multi-group deposition momentum as a GIDI::Vector.

Definition at line 589 of file GIDI_reaction.cc.

                                                                                                                 {
 
    std::map<std::string, Transporting::Particle> const &products = a_particles.particles( );
    Vector vector;
 
    if( moniker( ) != GIDI_orphanProductChars ) {
        vector = multiGroupAvailableMomentum( a_smr, a_settings, a_temperatureInfo );
    }
 
    for( std::map<std::string, Transporting::Particle>::const_iterator iter = products.begin( ); iter != products.end( ); ++iter ) {
        vector -= multiGroupAverageMomentum( a_smr, a_settings, a_temperatureInfo, iter->first );
    }
 
    return( vector );
}

multiGroupFissionMatrix()

Matrix GIDI::Reaction::multiGroupFissionMatrix	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		Transporting::Particles const &	a_particles,
		std::size_t	a_order ) const

Like Reaction::multiGroupProductMatrix, but only returns the fission neutron, transfer matrix.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label and if delayed neutrons should be included.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_particles	[in] The list of particles to be transported.
a_order	[in] Requested product matrix, Legendre order.

Returns

The requested multi-group neutron fission matrix as a GIDI::Matrix.

Definition at line 436 of file GIDI_reaction.cc.

                                                                                                                                    {
 
    Matrix matrix( 0, 0 );
 
    if( hasFission( ) ) matrix += multiGroupProductMatrix( a_smr, a_settings, a_temperatureInfo, a_particles, PoPI::IDs::neutron, a_order );
    return( matrix );
}

Referenced by GIDI::ProtareSingle::multiGroupFissionMatrix().

multiGroupGain()

Vector GIDI::Reaction::multiGroupGain	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_productID,
		std::string const &	a_projectileID ) const

Returns the multi-group, gain for the requested particle and label. This is a cross section weighted gain summed over all reactions. If a_productID and a_projectileID are the same, then the multi-group cross section is subtracted for the returned value to indicate that the a_projectileID as been absorted.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_productID	[in] The particle PoPs' id for the whose gain is to be calculated.
a_projectileID	[in] The particle PoPs' id for the projectile.

Returns

The requested multi-group gain as a GIDI::Vector.

Definition at line 620 of file GIDI_reaction.cc.

                                                                                                                                       {
 
    Vector vector( multiGroupMultiplicity( a_smr, a_settings, a_temperatureInfo, a_productID ) );
 
    if( PoPI::compareSpecialParticleIDs( a_productID, a_projectileID ) ) vector -= multiGroupCrossSection( a_smr, a_settings, a_temperatureInfo );
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupGain().

multiGroupMultiplicity()

Vector GIDI::Reaction::multiGroupMultiplicity	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string const &	a_productID ) const

Returns the multi-group, total multiplicity for the requested label for the requested product. This is a cross section weighted multiplicity.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_productID	[in] Particle id for the requested product.

Returns

The requested multi-group multiplicity as a GIDI::Vector.

Definition at line 226 of file GIDI_reaction.cc.

                                                                                                         {
 
    Vector vector( 0 );
 
    if( m_decayPositronium ) {
        if( a_productID == PoPI::IDs::photon ) vector += multiGroupCrossSection( a_smr, a_settings, a_temperatureInfo ) * 2; }
    else {
        vector += m_outputChannel->multiGroupMultiplicity( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    return( vector );
}

Referenced by GIDI::ProtareSingle::multiGroupFissionGammaMultiplicity(), GIDI::ProtareSingle::multiGroupFissionNeutronMultiplicity(), multiGroupGain(), and GIDI::ProtareSingle::multiGroupMultiplicity().

multiGroupProductMatrix()

Matrix GIDI::Reaction::multiGroupProductMatrix	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		Transporting::Particles const &	a_particles,
		std::string const &	a_productID,
		std::size_t	a_order ) const

Returns the multi-group, product matrix for the requested label for the requested product index for the requested Legendre order. If no data are found, an empty GIDI::Matrix is returned.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label and if delayed neutrons should be included.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_particles	[in] The list of particles to be transported.
a_productID	[in] Particle id for the requested product.
a_order	[in] Requested product matrix, Legendre order.

Returns

The requested multi-group product matrix as a GIDI::Matrix.

Definition at line 395 of file GIDI_reaction.cc.

                                          {
 
    Matrix matrix( 0, 0 );
 
    if( m_decayPositronium ) {
        if( a_productID == PoPI::IDs::photon ) {
            if( a_order == 0 ) {
                Vector productionCrossSection = multiGroupCrossSection( a_smr, a_settings, a_temperatureInfo ) * 2;
                std::map<std::string, GIDI::Transporting::Particle> const &particles = a_particles.particles( );
                std::map<std::string, GIDI::Transporting::Particle>::const_iterator particle = particles.find( PoPI::IDs::photon );
                GIDI::Transporting::MultiGroup const &multiGroup = particle->second.fineMultiGroup( );
                int multiGroupIndexFromEnergy = multiGroup.multiGroupIndexFromEnergy( PoPI_electronMass_MeV_c2, true );
                Matrix matrix2( productionCrossSection.size( ), productionCrossSection.size( ) );
 
                for( std::size_t i1 = 0; i1 < productionCrossSection.size( ); ++i1 ) {
                    matrix2.set( i1, static_cast<std::size_t>( multiGroupIndexFromEnergy ), productionCrossSection[i1] );
                }
                matrix += matrix2;
            }
        } }
    else {
        matrix += m_outputChannel->multiGroupProductMatrix( a_smr, a_settings, a_temperatureInfo, a_particles, a_productID, a_order );
    }
 
    return( matrix );
}

Referenced by multiGroupFissionMatrix(), and GIDI::ProtareSingle::multiGroupProductMatrix().

multiGroupQ()

Vector GIDI::Reaction::multiGroupQ	(	LUPI::StatusMessageReporting &	a_smr,
		Transporting::MG const &	a_settings,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		bool	a_final ) const

Returns the multi-group, total Q for the requested label. This is a cross section weighted Q.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_settings	[in] Specifies the requested label.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_final	[in] If false, only the Q for the primary reactions are return, otherwise, the Q for the final reactions.
a_reactionsToExclude	[in] A list of reaction indices that are to be ignored when calculating the Q.

Returns

The requested multi-group Q as a GIDI::Vector.

Definition at line 373 of file GIDI_reaction.cc.

                                                                                     {
 
    if( m_decayPositronium ) return( Vector { 0 } );          // Special case, returns Q with all 0.0s.
 
    return( m_outputChannel->multiGroupQ( a_smr, a_settings, a_temperatureInfo, a_final ) );
}

Referenced by GIDI::ProtareSingle::multiGroupQ().

nuclearPlusInterferencePresent()

bool GIDI::Reaction::nuclearPlusInterferencePresent ( ) const

inline

Returns the value of m_nuclearPlusInterferencePresent member.

Definition at line 4294 of file GIDI.hpp.

onlyRutherfordScatteringPresent()

bool GIDI::Reaction::onlyRutherfordScatteringPresent ( ) const

inline

Returns the value of m_onlyRutherfordScatteringPresent member.

Definition at line 4292 of file GIDI.hpp.

outputChannel()

OutputChannel * GIDI::Reaction::outputChannel ( ) const

inline

Returns a reference to the m_outputChannel member.

Definition at line 4307 of file GIDI.hpp.

Referenced by GIDI::ProtareSingle::isDelayedFissionNeutronComplete().

productIDs()

void GIDI::Reaction::productIDs	(	std::set< std::string > &	a_ids,
		Transporting::Particles const &	a_particles,
		bool	a_transportablesOnly ) const

Fills in a std::set with a unique list of all product indices produced by this reaction. If a_transportablesOnly is true, only transportable product indices are return.

Parameters

a_ids	[out] The unique list of product indices.
a_particles	[in] The list of particles to be transported.
a_transportablesOnly	[in] If true, only transportable product indices are added in the list.

Definition at line 180 of file GIDI_reaction.cc.

                                                                                                                               {
 
    if( m_decayPositronium ) {
        std::string electronAnti( PoPI::IDs::electron + PoPI::IDs::anti );
        std::set<std::string> ids;
        m_outputChannel->productIDs( ids, a_particles, a_transportablesOnly );
        for( auto iterId = ids.begin( ); iterId != ids.end( ); ++iterId ) {
            if( ( *iterId == PoPI::IDs::electron ) || ( *iterId == electronAnti ) ) continue;
            a_ids.insert( *iterId );
        }
        a_ids.insert( PoPI::IDs::photon ); }
    else {
        m_outputChannel->productIDs( a_ids, a_particles, a_transportablesOnly );
    }
}

Referenced by GIDI::ProtareSingle::productIDs().

productMultiplicity()

int GIDI::Reaction::productMultiplicity ( std::string const & a_productID ) const

inline

Returns the product multiplicity (e.g., 0, 1, 2, ...) or -1 if energy dependent or not an integer.

Definition at line 4318 of file GIDI.hpp.

reactionIndex()

std::size_t GIDI::Reaction::reactionIndex ( ) const

inline

Returns the value of the m_reactionIndex member.

Definition at line 4282 of file GIDI.hpp.

recalculateMultiGroupData()

void GIDI::Reaction::recalculateMultiGroupData	(	ProtareSingle const *	a_protare,
		Styles::TemperatureInfo const &	a_temperatureInfo )

This function recalculates the multi-group data for data labelled with a_temperatureInfo.heatedMultiGroup().

Parameters

a_temperatureInfo

[in] The temperature for which multi-group data are to be recalculated.

Definition at line 831 of file GIDI_reaction.cc.

                                                                                                                         {
 
    std::string heatedMultiGroupLabel = a_temperatureInfo.heatedMultiGroup( );
 
    GUPI::Ancestry const *ancestorRoot = root( );
    if( ancestorRoot->moniker( ) != GIDI_topLevelChars ) throw Exception( "Reaction::recalculateMultiGroupData: could not find parent protare." );
 
    Styles::Suite const &styles = a_protare->styles( );
    if( styles.find( heatedMultiGroupLabel ) == styles.end( ) ) return;
 
    Styles::HeatedMultiGroup const &heatedMultiGroupStyle = *styles.get<Styles::HeatedMultiGroup const>( heatedMultiGroupLabel );
 
    std::vector<double> groupBoundaries = heatedMultiGroupStyle.groupBoundaries( a_protare->projectile( ).ID( ) );
    Transporting::MultiGroup multiGroup = Transporting::MultiGroup( "recal", groupBoundaries );
 
    Transporting::Flux flux( "recal", a_temperatureInfo.temperature( ).value( ) );
    double energies[2] = { groupBoundaries[0], groupBoundaries.back( ) };
    double fluxValues[2] = { 1.0, 1.0 };
    Transporting::Flux_order flux_order( 0, 2, energies, fluxValues );
    flux.addFluxOrder( flux_order );
 
    MultiGroupCalulationInformation multiGroupCalulationInformation( multiGroup, flux );
    calculateMultiGroupData( a_protare, a_temperatureInfo, heatedMultiGroupLabel, multiGroupCalulationInformation );
}

Referenced by modifyCrossSection().

RutherfordScatteringPresent()

bool GIDI::Reaction::RutherfordScatteringPresent ( ) const

inline

Returns the value of m_RutherfordScatteringPresent member.

Definition at line 4290 of file GIDI.hpp.

Referenced by GIDI::ProtareSingle::checkIf_nuclearPlusCoulombInterferenceWanted().

setActive()

void GIDI::Reaction::setActive ( bool a_active )

inline

Sets m_active to a_active.

Definition at line 4281 of file GIDI.hpp.

setOutputChannel()

void GIDI::Reaction::setOutputChannel

(

OutputChannel *

a_outputChannel

)

Sets this reaction's output channel to a_outputChannel.

Parameters

a_outputChannel

[in] The output channel to make this reaction output channel.

Definition at line 263 of file GIDI_reaction.cc.

                                                                {
 
    m_outputChannel = a_outputChannel;
    m_outputChannel->setAncestor( this );
}

threshold()

double GIDI::Reaction::threshold ( ) const

inline

Returns the value of the m_QThreshold member.

Definition at line 4323 of file GIDI.hpp.

toXMLList()

void GIDI::Reaction::toXMLList ( GUPI::WriteInfo & a_writeInfo, std::string const & a_indent = "" ) const

virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters

a_writeInfo	[in/out] Instance containing incremental indentation and other information and stores the appended lines.
a_indent	[in] The amount to indent this node.

Reimplemented from GUPI::Ancestry.

Definition at line 894 of file GIDI_reaction.cc.

                                                                                      {
    
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    attributes += a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
    attributes += a_writeInfo.addAttribute( GIDI_ENDF_MT_Chars, intToString( ENDF_MT( ) ) );
    if( m_fissionGenre != "" ) attributes += a_writeInfo.addAttribute( GIDI_fissionGenreChars, m_fissionGenre );
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
 
    m_doubleDifferentialCrossSection.toXMLList( a_writeInfo, indent2 );    
    m_crossSection.toXMLList( a_writeInfo, indent2 );    
    if( m_outputChannel != nullptr ) m_outputChannel->toXMLList( a_writeInfo, indent2 );
    m_availableEnergy.toXMLList( a_writeInfo, indent2 );
    m_availableMomentum.toXMLList( a_writeInfo, indent2 );
 
    a_writeInfo.addNodeEnder( moniker( ) );
}

twoBodyThreshold()

double GIDI::Reaction::twoBodyThreshold ( ) const

inline

Returns the value of the m_twoBodyThreshold member.

Definition at line 4325 of file GIDI.hpp.

xlinkItemKey()

std::string GIDI::Reaction::xlinkItemKey ( ) const

inlinevirtual

Returns the result of calling "GUPI::Ancestry::buildXLinkItemKey( GIDI_labelChars, label() )".

Reimplemented from GIDI::Form.

Definition at line 4314 of file GIDI.hpp.

Friends And Related Symbol Documentation

ProtareSingle

friend class ProtareSingle

friend

Definition at line 4247 of file GIDI.hpp.

Referenced by calculateMultiGroupData(), modifyCrossSection(), ProtareSingle, and recalculateMultiGroupData().

---

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

• GIDI.hpp
• GIDI_reaction.cc