|
Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
|
#include <GIDI.hpp>
Public Member Functions | |
| ProtareSingle (PoPI::Database const &a_pops, std::string const &a_projectileID, std::string const &a_targetID, std::string const &a_evaluation, std::string const &a_interaction, std::string const &a_formatVersion=GNDS_formatVersion_1_10Chars) | |
| ProtareSingle (Construction::Settings const &a_construction, std::string const &a_fileName, FileType a_fileType, PoPI::Database const &a_pops, ParticleSubstitution const &a_particleSubstitution, std::vector< std::string > const &a_libraries, std::string const &a_interaction, bool a_targetRequiredInGlobalPoPs=true, bool a_requiredInPoPs=true) | |
| ProtareSingle (Construction::Settings const &a_construction, HAPI::Node const &a_protare, PoPI::Database const &a_pops, ParticleSubstitution const &a_particleSubstitution, std::vector< std::string > const &a_libraries, std::string const &a_interaction, bool a_targetRequiredInGlobalPoPs=true, bool a_requiredInPoPs=true) | |
| ~ProtareSingle () | |
| PoPI::NuclideGammaBranchStateInfos const & | nuclideGammaBranchStateInfos () const |
| HAPI::DataManager * | dataManager () |
| void | setDataManager (HAPI::DataManager *a_dataManager) |
| void | incrementNumberOfLazyParsingHelperForms () |
| void | incrementNumberOfLazyParsingHelperFormsReplaced () |
| TargetInfo::TargetInfo const & | targetInfo () const |
| double | projectileEnergyMin () const |
| double | projectileEnergyMax () const |
| bool | isTNSL_ProtareSingle () const |
| bool | isPhotoAtomic () const |
| Suite & | reactions () |
| Suite const & | reactions () const |
| Suite & | orphanProducts () |
| Suite const & | orphanProducts () const |
| Suite & | incompleteReactions () |
| Suite const & | incompleteReactions () const |
| Sums::Sums & | sums () |
| Sums::Sums const & | sums () const |
| Suite & | fissionComponents () |
| bool | RutherfordScatteringPresent () const |
| bool | onlyRutherfordScatteringPresent () const |
| Reaction const * | nuclearPlusCoulombInterferenceOnlyReaction () const |
| Reaction const * | checkIf_nuclearPlusCoulombInterferenceWanted (Transporting::MG const &a_settings, Reaction const *a_reaction) const |
| Reaction const * | reactionToMultiGroup (Transporting::MG const &a_settings, std::size_t a_index, ExcludeReactionsSet const &a_reactionsToExclude) const |
| Reaction const * | multiGroupSummedReaction () const |
| OutputChannel const * | multiGroupSummedDelayedNeutrons () const |
| Suite const & | ACE_URR_probabilityTables () const |
| Suite const & | photoAtomicIncoherentDoppler () const |
| GRIN::GRIN_continuumGammas const * | GRIN_continuumGammas2 () const |
| ProtareType | protareType () const |
| std::size_t | numberOfProtares () const |
| ProtareSingle * | protare (std::size_t a_index) |
| ProtareSingle const * | protare (std::size_t a_index) const |
| LUPI::FormatVersion const & | formatVersion (LUPI_maybeUnused std::size_t a_index=0) const |
| std::string const & | fileName (LUPI_maybeUnused std::size_t a_index=0) const |
| std::string const & | realFileName (LUPI_maybeUnused std::size_t a_index=0) const |
| std::vector< std::string > | libraries (LUPI_maybeUnused std::size_t a_index=0) const |
| std::string const & | evaluation (LUPI_maybeUnused std::size_t a_index=0) const |
| std::string const & | interaction (LUPI_maybeUnused std::size_t a_index=0) const |
| Frame | projectileFrame (LUPI_maybeUnused std::size_t a_index=0) const |
| int | numberOfLazyParsingHelperForms () const |
| int | numberOfLazyParsingHelperFormsReplaced () const |
| double | thresholdFactor () const |
| Documentation_1_10::Suite & | documentations () |
| ExternalFile const & | externalFile (std::string const a_label) const |
| ExternalFiles::Suite const & | externalFiles () const |
| Styles::Base & | style (std::string const &a_label) |
| Styles::Base const & | style (std::string const &a_label) const |
| Styles::Suite & | styles () |
| Styles::Suite const & | styles () const |
| PoPI::Database const & | internalPoPs () const |
| PoPI::Database & | internalPoPs () |
| int | intid (std::string const &a_id) const |
| void | productIDs (std::set< std::string > &a_ids, Transporting::Particles const &a_particles, bool a_transportablesOnly) const |
| int | maximumLegendreOrder (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const |
| Styles::TemperatureInfos | temperatures () const |
| std::size_t | numberOfReactions () const |
| Reaction * | reaction (std::size_t a_index) |
| Reaction const * | reaction (std::size_t a_index) const |
| Reaction const * | reaction (std::size_t a_index, Transporting::MG const &a_settings, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| std::size_t | numberOfInactiveReactions () const |
| std::size_t | numberOfOrphanProducts () const |
| Reaction * | orphanProduct (std::size_t a_index) |
| Reaction const * | orphanProduct (std::size_t a_index) const |
| std::size_t | numberOfIncompleteReactions () const |
| Reaction * | incompleteReaction (std::size_t a_index) |
| Reaction const * | incompleteReaction (std::size_t a_index) const |
| void | updateReactionIndices (std::size_t a_offset) const |
| bool | hasFission () const |
| bool | isDelayedFissionNeutronComplete () const |
| GUPI::Ancestry * | findInAncestry3 (std::string const &a_item) |
| GUPI::Ancestry const * | findInAncestry3 (std::string const &a_item) const |
| std::vector< double > | groupBoundaries (Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const |
| Vector | multiGroupInverseSpeed (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo) const |
| Vector | multiGroupCrossSection (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}, std::string const &a_label="") const |
| Vector | multiGroupQ (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, bool a_final, bool a_effectivePhotoAtomic=true, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupFissionNeutronMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupFissionGammaMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) 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, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Matrix | multiGroupFissionMatrix (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, std::size_t a_order, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupTransportCorrection (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, std::size_t a_order, TransportCorrectionType a_transportCorrectionType, double a_temperature, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupAvailableEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupAverageEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupDepositionEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupAvailableMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupAverageMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupDepositionMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, Transporting::Particles const &a_particles, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| Vector | multiGroupGain (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const |
| stringAndDoublePairs | muCutoffForCoulombPlusNuclearElastic () const |
| DelayedNeutronProducts | delayedNeutronProducts () const |
| void | incompleteParticles (Transporting::Settings const &a_settings, std::set< std::string > &a_incompleteParticles) const |
| void | saveAs (std::string const &a_fileName) const |
| void | toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const |
| void | parseEvaluatedTargetInfo (HAPI::Node const &a_node) |
| Public Member Functions inherited from GIDI::Protare | |
| Protare () | |
| ~Protare () | |
| ParticleInfo const & | projectile () const |
| void | setProjectile (ParticleInfo const &a_projectile) |
| ParticleInfo const & | target () const |
| void | setTarget (ParticleInfo const &a_target) |
| ParticleInfo const & | GNDS_target () const |
| virtual LUPI::FormatVersion const & | formatVersion (std::size_t a_index=0) const =0 |
| virtual std::string const & | fileName (std::size_t a_index=0) const =0 |
| virtual std::string const & | realFileName (std::size_t a_index=0) const =0 |
| virtual std::vector< std::string > | libraries (std::size_t a_index=0) const =0 |
| virtual std::string const & | evaluation (std::size_t a_index=0) const =0 |
| virtual Frame | projectileFrame (std::size_t a_index=0) const =0 |
| virtual void | TNSL_crossSectionSumCorrection (std::string const &a_label, Functions::XYs1d &a_crossSectionSum) |
| virtual void | TNSL_crossSectionSumCorrection (std::string const &a_label, Functions::Ys1d &a_crossSectionSum) |
| virtual void | TNSL_crossSectionSumCorrection (std::string const &a_label, Vector &a_crossSectionSum) |
| ExcludeReactionsSet | reactionIndicesMatchingENDLCValues (std::set< int > const &a_CValues, bool a_checkActiveState=true) |
| 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) |
| Protected Member Functions inherited from GIDI::Protare | |
| void | initialize (HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, PoPI::Database const &a_internalPoPs, bool a_targetRequiredInGlobalPoPs, bool a_requiredInPoPs=true) |
| GIDI::ProtareSingle::ProtareSingle | ( | PoPI::Database const & | a_pops, |
| std::string const & | a_projectileID, | ||
| std::string const & | a_targetID, | ||
| std::string const & | a_evaluation, | ||
| std::string const & | a_interaction, | ||
| std::string const & | a_formatVersion = GNDS_formatVersion_1_10Chars ) |
Parses a GNDS file to construct the Protare instance. Calls the initialize method which does most of the work.
| a_pops | [in] A PoPs Database instance used to get particle indices and possibly other particle information. |
| a_projectileID | [in] The PoPs id of the projectile. |
| a_targetID | [in] The PoPs id of the target. |
| a_evaluation | [in] The evaluation string. |
| a_interaction | [in] The interaction flag for the protare. |
| a_formatVersion | [in] The GNDS format to use. |
Definition at line 155 of file GIDI_protare.cc.
| GIDI::ProtareSingle::ProtareSingle | ( | Construction::Settings const & | a_construction, |
| std::string const & | a_fileName, | ||
| FileType | a_fileType, | ||
| PoPI::Database const & | a_pops, | ||
| ParticleSubstitution const & | a_particleSubstitution, | ||
| std::vector< std::string > const & | a_libraries, | ||
| std::string const & | a_interaction, | ||
| bool | a_targetRequiredInGlobalPoPs = true, | ||
| bool | a_requiredInPoPs = true ) |
Parses a GNDS file to construct the Protare instance. Calls the initialize method which does most of the work.
| a_construction | [in] Used to pass user options to the constructor. |
| a_fileName | [in] File containing a protare (i.e., reactionSuite) node that is parsed and used to construct the Protare. |
| a_fileType | [in] File type of a_fileType. Currently, only GIDI::FileType::XML and GIDI::FileType::HDF are supported. |
| a_pops | [in] A PoPs Database instance used to get particle indices and possibly other particle information. |
| a_particleSubstitution | [in] Map of particles to substitute with another particles. |
| a_libraries | [in] The list of libraries that were searched to find this. |
| a_interaction | [in] The interaction flag for the protare. |
| a_targetRequiredInGlobalPoPs | [in] If true, the target is required to be in a_pops. |
| a_requiredInPoPs | [in] If true, no particle is required to be in a_pops. |
Definition at line 191 of file GIDI_protare.cc.
| GIDI::ProtareSingle::ProtareSingle | ( | Construction::Settings const & | a_construction, |
| HAPI::Node const & | a_protare, | ||
| PoPI::Database const & | a_pops, | ||
| ParticleSubstitution const & | a_particleSubstitution, | ||
| std::vector< std::string > const & | a_libraries, | ||
| std::string const & | a_interaction, | ||
| bool | a_targetRequiredInGlobalPoPs = true, | ||
| bool | a_requiredInPoPs = true ) |
| GIDI::ProtareSingle::~ProtareSingle | ( | ) |
Definition at line 495 of file GIDI_protare.cc.
|
inline |
Returns a const reference to the m_ACE_URR_probabilityTables member.
Definition at line 4770 of file GIDI.hpp.
Referenced by MCGIDI::convertACE_URR_probabilityTablesFromGIDI().
| Reaction const * GIDI::ProtareSingle::checkIf_nuclearPlusCoulombInterferenceWanted | ( | Transporting::MG const & | a_settings, |
| Reaction const * | a_reaction ) const |
Returns a_reaction except when Rutherford scattering present and only nuclear + Coulomb interference is wanted. Otherwise returns m_nuclearPlusCoulombInterferenceOnlyReaction which may be a nullptr.
| a_settings | [in] Specifies user options. |
| a_reaction | [in] Reaction pointer to return if check passes. |
Definition at line 545 of file GIDI_protare.cc.
Referenced by reactionToMultiGroup().
|
inline |
Returns the value of the m_dataManager member.
Definition at line 4734 of file GIDI.hpp.
Referenced by GIDI::parseValuesOfDoubles(), and GIDI::parseValuesOfInts().
|
virtual |
Returns the list of DelayedNeutronProduct instances.
Implements GIDI::Protare.
Definition at line 1490 of file GIDI_protare.cc.
|
inlinevirtual |
Returns the value of the m_documentations member.
Implements GIDI::Protare.
|
inline |
Returns the value of the m_evaluation member.
Definition at line 4786 of file GIDI.hpp.
Referenced by GIDI::Transporting::MG::form(), and toXMLList().
|
inline |
|
inline |
|
inline |
|
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.
| a_item | [in] The name of the class member whose pointer is to be return. |
Implements GIDI::Protare.
Definition at line 897 of file GIDI_protare.cc.
|
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.
| a_item | [in] The name of the class member whose pointer is to be return. |
Implements GIDI::Protare.
Definition at line 916 of file GIDI_protare.cc.
|
inline |
|
inline |
|
inline |
|
virtual |
Returns the multi-group boundaries for the requested label and product.
| a_settings | [in] Specifies the requested label. |
| a_temperatureInfo | [in] Specifies the temperature and labels use to lookup the requested data. |
| a_productID | [in] ID for the requested product. |
Implements GIDI::Protare.
Definition at line 827 of file GIDI_protare.cc.
|
virtual |
Returns true if at least one reaction contains a fission channel.
Implements GIDI::Protare.
Definition at line 858 of file GIDI_protare.cc.
Referenced by delayedNeutronProducts().
|
virtual |
Calls the incompleteParticles method for each active reaction in the reactions and orphanProducts nodes.
| a_settings | [in] Specifies the requested label. |
| a_incompleteParticles | [out] The list of particles whose completeParticle method returns false. |
Implements GIDI::Protare.
Definition at line 1513 of file GIDI_protare.cc.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
virtual |
Returns the intid for the requested particle or -1 if the particle is not in this PoPs database.
| a_id | [in] The GNDS PoPs id for particle whose intd is requested. |
Implements GIDI::Protare.
Definition at line 611 of file GIDI_protare.cc.
|
virtual |
Returns false* if protare has delayed fission neutrons for an active reaction and they are not complete; otherwise, returns **true.
Implements GIDI::Protare.
Definition at line 875 of file GIDI_protare.cc.
|
inline |
Returns the value of the m_isPhotoAtomic member.
Definition at line 4746 of file GIDI.hpp.
Referenced by GIDI::Product::Product(), and MCGIDI::ProtareSingle::ProtareSingle().
|
inlinevirtual |
Returns true if the instance is a ProtareSingle instance with only TNSL data and false otherwise.
Reimplemented from GIDI::Protare.
Definition at line 4745 of file GIDI.hpp.
Referenced by GIDI::Product::Product().
|
inline |
|
virtual |
Determines the maximum Legredre order present in the multi-group transfer matrix for a give product for a give label.
| 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] The id of the requested product. |
Implements GIDI::Protare.
Definition at line 653 of file GIDI_protare.cc.
|
virtual |
Implements GIDI::Protare.
Definition at line 1465 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total available energy for the requested label. This is a cross section weighted available energy summed over all reactions.
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the available energy. |
Implements GIDI::Protare.
Definition at line 1208 of file GIDI_protare.cc.
Referenced by multiGroupDepositionEnergy().
|
virtual |
Returns the multi-group, total available momentum for the requested label. This is a cross section weighted available momentum summed over all reactions.
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the available momentum. |
Implements GIDI::Protare.
Definition at line 1343 of file GIDI_protare.cc.
Referenced by multiGroupDepositionMomentum().
|
virtual |
Returns the multi-group, total average energy for the requested label for the requested product. This is a cross section weighted average energy summed over all reactions.
| 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. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the average energy. |
Implements GIDI::Protare.
Definition at line 1239 of file GIDI_protare.cc.
Referenced by multiGroupDepositionEnergy().
|
virtual |
Returns the multi-group, total average momentum for the requested label for the requested product. This is a cross section weighted average momentum summed over all reactions.
| 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. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the average momentum. |
Implements GIDI::Protare.
Definition at line 1374 of file GIDI_protare.cc.
Referenced by multiGroupDepositionMomentum().
|
virtual |
Returns the multi-group, total cross section for the requested label. This is summed over all reactions.
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the cross section. |
| a_label | [in] If not an empty string, this is used as the label for the form to return and the a_temperatureInfo labels are ignored. |
Implements GIDI::Protare.
Definition at line 940 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total deposition energy for the requested label. This is a cross section weighted deposition energy summed over all reactions. The deposition energy is calculated by subtracting the average energy from each transportable particle from the available energy. The list of transportable particles is specified via the list of particle specified in the a_settings argument.
| 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 the products that are transported. |
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the deposition energy. |
Implements GIDI::Protare.
Definition at line 1282 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total deposition momentum for the requested label. This is a cross section weighted deposition momentum summed over all reactions. The deposition momentum is calculated by subtracting the average momentum from each transportable particle from the available momentum. The list of transportable particles is specified via the list of particle specified in the a_settings argument.
| 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_particles | [in] The list of particles to be transported. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the deposition momentum. |
Implements GIDI::Protare.
Definition at line 1417 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total fission gamma multiplicity for the requested label. This is a cross section weighted multiplicity.
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the multiplicity. |
Implements GIDI::Protare.
Definition at line 1036 of file GIDI_protare.cc.
|
virtual |
Like ProtareSingle::multiGroupProductMatrix, but only returns the fission neutron, transfer matrix.
| 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_order | [in] Requested product matrix, Legendre order. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the fission matrix. |
Implements GIDI::Protare.
Definition at line 1143 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total fission neutron multiplicity for the requested label. This is a cross section weighted multiplicity.
| 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_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the cross multiplicity. |
Implements GIDI::Protare.
Definition at line 1010 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, gain for the requested particle and label. This is a cross section weighted gain summed over all reactions.
| 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] The particle PoPs' id for the whose gain is to be calculated. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the gain. |
Implements GIDI::Protare.
Definition at line 1443 of file GIDI_protare.cc.
|
virtual |
Returns the inverse speeds for the requested label. The label must be for a heated multi-group style.
| 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. |
Implements GIDI::Protare.
Definition at line 844 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total multiplicity for the requested label for the requested product. This is a cross section weighted multiplicity.
| 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] Id for the requested product. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the multiplicity. |
Implements GIDI::Protare.
Definition at line 970 of file GIDI_protare.cc.
|
virtual |
Returns the multi-group, total product matrix for the requested label for the requested product id for the requested Legendre order. If no data are found, an empty GIDI::Matrix is returned.
| 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] PoPs id for the requested product. |
| a_order | [in] Requested product matrix, Legendre order. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the product matrix. |
Implements GIDI::Protare.
Definition at line 1101 of file GIDI_protare.cc.
Referenced by multiGroupTransportCorrection().
|
virtual |
Returns the multi-group, total Q for the requested label. This is a cross section weighted Q summed over all reactions
| 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 false, only the Q for the primary reactions are return, otherwise, the Q for the final reactions. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the Q. |
Implements GIDI::Protare.
Definition at line 1064 of file GIDI_protare.cc.
|
inline |
|
inline |
|
virtual |
Returns the multi-group transport correction for the requested label. The transport correction is calculated from the transfer matrix for the projectile id for the Legendre order of a_order + 1.
| 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_particles | [in] The list of particles to be transported. |
| a_order | [in] Maximum Legendre order for transport. The returned transport correction is for the next higher Legender order. |
| a_transportCorrectionType | [in] Requested transport correction type. |
| a_temperature | [in] The temperature of the flux to use when collapsing. Pass to the GIDI::collapse method. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the transport correction. |
Implements GIDI::Protare.
Definition at line 1175 of file GIDI_protare.cc.
|
inline |
|
inline |
Returns the value of the m_nuclideGammaBranchStateInfos member.
Definition at line 4731 of file GIDI.hpp.
Referenced by GIDI::Functions::Branching1d::Branching1d().
| std::size_t GIDI::ProtareSingle::numberOfInactiveReactions | ( | ) | const |
The method returns the number of reactions of this that have been deactivated.
Definition at line 780 of file GIDI_protare.cc.
|
inline |
|
inlinevirtual |
Returns the value of the m_numberOfLazyParsingHelperForms member.
Implements GIDI::Protare.
|
inlinevirtual |
Returns the value of the m_numberOfLazyParsingHelperFormsReplaced member.
Implements GIDI::Protare.
|
inlinevirtual |
Returns the number of orphan product reactions in the Protare.
Implements GIDI::Protare.
|
inlinevirtual |
|
inlinevirtual |
Returns the number of reactions in the Protare.
Implements GIDI::Protare.
|
inline |
|
inlinevirtual |
Returns the a_index - 1 orphan product reaction.
Implements GIDI::Protare.
|
inlinevirtual |
Returns the a_index - 1 orphan product reaction.
Implements GIDI::Protare.
|
inline |
|
inline |
| void GIDI::ProtareSingle::parseEvaluatedTargetInfo | ( | HAPI::Node const & | a_node | ) |
This method parses the targetInfo node in the evaluated style node into the m_targetInfo member of this.
| a_node | [in] The protare (i.e., reactionSuite) node to be parsed and used to construct a Protare. |
Definition at line 1594 of file GIDI_protare.cc.
Referenced by GIDI::Styles::Evaluated::Evaluated().
|
inline |
|
virtual |
Fills in a std::set with a unique list of all product indices produced by reactions and orphanProducts. If a_transportablesOnly is true, only transportable product incides are return.
| a_ids | [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. |
Implements GIDI::Protare.
Definition at line 625 of file GIDI_protare.cc.
|
inline |
|
inline |
|
inline |
Returns the value of the m_projectileFrame member.
Definition at line 4788 of file GIDI.hpp.
Referenced by toXMLList().
|
virtual |
Returns the pointer representing the protare (i.e., this) if a_index is 0 and nullptr otherwise.
| a_index | [in] Must always be 0. |
Implements GIDI::Protare.
Definition at line 583 of file GIDI_protare.cc.
Referenced by MCGIDI::ProtareSingle::ProtareSingle().
|
virtual |
Returns the pointer representing the protare (i.e., this) if a_index is 0 and nullptr otherwise.
| a_index | [in] Must always be 0. |
Implements GIDI::Protare.
Definition at line 597 of file GIDI_protare.cc.
|
inlinevirtual |
Returns the type of the protare.
Implements GIDI::Protare.
|
inlinevirtual |
Returns the a_index - 1 reaction.
Implements GIDI::Protare.
|
inlinevirtual |
Returns the a_index - 1 reaction.
Implements GIDI::Protare.
|
virtual |
Returns the (a_index+1)th reaction or nullptr. If the indexed reaction is deactivated or exlucded, a nullptr is returned.
| a_index | [in] The index of the requested reaction. |
| a_settings | [in] Specifies the requested label. |
| a_reactionsToExclude | [in] A list of reaction indices that are to be ignored when calculating the cross section. |
Implements GIDI::Protare.
Definition at line 768 of file GIDI_protare.cc.
|
inline |
|
inline |
| Reaction const * GIDI::ProtareSingle::reactionToMultiGroup | ( | Transporting::MG const & | a_settings, |
| std::size_t | a_index, | ||
| ExcludeReactionsSet const & | a_reactionsToExclude ) const |
Returns a_reaction except when Rutherford scattering present and only nuclear + Coulomb interference is wanted. Otherwise returns m_nuclearPlusCoulombInterferenceOnlyReaction which may be a nullptr.
| a_settings | [in] Specifies user options. |
| a_reaction | [in] Reaction pointer to return if check passes. |
Definition at line 564 of file GIDI_protare.cc.
Referenced by multiGroupAvailableEnergy(), multiGroupAvailableMomentum(), multiGroupAverageEnergy(), multiGroupAverageMomentum(), multiGroupCrossSection(), multiGroupDepositionEnergy(), multiGroupGain(), multiGroupMultiplicity(), multiGroupProductMatrix(), multiGroupQ(), and reaction().
|
inline |
|
inline |
| void GIDI::ProtareSingle::saveAs | ( | std::string const & | a_fileName | ) | const |
Write this to a file in GNDS/XML format.
| a_fileName | [in] Name of file to save XML lines to. |
Definition at line 1536 of file GIDI_protare.cc.
|
inline |
|
inlinevirtual |
Returns the style with label a_label.
Implements GIDI::Protare.
|
inline |
|
inlinevirtual |
Returns the value of the m_styles member.
Implements GIDI::Protare.
Definition at line 4802 of file GIDI.hpp.
Referenced by GIDI::Reaction::calculateMultiGroupData(), MCGIDI::Distributions::IncoherentBoundToFreePhotoAtomicScattering::IncoherentBoundToFreePhotoAtomicScattering(), MCGIDI::Functions::parseMultiplicityFunction1d(), and GIDI::Reaction::recalculateMultiGroupData().
|
inlinevirtual |
Returns a const reference to the m_styles member.
Implements GIDI::Protare.
|
inline |
|
inline |
|
inline |
|
virtual |
Returns a list of all process temperature data. For each temeprature, the labels for its
are returned. If no data are present for a give data type (e.g., gridded cross section, multi-group upscatter), its label is an empty std::string.
Implements GIDI::Protare.
Definition at line 700 of file GIDI_protare.cc.
|
inlinevirtual |
Returns the value of the m_thresholdFactor member.
Implements GIDI::Protare.
|
virtual |
Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.
| 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 1557 of file GIDI_protare.cc.
Referenced by saveAs().
|
virtual |
Re-indexs the reactions in the reactions, orphanProducts and fissionComponents suites.
Implements GIDI::Protare.
Definition at line 798 of file GIDI_protare.cc.
Referenced by MCGIDI::ProtareSingle::ProtareSingle().