Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
MCGIDI::Transporting::MC Class Reference

#include <MCGIDI.hpp>

Inheritance diagram for MCGIDI::Transporting::MC:

Public Member Functions

LUPI_HOST MC (PoPI::Database const &a_pops, std::string const &a_projectileID, GIDI::Styles::Suite const *a_styles, std::string const &a_label, GIDI::Transporting::DelayedNeutrons a_delayedNeutrons, double energyDomainMax)
LUPI_HOST MC (PoPI::Database const &a_pops, GIDI::Protare const &a_protare, std::string const &a_label, GIDI::Transporting::DelayedNeutrons a_delayedNeutrons, double energyDomainMax)
LUPI_HOST GIDI::Styles::Suite const * styles () const
LUPI_HOST void styles (GIDI::Styles::Suite const *a_styles)
LUPI_HOST std::string label () const
LUPI_HOST double energyDomainMax () const
LUPI_HOST bool ignoreENDF_MT5 () const
LUPI_HOST void set_ignoreENDF_MT5 (bool a_ignoreENDF_MT5)
LUPI_HOST void setIgnoreENDF_MT5 (bool a_ignoreENDF_MT5)
LUPI_HOST bool sampleNonTransportingParticles () const
LUPI_HOST void sampleNonTransportingParticles (bool a_sampleNonTransportingParticles)
LUPI_HOST void setSampleNonTransportingParticles (bool a_sampleNonTransportingParticles)
LUPI_HOST bool useSlowerContinuousEnergyConversion () const
LUPI_HOST void setUseSlowerContinuousEnergyConversion (bool a_useSlowerContinuousEnergyConversion)
LUPI_HOST bool addExpectedValueData () const
LUPI_HOST void setAddExpectedValueData (bool a_addExpectedValueData)
LUPI_HOST LookupMode::Data1d crossSectionLookupMode () const
LUPI_HOST void setCrossSectionLookupMode (LookupMode::Data1d a_crossSectionLookupMode)
LUPI_HOST void crossSectionLookupMode (LookupMode::Data1d a_crossSectionLookupMode)
LUPI_HOST LookupMode::Data1d other1dDataLookupMode () const
LUPI_HOST void setOther1dDataLookupMode (LookupMode::Data1d a_other1dDataLookupMode)
LUPI_HOST void other1dDataLookupMode (LookupMode::Data1d a_other1dDataLookupMode)
LUPI_HOST LookupMode::Distribution distributionLookupMode () const
LUPI_HOST void setDistributionLookupMode (LookupMode::Distribution a_distributionLookupMode)
LUPI_HOST void distributionLookupMode (LookupMode::Distribution a_distributionLookupMode)
LUPI_HOST Sampling::Upscatter::Model upscatterModel () const
LUPI_HOST void setUpscatterModelA ()
LUPI_HOST void setUpscatterModelB ()
LUPI_HOST void setUpscatterModelBSnLimits ()
LUPI_HOST void setUpscatterModelDBRC ()
LUPI_HOST std::vector< double > const & upscatterModelAGroupBoundaries ()
LUPI_HOST void setUpscatterModelAGroupBoundaries (std::vector< double > const &a_groupBoundaries)
LUPI_HOST bool want_URR_probabilityTables () const
LUPI_HOST void want_URR_probabilityTables (bool a_want_URR_probabilityTables)
LUPI_HOST URR_mode _URR_mode () const
LUPI_HOST void setURR_mode (URR_mode a_URR_mode)
LUPI_HOST bool wantTerrellPromptNeutronDistribution () const
LUPI_HOST void setWantTerrellPromptNeutronDistribution (bool a_wantTerrellPromptNeutronDistribution)
LUPI_HOST void wantTerrellPromptNeutronDistribution (bool a_wantTerrellPromptNeutronDistribution)
LUPI_HOST bool wantRawTNSL_distributionSampling () const
LUPI_HOST bool wantRawTNSL_distributionSampling ()
LUPI_HOST void set_wantRawTNSL_distributionSampling (bool a_wantRawTNSL_distributionSampling)
LUPI_HOST std::vector< double > fixedGridPoints () const
LUPI_HOST void fixedGridPoints (std::vector< double > a_fixedGridPoints)
LUPI_HOST bool makePhotonEmissionProbabilitiesOne () const
LUPI_HOST void setMakePhotonEmissionProbabilitiesOne (bool a_makePhotonEmissionProbabilitiesOne)
LUPI_HOST bool zeroNuclearLevelEnergyWidth () const
LUPI_HOST void setZeroNuclearLevelEnergyWidth (bool a_zeroNuclearLevelEnergyWidth)
LUPI_HOST void process (GIDI::Protare const &a_protare)
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

Class to store user defined preferences for creating an MCGIDI::Protare instance.

Definition at line 103 of file MCGIDI.hpp.

Constructor & Destructor Documentation

◆ MC() [1/2]

LUPI_HOST MCGIDI::Transporting::MC::MC ( PoPI::Database const & a_pops,
std::string const & a_projectileID,
GIDI::Styles::Suite const * a_styles,
std::string const & a_label,
GIDI::Transporting::DelayedNeutrons a_delayedNeutrons,
double energyDomainMax )

◆ MC() [2/2]

LUPI_HOST MCGIDI::Transporting::MC::MC ( PoPI::Database const & a_pops,
GIDI::Protare const & a_protare,
std::string const & a_label,
GIDI::Transporting::DelayedNeutrons a_delayedNeutrons,
double energyDomainMax )

Member Function Documentation

◆ _URR_mode()

LUPI_HOST URR_mode MCGIDI::Transporting::MC::_URR_mode ( ) const
inline

Returns the value of the m_URR_mode member.

Definition at line 194 of file MCGIDI.hpp.

Referenced by MCGIDI::convertACE_URR_probabilityTablesFromGIDI(), and MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy().

◆ addExpectedValueData()

LUPI_HOST bool MCGIDI::Transporting::MC::addExpectedValueData ( ) const
inline

Returns the value of the m_addExpectedValueData member.

Definition at line 155 of file MCGIDI.hpp.

Referenced by MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy().

◆ crossSectionLookupMode() [1/2]

LUPI_HOST LookupMode::Data1d MCGIDI::Transporting::MC::crossSectionLookupMode ( ) const
inline

Returns the value of the m_crossSectionLookupMode.

Definition at line 158 of file MCGIDI.hpp.

Referenced by MCGIDI::convertACE_URR_probabilityTablesFromGIDI().

◆ crossSectionLookupMode() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::crossSectionLookupMode ( LookupMode::Data1d a_crossSectionLookupMode)
inline

See method setCrossSectionLookupMode. This method is deprecated.

Definition at line 160 of file MCGIDI.hpp.

◆ distributionLookupMode() [1/2]

LUPI_HOST LookupMode::Distribution MCGIDI::Transporting::MC::distributionLookupMode ( ) const
inline

Returns the value of the m_distributionLookupMode.

Definition at line 170 of file MCGIDI.hpp.

◆ distributionLookupMode() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::distributionLookupMode ( LookupMode::Distribution a_distributionLookupMode)
inline

See method setDistributionLookupMode. This method is deprecated.

Definition at line 172 of file MCGIDI.hpp.

◆ energyDomainMax()

LUPI_HOST double MCGIDI::Transporting::MC::energyDomainMax ( ) const
inline

Returns the value of the m_energyDomainMax.

Definition at line 138 of file MCGIDI.hpp.

Referenced by MC(), and MC().

◆ fixedGridPoints() [1/2]

LUPI_HOST std::vector< double > MCGIDI::Transporting::MC::fixedGridPoints ( ) const
inline

Definition at line 212 of file MCGIDI.hpp.

212{ return( m_fixedGridPoints ); }

Referenced by MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy().

◆ fixedGridPoints() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::fixedGridPoints ( std::vector< double > a_fixedGridPoints)
inline

Definition at line 213 of file MCGIDI.hpp.

213{ m_fixedGridPoints = a_fixedGridPoints; }

◆ ignoreENDF_MT5()

LUPI_HOST bool MCGIDI::Transporting::MC::ignoreENDF_MT5 ( ) const
inline

Returns the value of the m_ignoreENDF_MT5.

Definition at line 140 of file MCGIDI.hpp.

◆ label()

LUPI_HOST std::string MCGIDI::Transporting::MC::label ( ) const
inline

Definition at line 134 of file MCGIDI.hpp.

134{ return( m_label ); }

◆ makePhotonEmissionProbabilitiesOne()

LUPI_HOST bool MCGIDI::Transporting::MC::makePhotonEmissionProbabilitiesOne ( ) const
inline

Returns the value of the m_makePhotonEmissionProbabilitiesOne member.

Definition at line 215 of file MCGIDI.hpp.

◆ other1dDataLookupMode() [1/2]

LUPI_HOST LookupMode::Data1d MCGIDI::Transporting::MC::other1dDataLookupMode ( ) const
inline

Returns the value of the m_other1dDataLookupMode.

Definition at line 164 of file MCGIDI.hpp.

◆ other1dDataLookupMode() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::other1dDataLookupMode ( LookupMode::Data1d a_other1dDataLookupMode)
inline

See method setOther1dDataLookupMode. This method is deprecated.

Definition at line 166 of file MCGIDI.hpp.

◆ process()

LUPI_HOST void MCGIDI::Transporting::MC::process ( GIDI::Protare const & a_protare)

◆ sampleNonTransportingParticles() [1/2]

LUPI_HOST bool MCGIDI::Transporting::MC::sampleNonTransportingParticles ( ) const
inline

Definition at line 145 of file MCGIDI.hpp.

145{ return( m_sampleNonTransportingParticles); }

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

◆ sampleNonTransportingParticles() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::sampleNonTransportingParticles ( bool a_sampleNonTransportingParticles)
inline

Definition at line 146 of file MCGIDI.hpp.

146 {
147 LUPI::deprecatedFunction( "MCGIDI::Transporting::MC::sampleNonTransportingParticles", "MCGIDI::Transporting::MC::setSampleNonTransportingParticles", "" );
148 setSampleNonTransportingParticles( a_sampleNonTransportingParticles ); }
LUPI_HOST void setSampleNonTransportingParticles(bool a_sampleNonTransportingParticles)
Definition MCGIDI.hpp:149
void deprecatedFunction(std::string const &a_functionName, std::string const &a_replacementName, std::string const &a_asOf)

◆ set_ignoreENDF_MT5()

LUPI_HOST void MCGIDI::Transporting::MC::set_ignoreENDF_MT5 ( bool a_ignoreENDF_MT5)
inline

Definition at line 141 of file MCGIDI.hpp.

141{ m_ignoreENDF_MT5 = a_ignoreENDF_MT5; }

Referenced by setIgnoreENDF_MT5().

◆ set_wantRawTNSL_distributionSampling()

LUPI_HOST void MCGIDI::Transporting::MC::set_wantRawTNSL_distributionSampling ( bool a_wantRawTNSL_distributionSampling)
inline

Definition at line 209 of file MCGIDI.hpp.

209 {
210 m_wantRawTNSL_distributionSampling = a_wantRawTNSL_distributionSampling; }

◆ setAddExpectedValueData()

LUPI_HOST void MCGIDI::Transporting::MC::setAddExpectedValueData ( bool a_addExpectedValueData)
inline

Set the m_addExpectedValueData member to a_addExpectedValueData.

Definition at line 156 of file MCGIDI.hpp.

◆ setCrossSectionLookupMode()

LUPI_HOST void MCGIDI::Transporting::MC::setCrossSectionLookupMode ( LookupMode::Data1d a_crossSectionLookupMode)

Sets the m_crossSectionLookupMode member of this to a_crossSectionLookupMode.

Parameters
a_crossSectionLookupMode[in] The LookupMode::Data1d data mode.

Definition at line 91 of file MCGIDI_settings.cc.

91 {
92
93 if( ( a_crossSectionLookupMode != LookupMode::Data1d::continuousEnergy ) &&
94 ( a_crossSectionLookupMode != LookupMode::Data1d::multiGroup ) ) {
95 throw( "Invalided cross section mode request." );
96 }
97 m_crossSectionLookupMode = a_crossSectionLookupMode;
98}

Referenced by crossSectionLookupMode(), and setCrossSectionLookupMode().

◆ setDistributionLookupMode()

LUPI_HOST void MCGIDI::Transporting::MC::setDistributionLookupMode ( LookupMode::Distribution a_distributionLookupMode)

Sets the m_distributionLookupMode member of this to a_distributionLookupMode.

Parameters
a_distributionLookupMode[in] The LookupMode::Data1d data mode.

Definition at line 118 of file MCGIDI_settings.cc.

118 {
119
120 if( a_distributionLookupMode != LookupMode::Distribution::pdf_cdf ) throw( "Invalided distribution mode request." );
121 m_distributionLookupMode = a_distributionLookupMode;
122}

Referenced by distributionLookupMode(), and setDistributionLookupMode().

◆ setIgnoreENDF_MT5()

LUPI_HOST void MCGIDI::Transporting::MC::setIgnoreENDF_MT5 ( bool a_ignoreENDF_MT5)
inline

This function is deprecated. Use set_ignoreENDF_MT5 instead.

Definition at line 142 of file MCGIDI.hpp.

◆ setMakePhotonEmissionProbabilitiesOne()

LUPI_HOST void MCGIDI::Transporting::MC::setMakePhotonEmissionProbabilitiesOne ( bool a_makePhotonEmissionProbabilitiesOne)
inline

Sets member m_makePhotonEmissionProbabilitiesOne to a_makePhotonEmissionProbabilitiesOne.

Definition at line 217 of file MCGIDI.hpp.

◆ setOther1dDataLookupMode()

LUPI_HOST void MCGIDI::Transporting::MC::setOther1dDataLookupMode ( LookupMode::Data1d a_other1dDataLookupMode)

Sets the m_other1dDataLookupMode member of this to a_other1dDataLookupMode.

Parameters
a_other1dDataLookupMode[in] The LookupMode::Data1d data mode.

Definition at line 106 of file MCGIDI_settings.cc.

106 {
107
108 if( a_other1dDataLookupMode != LookupMode::Data1d::continuousEnergy ) throw( "Invalided other mode request." );
109 m_other1dDataLookupMode = a_other1dDataLookupMode;
110}

Referenced by other1dDataLookupMode(), and setOther1dDataLookupMode().

◆ setSampleNonTransportingParticles()

LUPI_HOST void MCGIDI::Transporting::MC::setSampleNonTransportingParticles ( bool a_sampleNonTransportingParticles)
inline

Definition at line 149 of file MCGIDI.hpp.

149{ m_sampleNonTransportingParticles = a_sampleNonTransportingParticles; }

Referenced by G4GIDI::readTarget(), and sampleNonTransportingParticles().

◆ setUpscatterModelA()

LUPI_HOST void MCGIDI::Transporting::MC::setUpscatterModelA ( )
inline

See member m_upscatterModel to Sampling::Upscatter::Model::A.

Definition at line 177 of file MCGIDI.hpp.

◆ setUpscatterModelAGroupBoundaries()

LUPI_HOST void MCGIDI::Transporting::MC::setUpscatterModelAGroupBoundaries ( std::vector< double > const & a_groupBoundaries)

This method sets the member m_upscatterModelAGroupBoundaries to a_groupBoundaries. It also checks that the groups are in ascending order and executes a throw if they are not.

Parameters
a_groupBoundaries[in] List of multi-group boundaries.

Definition at line 131 of file MCGIDI_settings.cc.

131 {
132
133 double priorValue = 0.0;
134
135 for( std::size_t index = 0; index < a_groupBoundaries.size( ); ++index ) {
136 double value = a_groupBoundaries[index];
137
138 if( index != 0 ) {
139 if( value <= priorValue ) throw( "MC::setUpscatterModelAGroupBoundaries: group boundaries not in ascending order/" );
140 }
141 priorValue = value;
142 }
143
144 m_upscatterModelAGroupBoundaries = a_groupBoundaries;
145}

Referenced by setUpscatterModelAGroupBoundaries().

◆ setUpscatterModelB()

LUPI_HOST void MCGIDI::Transporting::MC::setUpscatterModelB ( )
inline

Set member m_upscatterModel to Sampling::Upscatter::Model::B.

Definition at line 178 of file MCGIDI.hpp.

◆ setUpscatterModelBSnLimits()

LUPI_HOST void MCGIDI::Transporting::MC::setUpscatterModelBSnLimits ( )
inline

Set member m_upscatterModel to Sampling::Upscatter::Model::BSnLimits.

Definition at line 179 of file MCGIDI.hpp.

◆ setUpscatterModelDBRC()

LUPI_HOST void MCGIDI::Transporting::MC::setUpscatterModelDBRC ( )
inline

Set member m_upscatterModel to Sampling::Upscatter::Model::DBRC.

Definition at line 180 of file MCGIDI.hpp.

◆ setURR_mode()

LUPI_HOST void MCGIDI::Transporting::MC::setURR_mode ( URR_mode a_URR_mode)
inline

This methods sets member m_URR_mode to a_URR_mode.

Definition at line 195 of file MCGIDI.hpp.

◆ setUseSlowerContinuousEnergyConversion()

LUPI_HOST void MCGIDI::Transporting::MC::setUseSlowerContinuousEnergyConversion ( bool a_useSlowerContinuousEnergyConversion)
inline

Definition at line 152 of file MCGIDI.hpp.

152 {
153 m_useSlowerContinuousEnergyConversion = a_useSlowerContinuousEnergyConversion; }

◆ setWantTerrellPromptNeutronDistribution()

LUPI_HOST void MCGIDI::Transporting::MC::setWantTerrellPromptNeutronDistribution ( bool a_wantTerrellPromptNeutronDistribution)
inline

Set the m_wantTerrellPromptNeutronDistribution member to a_wantTerrellPromptNeutronDistribution.

Definition at line 199 of file MCGIDI.hpp.

Referenced by wantTerrellPromptNeutronDistribution().

◆ setZeroNuclearLevelEnergyWidth()

LUPI_HOST void MCGIDI::Transporting::MC::setZeroNuclearLevelEnergyWidth ( bool a_zeroNuclearLevelEnergyWidth)
inline

Sets member m_zeroNuclearLevelEnergyWidth to a_zeroNuclearLevelEnergyWidth.

Definition at line 221 of file MCGIDI.hpp.

◆ styles() [1/2]

LUPI_HOST GIDI::Styles::Suite const * MCGIDI::Transporting::MC::styles ( ) const
inline

Returns the value of the m_styles.

Definition at line 131 of file MCGIDI.hpp.

Referenced by MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy(), and MCGIDI::Distributions::parseGIDI().

◆ styles() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::styles ( GIDI::Styles::Suite const * a_styles)
inline

This is needed for ProtareTNSL, but should be avoided otherwise. FIXME, need to have a better way.

Definition at line 132 of file MCGIDI.hpp.

◆ upscatterModel()

LUPI_HOST Sampling::Upscatter::Model MCGIDI::Transporting::MC::upscatterModel ( ) const
inline

Returns the value of the m_upscatterModel.

Definition at line 176 of file MCGIDI.hpp.

◆ upscatterModelAGroupBoundaries()

LUPI_HOST std::vector< double > const & MCGIDI::Transporting::MC::upscatterModelAGroupBoundaries ( )
inline

Returns a const reference to the m_upscatterModelAGroupBoundaries member.

Definition at line 181 of file MCGIDI.hpp.

◆ useSlowerContinuousEnergyConversion()

LUPI_HOST bool MCGIDI::Transporting::MC::useSlowerContinuousEnergyConversion ( ) const
inline

Definition at line 151 of file MCGIDI.hpp.

151{ return( m_useSlowerContinuousEnergyConversion ); }

Referenced by MCGIDI::HeatedCrossSectionContinuousEnergy::HeatedCrossSectionContinuousEnergy().

◆ want_URR_probabilityTables() [1/2]

LUPI_HOST bool MCGIDI::Transporting::MC::want_URR_probabilityTables ( ) const
inline

Returns false if m_URR_mode is URR_mode::none and true otherwise. This method is deprecated. Please use _URR_mode instead.

Definition at line 185 of file MCGIDI.hpp.

◆ want_URR_probabilityTables() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::want_URR_probabilityTables ( bool a_want_URR_probabilityTables)
inline

If a_want_URR_probabilityTables is true sets m_URR_mode to URR_mode::pdfs, otherwise set it to URR_mode::none. This method is deprecated. Please use setURR_mode instead.

Definition at line 188 of file MCGIDI.hpp.

◆ wantRawTNSL_distributionSampling() [1/2]

LUPI_HOST bool MCGIDI::Transporting::MC::wantRawTNSL_distributionSampling ( )
inline

Definition at line 208 of file MCGIDI.hpp.

208{ return( m_wantRawTNSL_distributionSampling ); }

◆ wantRawTNSL_distributionSampling() [2/2]

LUPI_HOST bool MCGIDI::Transporting::MC::wantRawTNSL_distributionSampling ( ) const
inline

Definition at line 207 of file MCGIDI.hpp.

207{ return( m_wantRawTNSL_distributionSampling ); }

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

◆ wantTerrellPromptNeutronDistribution() [1/2]

LUPI_HOST bool MCGIDI::Transporting::MC::wantTerrellPromptNeutronDistribution ( ) const
inline

Returns the value of the m_wantTerrellPromptNeutronDistribution member.

Definition at line 197 of file MCGIDI.hpp.

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

◆ wantTerrellPromptNeutronDistribution() [2/2]

LUPI_HOST void MCGIDI::Transporting::MC::wantTerrellPromptNeutronDistribution ( bool a_wantTerrellPromptNeutronDistribution)
inline

See method setWantTerrellPromptNeutronDistribution. This method is deprecated.

Definition at line 202 of file MCGIDI.hpp.

◆ zeroNuclearLevelEnergyWidth()

LUPI_HOST bool MCGIDI::Transporting::MC::zeroNuclearLevelEnergyWidth ( ) const
inline

Returns the value of the m_zeroNuclearLevelEnergyWidth member.

Definition at line 219 of file MCGIDI.hpp.


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