#include <GIDI.hpp>

Inheritance diagram for GIDI::OutputChannel:

Public Member Functions
	OutputChannel (bool a_twoBody, bool a_fissions, std::string const &a_process)
	OutputChannel (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, Styles::Suite const *a_styles, bool a_isFission, bool a_addFissionResiduals)
	~OutputChannel ()
bool	twoBody () const
std::string	process () const
int	depth () const
Component &	Q ()
Component const &	Q () const
Suite &	products ()
Suite const &	products () const
FissionFragmentData &	fissionFragmentData ()
FissionFragmentData const &	fissionFragmentData () const
Construction::FissionResiduals	fissionResiduals () const
void	modifiedMultiGroupElasticForTNSL (std::map< std::string, std::size_t > const &a_maximumTNSL_MultiGroupIndex)
bool	areAllProductsTracked (Transporting::Particles const &a_particles) const
GUPI::Ancestry *	findInAncestry3 (std::string const &a_item)
GUPI::Ancestry const *	findInAncestry3 (std::string const &a_item) const
bool	isFission () const
bool	hasFission () const
bool	isDelayedFissionNeutronComplete () 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
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
Vector	multiGroupAverageEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const
Vector	multiGroupAverageMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) 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
void	calculateMultiGroupData (ProtareSingle const *a_protare, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_heatedMultiGroupLabel, MultiGroupCalulationInformation const &a_multiGroupCalulationInformation, Functions::XYs1d const &a_crossSectionXYs1d)
void	toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") 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)
virtual std::string	xlinkItemKey () const
std::string	toXLink () const
void	printXML () const

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

This class represents a GNDS outputChannel.

Definition at line 4093 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ OutputChannel() [1/2]

GIDI::OutputChannel::OutputChannel	(	bool	a_twoBody,
		bool	a_fissions,
		std::string const &	a_process )

Definition at line 19 of file GIDI_outputChannel.cc.

                                                                                          :
        GUPI::Ancestry( GIDI_outputChannelChars ),
        m_twoBody( a_twoBody ),
        m_fissions( a_fissions ),
        m_process( a_process ),
        m_Q( GIDI_QChars, GIDI_labelChars ),
        m_products( GIDI_productsChars, GIDI_labelChars ),
        m_fissionFragmentData( ),
        m_fissionResiduals( Construction::FissionResiduals::none ) {
 
    m_Q.setAncestor( this );
    m_products.setAncestor( this );
    m_fissionFragmentData.setAncestor( this );
}

◆ OutputChannel() [2/2]

GIDI::OutputChannel::OutputChannel	(	Construction::Settings const &	a_construction,
		HAPI::Node const &	a_node,
		SetupInfo &	a_setupInfo,
		PoPI::Database const &	a_pops,
		PoPI::Database const &	a_internalPoPs,
		Styles::Suite const *	a_styles,
		bool	a_isFission,
		bool	a_addFissionResiduals )

◆ ~OutputChannel()

GIDI::OutputChannel::~OutputChannel ( )

Definition at line 68 of file GIDI_outputChannel.cc.

                               {
 
}

Member Function Documentation

◆ areAllProductsTracked()

bool GIDI::OutputChannel::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 101 of file GIDI_outputChannel.cc.

                                                                                          {
// Does not check m_fissionFragmentData as its will only have neutrons which should already be in m_products at least for now.
 
    if( isFission( ) ) return( false );
 
    for( auto iter = m_products.begin( ); iter != m_products.end( ); ++iter ) {
        Product *product = static_cast<Product *>( *iter );
 
        if( !product->areAllProductsTracked( a_particles ) ) return( false );
    }
 
    return( true );
}

◆ calculateMultiGroupData()

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

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 527 of file GIDI_outputChannel.cc.

                                                            {
 
    calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_Q, a_crossSectionXYs1d );
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product &product = *m_products.get<Product>( index );
 
        product.calculateMultiGroupData( a_protare, a_temperatureInfo, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, a_crossSectionXYs1d );
    }
 
    m_fissionFragmentData.calculateMultiGroupData( a_protare, a_temperatureInfo, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, a_crossSectionXYs1d );
}

◆ continuousEnergyProductData()

void GIDI::OutputChannel::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 477 of file GIDI_outputChannel.cc.

                                                                                                                                    {
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        product.continuousEnergyProductData( a_settings, a_particleID, a_energy, a_productEnergy, a_productMomentum, a_productGain, a_ignoreIncompleteParticles );
    }
 
    m_fissionFragmentData.continuousEnergyProductData( a_settings, a_particleID, a_energy, a_productEnergy, a_productMomentum, a_productGain, 
            a_ignoreIncompleteParticles );
}

◆ delayedNeutronProducts()

void GIDI::OutputChannel::delayedNeutronProducts ( DelayedNeutronProducts & a_delayedNeutronProducts ) const

inline

Definition at line 4149 of file GIDI.hpp.

4149{ m_fissionFragmentData.delayedNeutronProducts( a_delayedNeutronProducts ); }

◆ depth()

int GIDI::OutputChannel::depth ( ) const

Returns the maximum product depth for this output channel.

Returns: The maximum product depth.

Definition at line 78 of file GIDI_outputChannel.cc.

                                {
 
    int _depth = 0;
    std::size_t size = m_products.size( );
 
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        int productDepth = product.depth( );
        if( productDepth > _depth ) _depth = productDepth;
    }
    return( _depth + 1 );
}

◆ findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::OutputChannel::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 139 of file GIDI_outputChannel.cc.

                                                                      {
 
    if( a_item == GIDI_QChars ) return( &m_Q );
    if( a_item == GIDI_productsChars ) return( &m_products );
    if( a_item == GIDI_fissionFragmentDataChars ) return( &m_fissionFragmentData );
 
    return( nullptr );
}

◆ findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::OutputChannel::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 155 of file GIDI_outputChannel.cc.

                                                                                  {
 
    if( a_item == GIDI_QChars ) return( &m_Q );
    if( a_item == GIDI_productsChars ) return( &m_products );
    if( a_item == GIDI_fissionFragmentDataChars ) return( &m_fissionFragmentData );
 
    return( nullptr );
}

◆ fissionFragmentData() [1/2]

FissionFragmentData & GIDI::OutputChannel::fissionFragmentData ( )

inline

Definition at line 4119 of file GIDI.hpp.

4119{ return( m_fissionFragmentData ); }

Referenced by MCGIDI::OutputChannel::OutputChannel().

◆ fissionFragmentData() [2/2]

FissionFragmentData const & GIDI::OutputChannel::fissionFragmentData ( ) const

inline

Definition at line 4120 of file GIDI.hpp.

4120{ return( m_fissionFragmentData ); }

◆ fissionResiduals()

Construction::FissionResiduals GIDI::OutputChannel::fissionResiduals ( ) const

inline

Returns the value of the m_fissionResiduals member.

Definition at line 4122 of file GIDI.hpp.

◆ hasFission()

bool GIDI::OutputChannel::hasFission ( ) const

Returns true if the product has an output channel and its output channel hasFission returns true, and false otherwise.

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

Definition at line 170 of file GIDI_outputChannel.cc.

                                      {
 
    if( m_fissions ) return( true );
 
    std::size_t size = m_products.size( );
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        if( product.hasFission( ) ) return( true );
    }
    return( false );
}

◆ incompleteParticles()

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

Loops over the instances in m_products calling their incompleteParticles methods and calls the :incompleteParticles method for the m_fissionFragmentData member.

Parameters

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

Definition at line 454 of file GIDI_outputChannel.cc.

                                                                                                                                {
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        product.incompleteParticles( a_settings, a_incompleteParticles );
    }
 
    m_fissionFragmentData.incompleteParticles( a_settings, a_incompleteParticles );
}

◆ isDelayedFissionNeutronComplete()

bool GIDI::OutputChannel::isDelayedFissionNeutronComplete ( ) const

Returns false* if outputChannel has delayed fission neutrons and they are not complete; otherwise, returns **true.

Returns: bool

Definition at line 189 of file GIDI_outputChannel.cc.

                                                           {
 
    if( !m_fissionFragmentData.isDelayedFissionNeutronComplete( ) ) return( false );
 
    std::size_t size = m_products.size( );
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        if( !product.isDelayedFissionNeutronComplete( false ) ) return( false );
    }
 
    return( true );
}

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

◆ isFission()

bool GIDI::OutputChannel::isFission ( ) const

inline

Returns true if the output channel is a fission output channel.

Definition at line 4130 of file GIDI.hpp.

Referenced by areAllProductsTracked(), MCGIDI::OutputChannel::OutputChannel(), productIDs(), and productMultiplicity().

◆ mapContinuousEnergyProductData()

void GIDI::OutputChannel::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 503 of file GIDI_outputChannel.cc.

                                                                                            {
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        product.mapContinuousEnergyProductData( a_settings, a_particleID, a_energies, a_offset, a_productEnergies, a_productMomenta, 
                a_productGains, a_ignoreIncompleteParticles );
    }
 
    m_fissionFragmentData.mapContinuousEnergyProductData( a_settings, a_particleID, a_energies, a_offset, a_productEnergies, a_productMomenta,
                a_productGains, a_ignoreIncompleteParticles );
}

◆ maximumLegendreOrder()

int GIDI::OutputChannel::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 the specified products of this output channel.

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 279 of file GIDI_outputChannel.cc.

                                                                                                     {
 
    std::size_t size = m_products.size( );
    int _maximumLegendreOrder = -1;
 
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
        int r_maximumLegendreOrder = product.maximumLegendreOrder( a_smr, a_settings, a_temperatureInfo, a_productID );
 
        if( r_maximumLegendreOrder > _maximumLegendreOrder ) _maximumLegendreOrder = r_maximumLegendreOrder;
    }
 
    int r_maximumLegendreOrder = m_fissionFragmentData.maximumLegendreOrder( a_smr, a_settings, a_temperatureInfo, a_productID );
    if( r_maximumLegendreOrder > _maximumLegendreOrder ) _maximumLegendreOrder = r_maximumLegendreOrder;
 
    return( _maximumLegendreOrder );
}

◆ modifiedMultiGroupElasticForTNSL()

void GIDI::OutputChannel::modifiedMultiGroupElasticForTNSL ( std::map< std::string, std::size_t > const & a_maximumTNSL_MultiGroupIndex )

Only for internal use. Called by a 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 122 of file GIDI_outputChannel.cc.

                                                                                                                       {
 
        // No need to fix m_Q as it is all 0.0's for elastic scattering.
    for( auto iter = m_products.begin( ); iter != m_products.end( ); ++iter ) {
        Product *product = static_cast<Product *>( *iter );
 
        product->modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    }
}

◆ multiGroupAverageEnergy()

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

Returns the sum of the multi-group, average energy for the requested label for the requested product. This is a cross section weighted average 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.
a_productID	[in] Particle id for the requested product.

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

Definition at line 403 of file GIDI_outputChannel.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        vector += product.multiGroupAverageEnergy( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    vector += m_fissionFragmentData.multiGroupAverageEnergy( a_smr, a_settings, a_temperatureInfo, a_productID ); 
 
    return( vector );
}

◆ multiGroupAverageMomentum()

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

Returns the sum of the multi-group, 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 430 of file GIDI_outputChannel.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        vector += product.multiGroupAverageMomentum( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    vector += m_fissionFragmentData.multiGroupAverageMomentum( a_smr, a_settings, a_temperatureInfo, a_productID ); 
 
    return( vector );
}

◆ multiGroupMultiplicity()

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

Returns the sum of the multi-group multiplicity for the requested label for the request product of this output channel. 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 310 of file GIDI_outputChannel.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        vector += product.multiGroupMultiplicity( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    vector += m_fissionFragmentData.multiGroupMultiplicity( a_smr, a_settings, a_temperatureInfo, a_productID );
 
    return( vector );
}

◆ multiGroupProductMatrix()

Matrix GIDI::OutputChannel::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 375 of file GIDI_outputChannel.cc.

                                          {
 
    Matrix matrix( 0, 0 );
 
    for( std::size_t index = 0; index < m_products.size( ); ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        matrix += product.multiGroupProductMatrix( a_smr, a_settings, a_temperatureInfo, a_particles, a_productID, a_order );
    }
 
    matrix += m_fissionFragmentData.multiGroupProductMatrix( a_smr, a_settings, a_temperatureInfo, a_particles, a_productID, a_order ); 
 
    return( matrix );
}

◆ multiGroupQ()

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

Returns the sum of the multi-group, Q for the requested label for the this output channel. This is a cross section weighted Q. If a_final is false, only the Q for the output channels directly under each reaction is summed. Otherwise, the Q for all output channels summed, including output channels for each products.

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 true, the Q is calculated for all output channels, including those for products.

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

Definition at line 339 of file GIDI_outputChannel.cc.

                                                                                     {
 
    Vector vector( 0 );
 
    Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( a_smr, m_Q, a_temperatureInfo, "Q-value" ) );
 
    if( form != nullptr ) vector += form->data( );
 
    if( a_final ) {
        for( std::size_t index = 0; index < m_products.size( ); ++index ) {
            Product const &product1 = *m_products.get<Product>( index );
 
            vector += product1.multiGroupQ( a_smr, a_settings, a_temperatureInfo, a_final );
        }
    }
 
    vector += m_fissionFragmentData.multiGroupQ( a_smr, a_settings, a_temperatureInfo, a_final );
 
    return( vector );
}

◆ process()

std::string GIDI::OutputChannel::process ( ) const

inline

Returns the value of the m_process member.

Definition at line 4112 of file GIDI.hpp.

◆ productIDs()

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

Insert a std::set with the products id and any product in in its output channel. If a_transportablesOnly is true, only transportable product indices are return.

Parameters

a_indices	[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 212 of file GIDI_outputChannel.cc.

                                                                                                                                        {
 
    std::size_t size = m_products.size( );
 
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
 
        product.productIDs( a_indices, a_particles, a_transportablesOnly );
    }
 
    m_fissionFragmentData.productIDs( a_indices, a_particles, a_transportablesOnly );
 
    if( !a_transportablesOnly && isFission( ) ) {
        if(      m_fissionResiduals == Construction::FissionResiduals::ENDL99120 ) {
            a_indices.insert( PoPI::IDs::FissionProductENDL99120 ); }
        else if( m_fissionResiduals == Construction::FissionResiduals::ENDL99125 ) {
            a_indices.insert( PoPI::IDs::FissionProductENDL99125 );
        }
    }
}

◆ productMultiplicity()

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

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

Parameters

a_productID; [in] The id of the requested particle.

Returns: The multiplicity for the requested particle.

Definition at line 241 of file GIDI_outputChannel.cc.

                                                                           {
 
    int total_multiplicity = 0;
    std::size_t size = m_products.size( );
 
    if( isFission( ) ) {
        if(      ( a_productID == PoPI::IDs::FissionProductENDL99120 ) && ( m_fissionResiduals == Construction::FissionResiduals::ENDL99120 ) ) {
            return( 2 ); }
        else if( ( a_productID == PoPI::IDs::FissionProductENDL99125 ) && ( m_fissionResiduals == Construction::FissionResiduals::ENDL99125 ) ) {
            return( 2 );
        }
    }
 
    for( std::size_t index = 0; index < size; ++index ) {
        Product const &product = *m_products.get<Product>( index );
        int multiplicity = product.productMultiplicity( a_productID );
 
        if( multiplicity < 0 ) return( -1 );
        total_multiplicity += multiplicity;
    }
 
    int multiplicity = m_fissionFragmentData.productMultiplicity( a_productID );
    if( multiplicity < 0 ) return( -1 );
 
    return( total_multiplicity + multiplicity );
}

◆ products() [1/2]

Suite & GIDI::OutputChannel::products ( )

inline

Returns a reference to the m_products member.

Definition at line 4117 of file GIDI.hpp.

Referenced by MCGIDI::OutputChannel::OutputChannel().

◆ products() [2/2]

Suite const & GIDI::OutputChannel::products ( ) const

inline

Returns a reference to the m_products member.

Definition at line 4118 of file GIDI.hpp.

◆ Q() [1/2]

Component & GIDI::OutputChannel::Q ( )

inline

Returns a reference to the m_Q member.

Definition at line 4115 of file GIDI.hpp.

Referenced by MCGIDI::OutputChannel::OutputChannel().

◆ Q() [2/2]

Component const & GIDI::OutputChannel::Q ( ) const

inline

Returns a reference to the m_Q member.

Definition at line 4116 of file GIDI.hpp.

◆ toXMLList()

void GIDI::OutputChannel::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 549 of file GIDI_outputChannel.cc.

                                                                                           {
    
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    if( m_twoBody ) {
        attributes = a_writeInfo.addAttribute( GIDI_genreChars, GIDI_twoBodyChars ); }
    else {
        attributes = a_writeInfo.addAttribute( GIDI_genreChars, GIDI_NBodyChars );
    }
 
    if( m_process != "" ) attributes += a_writeInfo.addAttribute( GIDI_processChars, m_process );
 
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
 
    m_Q.toXMLList( a_writeInfo, indent2 ); 
    m_products.toXMLList( a_writeInfo, indent2 );
    m_fissionFragmentData.toXMLList( a_writeInfo, indent2 );
 
    a_writeInfo.addNodeEnder( moniker( ) );
}

◆ twoBody()

bool GIDI::OutputChannel::twoBody ( ) const

inline

Returns the value of the m_twoBody member.

Definition at line 4111 of file GIDI.hpp.

Referenced by MCGIDI::OutputChannel::OutputChannel().

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutputChannel() [1/2]

◆ OutputChannel() [2/2]

◆ ~OutputChannel()

Member Function Documentation

◆ areAllProductsTracked()

◆ calculateMultiGroupData()

◆ continuousEnergyProductData()

◆ delayedNeutronProducts()

◆ depth()

◆ findInAncestry3() [1/2]

◆ findInAncestry3() [2/2]

◆ fissionFragmentData() [1/2]

◆ fissionFragmentData() [2/2]

◆ fissionResiduals()

◆ hasFission()

◆ incompleteParticles()

◆ isDelayedFissionNeutronComplete()

◆ isFission()

◆ mapContinuousEnergyProductData()

◆ maximumLegendreOrder()

◆ modifiedMultiGroupElasticForTNSL()

◆ multiGroupAverageEnergy()

◆ multiGroupAverageMomentum()

◆ multiGroupMultiplicity()

◆ multiGroupProductMatrix()

◆ multiGroupQ()

◆ process()

◆ productIDs()

◆ productMultiplicity()

◆ products() [1/2]

◆ products() [2/2]

◆ Q() [1/2]

◆ Q() [2/2]

◆ toXMLList()

◆ twoBody()