GIDI::Transporting::MG Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Transporting::MG:

Public Member Functions
	MG (std::string const &a_projectileID, Mode a_mode, DelayedNeutrons a_delayedNeutrons)
Mode	mode () const
void	setMode (Mode a_mode)
bool	useMultiGroupSummedData () const
void	setUseMultiGroupSummedData (bool a_useMultiGroupSummedData)
Form const *	form (LUPI::StatusMessageReporting &a_smr, GIDI::Suite const &a_suite, Styles::TemperatureInfo const &a_temperatureInfo, std::string a_dataType, std::string const &a_label="") const
Public Member Functions inherited from GIDI::Transporting::Settings
	Settings (std::string const &a_projectileID, DelayedNeutrons a_delayedNeutrons)
	~Settings ()
std::string const &	projectileID () const
DelayedNeutrons	delayedNeutrons () const
void	setDelayedNeutrons (DelayedNeutrons a_delayedNeutrons)
bool	nuclearPlusCoulombInterferenceOnly () const
void	setNuclearPlusCoulombInterferenceOnly (bool a_nuclearPlusCoulombInterferenceOnly)
bool	zeroDepositionIfAllProductsTracked () const
void	setZeroDepositionIfAllProductsTracked (bool a_zeroDepositionIfAllProductsTracked)
bool	throwOnError () const
void	setThrowOnError (bool a_throwOnError)
Vector	multiGroupZeroVector (Particles const &a_particles, bool a_collapse=true) const
Matrix	multiGroupZeroMatrix (Particles const &a_particles, std::string const &a_particleID, bool a_collapse=true) const

Detailed Description

This class is used to instruct deterministic methods on what data are being requested.

Definition at line 3752 of file GIDI.hpp.

Constructor & Destructor Documentation

MG()

GIDI::Transporting::MG::MG	(	std::string const &	a_projectileID,
		Mode	a_mode,
		DelayedNeutrons	a_delayedNeutrons )

Parameters

a_projectileID	[in] The PoPs index for the projectile.
a_mode	[in] Specifies the type of data to use or retrieve for transport codes.
a_delayedNeutrons	[in] Flag indicating whether or not delayed neutron data are to be include in the requested data.

Definition at line 123 of file GIDI_settings.cc.

                                                                                        :
        Settings( a_projectileID, a_delayedNeutrons ),
        m_mode( a_mode ),
        m_useMultiGroupSummedData( true ) {
 
}

Member Function Documentation

form()

Form const * GIDI::Transporting::MG::form	(	LUPI::StatusMessageReporting &	a_smr,
		GIDI::Suite const &	a_suite,
		Styles::TemperatureInfo const &	a_temperatureInfo,
		std::string	a_dataType,
		std::string const &	a_label = "" ) const

Searches the suite a_suite for the form style specified by m_mode and matching one in a_temperatureInfo. This only works for multi-group data (i.e., multiGroup or multiGroupWithSnElasticUpScatter type data). If a_label is not an empty string, then it is used as the label for the form to return and a_temperatureInfo is ignored.

Parameters

a_smr	[Out] If errors are not to be thrown, then the error is reported via this instance.
a_suite	[in] The suite to search for the requested form.
a_temperatureInfo	[in] Specifies the temperature and labels use to lookup the requested data.
a_dataType	[in] The type of data being required. Only used if data not found.
a_label	[in] The not an empty string, this is used as the label for the form to return.

Definition at line 142 of file GIDI_settings.cc.

                                                                           {
 
    std::string label;
 
    if( a_label != "" ) {
        label = a_label; }
    else if( m_mode == Mode::multiGroup ) {
        label = a_temperatureInfo.heatedMultiGroup( ); }
    else if( m_mode == Mode::multiGroupWithSnElasticUpScatter ) {
        label = a_temperatureInfo.SnElasticUpScatter( );
    }
 
    Suite::const_iterator iter = a_suite.find( label, true );
    if( ( iter == a_suite.end( ) ) && ( a_label == "" ) ) {
        if( m_mode == Mode::multiGroupWithSnElasticUpScatter ) iter = a_suite.find( a_temperatureInfo.heatedMultiGroup( ), true );
    }
 
    if( iter == a_suite.end( ) ) {
        std::string sourceInfo( a_suite.toXLink( ) );
        ProtareSingle const *rootProtareSingle = static_cast<ProtareSingle const *>( a_suite.root( ) );
        sourceInfo += " for protare " + rootProtareSingle->projectile( ).ID( ) + " + " + rootProtareSingle->target( ).ID( ) 
                + " for " + rootProtareSingle->evaluation( ) + ".";
 
        if( throwOnError( ) ) {
            throw Exception( "ERROR from GIDI::MG::form: label '" + label + "' not found in suite '" + sourceInfo ); }
        else {
            std::string warning( "data for " + a_dataType + " not found with label '" + label + "' in suite " + sourceInfo );
            smr_setReportError2p( a_smr.smr( ), 0, 0, warning.c_str( ) );
        }
        return( nullptr );
    }
 
    return( *iter );
}

Referenced by GIDI::Product::maximumLegendreOrder(), GIDI::Reaction::multiGroupAvailableEnergy(), GIDI::Reaction::multiGroupAvailableMomentum(), GIDI::Product::multiGroupAverageEnergy(), GIDI::Product::multiGroupAverageMomentum(), GIDI::Reaction::multiGroupCrossSection(), GIDI::Product::multiGroupMultiplicity(), GIDI::Product::multiGroupProductMatrix(), GIDI::FissionFragmentData::multiGroupQ(), and GIDI::OutputChannel::multiGroupQ().

mode()

Mode GIDI::Transporting::MG::mode ( ) const

inline

Returns the value of the m_mode member.

Definition at line 3761 of file GIDI.hpp.

setMode()

void GIDI::Transporting::MG::setMode ( Mode a_mode )

inline

Sets the m_mode member to a_mode.

Definition at line 3762 of file GIDI.hpp.

setUseMultiGroupSummedData()

void GIDI::Transporting::MG::setUseMultiGroupSummedData ( bool a_useMultiGroupSummedData )

inline

Sets the m_useMultiGroupSummedData member to a_useMultiGroupSummedData.

Definition at line 3765 of file GIDI.hpp.

useMultiGroupSummedData()

bool GIDI::Transporting::MG::useMultiGroupSummedData ( ) const

inline

Returns the value of the m_useMultiGroupSummedData member.

Definition at line 3764 of file GIDI.hpp.

---

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

• GIDI.hpp
• GIDI_settings.cc