GIDI::Transporting::Settings Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Transporting::Settings:

Public Member Functions
	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 and the Monte Carlo API MCGIDI on what data are being requested.

Definition at line 3712 of file GIDI.hpp.

Constructor & Destructor Documentation

Settings()

GIDI::Transporting::Settings::Settings	(	std::string const &	a_projectileID,
		DelayedNeutrons	a_delayedNeutrons )

Parameters

a_projectileID	[in] The PoPs id for the projectile.
a_delayedNeutrons	[in] Flag indicating whether or not delayed neutron data are to be include in the requested data.

Definition at line 25 of file GIDI_settings.cc.

                                                                                       :
        m_projectileID( a_projectileID ),
        m_delayedNeutrons( a_delayedNeutrons ),
        m_nuclearPlusCoulombInterferenceOnly( false ),
        m_throwOnError( true ),
        m_zeroDepositionIfAllProductsTracked( true ) {
 
}

Referenced by GIDI::Transporting::MG::MG().

~Settings()

GIDI::Transporting::Settings::~Settings

(

)

Definition at line 37 of file GIDI_settings.cc.

                     {
 
}

Member Function Documentation

delayedNeutrons()

DelayedNeutrons GIDI::Transporting::Settings::delayedNeutrons ( ) const

inline

Returns the value of the m_delayedNeutrons member.

Definition at line 3727 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::continuousEnergyProductData(), GIDI::FissionFragmentData::incompleteParticles(), GIDI::FissionFragmentData::mapContinuousEnergyProductData(), GIDI::FissionFragmentData::maximumLegendreOrder(), GIDI::FissionFragmentData::multiGroupAverageEnergy(), GIDI::FissionFragmentData::multiGroupAverageMomentum(), GIDI::FissionFragmentData::multiGroupMultiplicity(), GIDI::FissionFragmentData::multiGroupProductMatrix(), GIDI::FissionFragmentData::multiGroupQ(), GIDI::Functions::FissionEnergyRelease::multiGroupQ(), and MCGIDI::OutputChannel::OutputChannel().

multiGroupZeroMatrix()

Matrix GIDI::Transporting::Settings::multiGroupZeroMatrix	(	Particles const &	a_particles,
		std::string const &	a_pid,
		bool	a_collapse = true ) const

Returns a Matrix of 0.0's of the proper length for the projectile's and product's multi-group data.

Parameters

a_particles	[in] The list of particles to be transported.
a_pid	[in] The PoPs index for the product.
a_collapse	[in] If true, the length of the returned vector is for the collapsed multi-group, otherwise, it is for the uncollapsed multi-group.

Returns

The Matrix of 0.0.

Definition at line 71 of file GIDI_settings.cc.

                                                                                                                   {
 
    Particle const *projectile( a_particles.particle( projectileID( ) ) );
    Particle const *product( a_particles.particle( a_pid ) );
 
    std::size_t n1 = projectile->fineMultiGroup( ).numberOfGroups( );
    std::size_t n2 = product->fineMultiGroup( ).numberOfGroups( );
    if( a_collapse ) {
        n1 = projectile->numberOfGroups( );
        n2 = product->numberOfGroups( );
    }
 
    Matrix matrix( n1, n2 );
    return( matrix );
}

Referenced by GIDI::collapse().

multiGroupZeroVector()

Vector GIDI::Transporting::Settings::multiGroupZeroVector	(	Particles const &	a_particles,
		bool	a_collapse = true ) const

Returns a Vector of 0.0's of the proper length for the projectile's multi-group data.

Parameters

a_particles	[in] The list of particles to be transported.
a_collapse	[in] If true, the length of the returned vector is for the collapsed multi-group, otherwise, it is for the uncollapsed multi-group.

Returns

The Vector of 0.0.

Definition at line 50 of file GIDI_settings.cc.

                                                                                           {
 
    Particle const *projectile( a_particles.particle( projectileID( ) ) );
 
    std::size_t n1 = projectile->fineMultiGroup( ).numberOfGroups( );
    if( a_collapse ) n1 = projectile->numberOfGroups( );
 
    Vector vector( n1 );
    return( vector );
}

nuclearPlusCoulombInterferenceOnly()

bool GIDI::Transporting::Settings::nuclearPlusCoulombInterferenceOnly ( ) const

inline

Returns the value of the m_nuclearPlusCoulombInterferenceOnly member.

Definition at line 3730 of file GIDI.hpp.

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

projectileID()

std::string const & GIDI::Transporting::Settings::projectileID ( ) const

inline

Returns the value of the m_projectileID member.

Definition at line 3725 of file GIDI.hpp.

Referenced by GIDI::collapse(), GIDI::collapse(), multiGroupZeroMatrix(), and multiGroupZeroVector().

setDelayedNeutrons()

void GIDI::Transporting::Settings::setDelayedNeutrons ( DelayedNeutrons a_delayedNeutrons )

inline

Sets the m_delayedNeutrons member to a_delayedNeutrons.

Definition at line 3728 of file GIDI.hpp.

setNuclearPlusCoulombInterferenceOnly()

void GIDI::Transporting::Settings::setNuclearPlusCoulombInterferenceOnly ( bool a_nuclearPlusCoulombInterferenceOnly )

inline

Sets the m_nuclearPlusCoulombInterferenceOnly to a_nuclearPlusCoulombInterferenceOnly.

Definition at line 3731 of file GIDI.hpp.

setThrowOnError()

void GIDI::Transporting::Settings::setThrowOnError ( bool a_throwOnError )

inline

Definition at line 3739 of file GIDI.hpp.

{ m_throwOnError = a_throwOnError; }

Referenced by G4GIDI::readTarget().

setZeroDepositionIfAllProductsTracked()

void GIDI::Transporting::Settings::setZeroDepositionIfAllProductsTracked ( bool a_zeroDepositionIfAllProductsTracked )

inline

Sets the m_zeroDepositionIfAllProductsTracked to a_zeroDepositionIfAllProductsTracked.

Definition at line 3735 of file GIDI.hpp.

throwOnError()

bool GIDI::Transporting::Settings::throwOnError ( ) const

inline

Definition at line 3738 of file GIDI.hpp.

{ return( m_throwOnError ); }

Referenced by GIDI::Transporting::MG::form().

zeroDepositionIfAllProductsTracked()

bool GIDI::Transporting::Settings::zeroDepositionIfAllProductsTracked ( ) const

inline

Returns the value of the m_zeroDepositionIfAllProductsTracked member.

Definition at line 3734 of file GIDI.hpp.

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

---

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

• GIDI.hpp
• GIDI_settings.cc