#include <GIDI.hpp>

Inheritance diagram for GIDI::Product:

Public Member Functions
	Product (PoPI::Database const &a_pops, std::string const &a_productID, std::string const &a_label)
	Product (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, Suite a_parent, Styles::Suite const a_styles)
	~Product ()
ParticleInfo const &	particle () const
void	setParticle (ParticleInfo const &a_particle)
std::string	pid () const
ParticleInfo const &	GNDS_particle () const
ParticleInfo &	GNDS_particle ()
int	depth () const
Component &	multiplicity ()
Component const &	multiplicity () const
Component &	distribution ()
Component const &	distribution () const
Component &	averageEnergy ()
Component const &	averageEnergy () const
Component &	averageMomentum ()
Component const &	averageMomentum () const
OutputChannel *	outputChannel () const
void	modifiedMultiGroupElasticForTNSL (std::map< std::string, std::size_t > const &a_maximumTNSL_MultiGroupIndex)
bool	hasFission () const
bool	isDelayedFissionNeutronComplete (bool a_isDelayedNeutron) const
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
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	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	isCompleteParticle () const
void	incompleteParticles (Transporting::Settings const &a_settings, std::set< std::string > &a_incompleteParticles) 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 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
std::string	xlinkItemKey () 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

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

Class to store a GNDS <product> node.

Definition at line 3871 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Product() [1/2]

GIDI::Product::Product	(	PoPI::Database const &	a_pops,
		std::string const &	a_productID,
		std::string const &	a_label )

Constructed

Definition at line 24 of file GIDI_product.cc.

                                                                                                     :
        Form( FormType::product ),
        m_particle( ParticleInfo( a_productID, a_pops, a_pops, true ) ),
        m_GNDS_particle( ParticleInfo( a_productID, a_pops, a_pops, true ) ),
        m_productMultiplicity( 0 ),
        m_treatProductAsIfInfinityMass( false ),
        m_multiplicity( GIDI_multiplicityChars, GIDI_labelChars ),
        m_distribution( GIDI_distributionChars, GIDI_labelChars ),
        m_averageEnergy( GIDI_averageEnergyChars, GIDI_labelChars ),
        m_averageMomentum( GIDI_averageMomentumChars, GIDI_labelChars ),
        m_outputChannel( nullptr ) {
 
    setMoniker( GIDI_productChars );
    setLabel( a_label );
 
    m_multiplicity.setAncestor( this );
    m_distribution.setAncestor( this );
    m_averageEnergy.setAncestor( this );
    m_averageMomentum.setAncestor( this );
}

◆ Product() [2/2]

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

Constructed from data in a <product> node.

Parameters

a_construction	[in] Used to pass user options to the constructor.
a_node	[in] The HAPI::Node to be parsed and used to construct the Product.
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_parent	[in] The m_products member of GIDI::OutputChannel this product belongs to.
a_styles	[in] The <styles> node under the <reactionSuite> node.

Definition at line 58 of file GIDI_product.cc.

                                                                                                   :
        Form( a_node, a_setupInfo, FormType::product, a_parent ),
        m_particle( a_node.attribute_as_string( GIDI_pidChars ), a_pops, a_internalPoPs, false ),
        m_GNDS_particle( a_node.attribute_as_string( GIDI_pidChars ), a_pops, a_internalPoPs, false ),
        m_productMultiplicity( 0 ),
        m_treatProductAsIfInfinityMass( false ),
        m_multiplicity( a_construction, GIDI_multiplicityChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseMultiplicitySuite, a_styles ),
        m_distribution( a_construction, GIDI_distributionChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseDistributionSuite, a_styles ),
        m_averageEnergy( a_construction, GIDI_averageEnergyChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseAverageEnergySuite, a_styles ),
        m_averageMomentum( a_construction, GIDI_averageMomentumChars, GIDI_labelChars, a_node, a_setupInfo, a_pops, a_internalPoPs, parseAverageMomentumSuite, a_styles ),
        m_outputChannel( nullptr ) {
 
    if( a_setupInfo.m_outputChannelLevel == 0 ) a_setupInfo.m_initialState = m_particle.ID( );
    m_multiplicity.setAncestor( this );
    m_distribution.setAncestor( this );
    m_averageEnergy.setAncestor( this );
    m_averageMomentum.setAncestor( this );
 
    auto iter = a_setupInfo.m_particleSubstitution->find( m_GNDS_particle.ID( ) );
    if( iter != a_setupInfo.m_particleSubstitution->end( ) ) m_particle = iter->second;
 
    if( a_setupInfo.m_protare->projectile( ).ID( ) == PoPI::IDs::photon ) {
        if( m_particle.ID( ) == a_setupInfo.m_protare->GNDS_target( ).ID( ) ) m_particle = a_setupInfo.m_protare->target( );
    }
 
    if( a_setupInfo.m_protare->isPhotoAtomic( ) || a_setupInfo.m_protare->isTNSL_ProtareSingle( ) ) {
        m_treatProductAsIfInfinityMass = m_GNDS_particle.ID( ) == a_setupInfo.m_protare->GNDS_target( ).ID( );
    }
 
    HAPI::Node const _outputChannel = a_node.child( GIDI_outputChannelChars );
    a_setupInfo.m_outputChannelLevel += 1;
    if( ! _outputChannel.empty( ) ) 
        m_outputChannel = new OutputChannel( a_construction, _outputChannel, a_setupInfo, a_pops, a_internalPoPs, a_styles, false, false );
    a_setupInfo.m_outputChannelLevel -= 1;
 
    if( m_outputChannel == nullptr ) {
        if( m_multiplicity.size( ) > 0 ) {
            GIDI::Functions::Function1dForm const *function1d = m_multiplicity.get<GIDI::Functions::Function1dForm>( 0 );
 
            if( function1d->type( ) == FormType::constant1d ) {
                m_productMultiplicity = static_cast<int>( function1d->evaluate( 0.0 ) ); }
            else if( function1d->type( ) != FormType::unspecified1d ) {
                m_productMultiplicity = -1;
            }
        } }
    else {
        m_outputChannel->setAncestor( this );
    }
}

◆ ~Product()

GIDI::Product::~Product ( )

Definition at line 112 of file GIDI_product.cc.

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

Member Function Documentation

◆ areAllProductsTracked()

bool GIDI::Product::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 185 of file GIDI_product.cc.

                                                                                    {
 
    if( m_outputChannel != nullptr ) return( m_outputChannel->areAllProductsTracked( a_particles ) );
 
    return( a_particles.hasParticle( m_particle.ID( ) ) );
}

◆ averageEnergy() [1/2]

Component & GIDI::Product::averageEnergy ( )

inline

Returns a reference to the m_averageEnergy member.

Definition at line 3902 of file GIDI.hpp.

Referenced by continuousEnergyProductData(), and mapContinuousEnergyProductData().

◆ averageEnergy() [2/2]

Component const & GIDI::Product::averageEnergy ( ) const

inline

Returns a const reference to the m_averageEnergy member.

Definition at line 3903 of file GIDI.hpp.

◆ averageMomentum() [1/2]

Component & GIDI::Product::averageMomentum ( )

inline

Returns a reference to the m_averageMomentum member.

Definition at line 3904 of file GIDI.hpp.

Referenced by continuousEnergyProductData(), and mapContinuousEnergyProductData().

◆ averageMomentum() [2/2]

Component const & GIDI::Product::averageMomentum ( ) const

inline

Returns a const reference to the m_averageMomentum member.

Definition at line 3905 of file GIDI.hpp.

◆ calculateMultiGroupData()

void GIDI::Product::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 552 of file GIDI_product.cc.

                                                            {
 
// FIXME, need to calculateMultiGroupData for the distribution.
 
    if( isCompleteParticle( ) ) {
        if( m_multiplicity.find( a_heatedMultiGroupLabel ) != m_multiplicity.end( ) ) {
            calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_multiplicity, a_crossSectionXYs1d );
            calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_averageEnergy, a_crossSectionXYs1d );
            calculate1dMultiGroupDataInComponent( a_protare, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, m_averageMomentum, a_crossSectionXYs1d );
        }
    }
 
    if( m_outputChannel != nullptr ) 
        m_outputChannel->calculateMultiGroupData( a_protare, a_temperatureInfo, a_heatedMultiGroupLabel, a_multiGroupCalulationInformation, a_crossSectionXYs1d );
}

Referenced by GIDI::OutputChannel::calculateMultiGroupData().

◆ continuousEnergyProductData()

void GIDI::Product::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 458 of file GIDI_product.cc.

                                                                                                                                    {
 
    if( m_outputChannel == nullptr ) {
        if( a_particleID == m_particle.ID( ) ) {
            if( !isCompleteParticle( ) ) {
                if( a_ignoreIncompleteParticles ) return;
                throw Exception( "GIDI::Product::continuousEnergyProductData: particle is incomplete: " + toXLink( ) + "." );
            }
            a_productEnergy += averageEnergy( ).get<GIDI::Functions::Function1dForm>( 0 )->evaluate( a_energy );
            a_productMomentum += averageMomentum( ).get<GIDI::Functions::Function1dForm>( 0 )->evaluate( a_energy );
            a_productGain += multiplicity( ).get<GIDI::Functions::Function1dForm>( 0 )->evaluate( a_energy ); } }
    else {
        m_outputChannel->continuousEnergyProductData( a_settings, a_particleID, a_energy, a_productEnergy, a_productMomentum, a_productGain, a_ignoreIncompleteParticles );
    }
}

Referenced by GIDI::OutputChannel::continuousEnergyProductData().

◆ depth()

int GIDI::Product::depth ( ) const

Returns the maximum product depth for this product.

Returns: The maximum product depth.

Definition at line 123 of file GIDI_product.cc.

                          {
 
    if( m_outputChannel == nullptr ) return( 0 );
    return( m_outputChannel->depth( ) );
}

Referenced by GIDI::OutputChannel::depth().

◆ distribution() [1/2]

Component & GIDI::Product::distribution ( )

inline

Returns a reference to the m_distribution member.

Definition at line 3900 of file GIDI.hpp.

Referenced by MCGIDI::Product::Product().

◆ distribution() [2/2]

Component const & GIDI::Product::distribution ( ) const

inline

Returns a reference to the m_distribution member.

Definition at line 3901 of file GIDI.hpp.

◆ findInAncestry3() [1/2]

GUPI::Ancestry * GIDI::Product::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 199 of file GIDI_product.cc.

                                                                {
 
    if( a_item == GIDI_multiplicityChars ) return( &m_multiplicity );
    if( a_item == GIDI_distributionChars ) return( &m_distribution );
    if( a_item == GIDI_averageEnergyChars ) return( &m_averageEnergy );
    if( a_item == GIDI_averageMomentumChars ) return( &m_averageMomentum );
    if( a_item == GIDI_outputChannelChars ) return( m_outputChannel );
 
    return( nullptr );
}

◆ findInAncestry3() [2/2]

GUPI::Ancestry const * GIDI::Product::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 217 of file GIDI_product.cc.

                                                                            {
 
    if( a_item == GIDI_multiplicityChars ) return( &m_multiplicity );
    if( a_item == GIDI_distributionChars ) return( &m_distribution );
    if( a_item == GIDI_averageEnergyChars ) return( &m_averageEnergy );
    if( a_item == GIDI_averageMomentumChars ) return( &m_averageMomentum );
    if( a_item == GIDI_outputChannelChars ) return( m_outputChannel );
 
    return( nullptr );
}

◆ GNDS_particle() [1/2]

ParticleInfo & GIDI::Product::GNDS_particle ( )

inline

Returns the value of the m_GNDS_particle member.

Definition at line 3895 of file GIDI.hpp.

◆ GNDS_particle() [2/2]

ParticleInfo const & GIDI::Product::GNDS_particle ( ) const

inline

Returns a const reference to the m_GNDS_particle member.

Definition at line 3894 of file GIDI.hpp.

◆ hasFission()

bool GIDI::Product::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 151 of file GIDI_product.cc.

                                {
 
    if( m_outputChannel != nullptr ) return( m_outputChannel->hasFission( ) );
    return( false );
}

◆ incompleteParticles()

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

If the product has a distribution and its first distribution form is not unspecified, its PoPs id is added to a_incompleteParticles.

Returns: Returns true if the product has distribution data and false otherwise.

Definition at line 534 of file GIDI_product.cc.

                                                                                                                          {
 
    if( m_outputChannel == nullptr ) {
        if( !isCompleteParticle( ) ) a_incompleteParticles.insert( particle( ).ID( ) ); }
    else {
        m_outputChannel->incompleteParticles( a_settings, a_incompleteParticles );
    }
}

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

◆ isCompleteParticle()

bool GIDI::Product::isCompleteParticle ( ) const

Returns true if the product is complete and false otherwise. A product is complete if its multiplicity and/or distribution are other than unspecified.

Returns: true if the product is complete and false otherwise.

Definition at line 518 of file GIDI_product.cc.

                                        {
 
    if( m_multiplicity.size( ) == 0 ) return( false );
    if( m_multiplicity.get<Form>( 0 )->type( ) == FormType::unspecified ) return( false );
    if( m_distribution.size( ) == 0 ) return( false );
    if( m_distribution.get<Form>( 0 )->type( ) == FormType::unspecified ) return( false );
 
    return( true );
}

Referenced by calculateMultiGroupData(), continuousEnergyProductData(), incompleteParticles(), isDelayedFissionNeutronComplete(), and mapContinuousEnergyProductData().

◆ isDelayedFissionNeutronComplete()

bool GIDI::Product::isDelayedFissionNeutronComplete ( bool a_isDelayedNeutron ) const

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

Parameters

a_isDelayedNeutron [in] true is called from FissionFragmentData::isDelayedFissionNeutronComplete and false otherwise.

Returns: bool

Definition at line 165 of file GIDI_product.cc.

                                                                             {
 
    if( a_isDelayedNeutron ) {
        return( isCompleteParticle( ) ); }
    else {
        if( m_outputChannel != nullptr ) return( m_outputChannel->isDelayedFissionNeutronComplete( ) );
    }
 
    return( true );
}

◆ mapContinuousEnergyProductData()

void GIDI::Product::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 488 of file GIDI_product.cc.

                                                                                            {
 
    if( m_outputChannel == nullptr ) {
        if( a_particleID == m_particle.ID( ) ) {
            if( !isCompleteParticle( ) ) {
                if( a_ignoreIncompleteParticles ) return;
                throw Exception( "GIDI::Product::mapContinuousEnergyProductData: particle is incomplete: " + toXLink( ) + "." );
            }
            GIDI::Functions::Function1dForm const *multiplicity1 = multiplicity( ).get<GIDI::Functions::Function1dForm>( 0 );
            if( multiplicity1->type( ) == FormType::branching1d ) return;
 
            averageEnergy( ).get<GIDI::Functions::Function1dForm>( 0 )->mapToXsAndAdd( a_offset, a_energies, a_productEnergies, -1.0 );
            averageMomentum( ).get<GIDI::Functions::Function1dForm>( 0 )->mapToXsAndAdd( a_offset, a_energies, a_productMomenta, -1.0 );
            multiplicity1->mapToXsAndAdd( a_offset, a_energies, a_productGains, 1.0 );
        } }
    else {
        m_outputChannel->mapContinuousEnergyProductData( a_settings, a_particleID, a_energies, a_offset, a_productEnergies, a_productMomenta, 
                a_productGains, a_ignoreIncompleteParticles );
    }
}

Referenced by GIDI::OutputChannel::mapContinuousEnergyProductData().

◆ maximumLegendreOrder()

int GIDI::Product::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 this product and any sub-products for a give label.

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 maximum Legredre order. If no transfer matrix data are present for the requested product, -1 is returned.

Definition at line 274 of file GIDI_product.cc.

                                                                                                     {
 
    int _maximumLegendreOrder = -1;
 
    if( m_outputChannel == nullptr ) {
        if( PoPI::compareSpecialParticleIDs( m_particle.ID( ), a_productID ) ) {
            Distributions::MultiGroup3d const *form = dynamic_cast<Distributions::MultiGroup3d const*>( a_settings.form( 
                    a_smr, m_distribution, a_temperatureInfo, "distribution for maximumLegendreOrder" ) );
            if( form != nullptr ) {
                Functions::Gridded3d const &gdata = form->data( );
                Array3d const &data = gdata.data( );
                _maximumLegendreOrder = static_cast<int>( data.size( ) ) - 1;
            }
        } }
    else {
        int __maximumLegendreOrder = m_outputChannel->maximumLegendreOrder( a_smr, a_settings, a_temperatureInfo, a_productID );
        if( __maximumLegendreOrder > _maximumLegendreOrder ) _maximumLegendreOrder = __maximumLegendreOrder;
    }
 
    return( _maximumLegendreOrder );
}

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

◆ modifiedMultiGroupElasticForTNSL()

void GIDI::Product::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 ProtareSingle that contains the TNSL data covers the lower energy multi-group data.

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 137 of file GIDI_product.cc.

                                                                                                                 {
 
    m_multiplicity.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_distribution.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_averageEnergy.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
    m_averageMomentum.modifiedMultiGroupElasticForTNSL( a_maximumTNSL_MultiGroupIndex );
}

Referenced by GIDI::OutputChannel::modifiedMultiGroupElasticForTNSL().

◆ multiGroupAverageEnergy()

Vector GIDI::Product::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 summed over this and all sub-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_productID	[in] Particle id for the requested product.

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

Definition at line 399 of file GIDI_product.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    if( m_outputChannel == nullptr ) {
        if( ( PoPI::compareSpecialParticleIDs( m_particle.ID( ), a_productID ) ) && ( !m_treatProductAsIfInfinityMass ) ) {
            Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( 
                    a_smr, m_averageEnergy, a_temperatureInfo, "average product energy" ) );
            if( form != nullptr ) vector += form->data( );
        } }
    else {
        vector += m_outputChannel->multiGroupAverageEnergy( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    return( vector );
}

◆ multiGroupAverageMomentum()

Vector GIDI::Product::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 summed over this and all sub-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_productID	[in] Particle id for the requested product.

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

Definition at line 429 of file GIDI_product.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    if( m_outputChannel == nullptr ) {
        if( ( PoPI::compareSpecialParticleIDs( m_particle.ID( ), a_productID ) ) && ( !m_treatProductAsIfInfinityMass ) ) {
            Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( 
                    a_smr, m_averageMomentum, a_temperatureInfo, "average product momentum" ) );
            if( form != nullptr ) vector += form->data( );
        } }
    else {
        vector += m_outputChannel->multiGroupAverageMomentum( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
    return( vector );
}

◆ multiGroupMultiplicity()

Vector GIDI::Product::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 this product and any sub-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 309 of file GIDI_product.cc.

                                                                                                     {
 
    Vector vector( 0 );
 
    if( m_outputChannel == nullptr ) {
        if( ( PoPI::compareSpecialParticleIDs( m_particle.ID( ), a_productID ) ) && ( !m_treatProductAsIfInfinityMass ) ) {
            Functions::Gridded1d const *form = dynamic_cast<Functions::Gridded1d const*>( a_settings.form( 
                    a_smr, m_multiplicity, a_temperatureInfo, "multiplicity" ) );
            if( form != nullptr ) vector += form->data( );
        } }
    else {
        vector += m_outputChannel->multiGroupMultiplicity( a_smr, a_settings, a_temperatureInfo, a_productID );
    }
 
    return( vector );
}

◆ multiGroupProductMatrix()

Matrix GIDI::Product::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 364 of file GIDI_product.cc.

                                          {
 
    Matrix matrix( 0, 0 );
 
    if( m_outputChannel == nullptr ) {
        if( ( PoPI::compareSpecialParticleIDs( m_particle.ID( ), a_productID ) ) && ( !m_treatProductAsIfInfinityMass ) ) {
            Distributions::MultiGroup3d const *form = dynamic_cast<Distributions::MultiGroup3d const*>( a_settings.form( 
                    a_smr, m_distribution, a_temperatureInfo, "distribution for product matrix" ) );
            if( form != nullptr ) {
                Functions::Gridded3d const &gdata = form->data( );
                Array3d const &data = gdata.data( );
                matrix = data.matrix( a_order );
            }
        } }
    else {
        matrix += m_outputChannel->multiGroupProductMatrix( a_smr, a_settings, a_temperatureInfo, a_particles, a_productID, a_order );
    }
 
    return( matrix );
}

◆ multiGroupQ()

Vector GIDI::Product::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 product and any sub-product . This is a cross section weighted Q. If a_final is false, only the Q for the products output channel is returned, 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 340 of file GIDI_product.cc.

                                                                                     {
    
    Vector _vector( 0 );
 
    if( m_outputChannel != nullptr ) _vector += m_outputChannel->multiGroupQ( a_smr, a_settings, a_temperatureInfo, a_final );
 
    return( _vector );
}

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

◆ multiplicity() [1/2]

Component & GIDI::Product::multiplicity ( )

inline

Returns a reference to the m_multiplicity member.

Definition at line 3898 of file GIDI.hpp.

Referenced by continuousEnergyProductData(), and mapContinuousEnergyProductData().

◆ multiplicity() [2/2]

Component const & GIDI::Product::multiplicity ( ) const

inline

Returns a const reference to the m_multiplicity member.

Definition at line 3899 of file GIDI.hpp.

◆ outputChannel()

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

inline

Returns a reference to the m_outputChannel member.

Definition at line 3906 of file GIDI.hpp.

Referenced by MCGIDI::Product::Product().

◆ particle()

ParticleInfo const & GIDI::Product::particle ( ) const

inline

Returns the value of the m_particle member.

Definition at line 3891 of file GIDI.hpp.

Referenced by incompleteParticles().

◆ pid()

std::string GIDI::Product::pid ( ) const

inline

Definition at line 3893 of file GIDI.hpp.

3893{ return( m_particle.ID( ) ); }

◆ productIDs()

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

Insert a std::set with the products index 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 237 of file GIDI_product.cc.

                                                                                                                                  {
 
    if( m_outputChannel == nullptr ) {
        if( a_transportablesOnly && !a_particles.hasParticle( m_particle.ID( ) ) ) return;
        if( m_particle.ID( ) != "" ) a_indices.insert( m_particle.ID( ) ); }
    else {
        m_outputChannel->productIDs( a_indices, a_particles, a_transportablesOnly );
    }
}

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

◆ productMultiplicity()

int GIDI::Product::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 255 of file GIDI_product.cc.

                                                                     {
 
    if( m_outputChannel != nullptr ) return( m_outputChannel->productMultiplicity( a_productID ) );
 
    if( PoPI::compareSpecialParticleIDs( a_productID, m_particle.ID( ) ) ) return( m_productMultiplicity );
    return( 0 );
}

Referenced by GIDI::OutputChannel::productMultiplicity().

◆ setParticle()

void GIDI::Product::setParticle ( ParticleInfo const & a_particle )

inline

Sets m_particle to a_particle.

Definition at line 3892 of file GIDI.hpp.

◆ toXMLList()

void GIDI::Product::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 577 of file GIDI_product.cc.

                                                                                     {
 
    std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
    std::string attributes;
 
    attributes += a_writeInfo.addAttribute( GIDI_pidChars, m_GNDS_particle.ID( ) );
    if( label( ) != "" ) attributes += a_writeInfo.addAttribute( GIDI_labelChars, label( ) );
    a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
 
    m_multiplicity.toXMLList( a_writeInfo, indent2 );
    m_distribution.toXMLList( a_writeInfo, indent2 );
    m_averageEnergy.toXMLList( a_writeInfo, indent2 );
    m_averageMomentum.toXMLList( a_writeInfo, indent2 );
    if( m_outputChannel != nullptr ) m_outputChannel->toXMLList( a_writeInfo, indent2 );
 
    a_writeInfo.addNodeEnder(  moniker( ) );
}

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Product() [1/2]

◆ Product() [2/2]

◆ ~Product()

Member Function Documentation

◆ areAllProductsTracked()

◆ averageEnergy() [1/2]

◆ averageEnergy() [2/2]

◆ averageMomentum() [1/2]

◆ averageMomentum() [2/2]

◆ calculateMultiGroupData()

◆ continuousEnergyProductData()

◆ depth()

◆ distribution() [1/2]

◆ distribution() [2/2]

◆ findInAncestry3() [1/2]

◆ findInAncestry3() [2/2]

◆ GNDS_particle() [1/2]

◆ GNDS_particle() [2/2]

◆ hasFission()

◆ incompleteParticles()

◆ isCompleteParticle()

◆ isDelayedFissionNeutronComplete()

◆ mapContinuousEnergyProductData()

◆ maximumLegendreOrder()

◆ modifiedMultiGroupElasticForTNSL()

◆ multiGroupAverageEnergy()

◆ multiGroupAverageMomentum()

◆ multiGroupMultiplicity()

◆ multiGroupProductMatrix()

◆ multiGroupQ()

◆ multiplicity() [1/2]

◆ multiplicity() [2/2]

◆ outputChannel()

◆ particle()

◆ pid()

◆ productIDs()

◆ productMultiplicity()

◆ setParticle()

◆ toXMLList()