Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
GIDI::Protare Class Referenceabstract

#include <GIDI.hpp>

Inheritance diagram for GIDI::Protare:

Public Member Functions

 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 ProtareType protareType () const =0
virtual bool isTNSL_ProtareSingle () const
virtual std::size_t numberOfProtares () const =0
virtual ProtareSingle * protare (std::size_t a_index)=0
virtual ProtareSingle const * protare (std::size_t a_index) const =0
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 int numberOfLazyParsingHelperForms () const =0
virtual int numberOfLazyParsingHelperFormsReplaced () const =0
virtual double thresholdFactor () const =0
virtual Documentation_1_10::Suite & documentations ()=0
virtual Styles::Base & style (std::string const &a_label)=0
virtual Styles::Suite & styles ()=0
virtual Styles::Suite const & styles () const =0
virtual int intid (std::string const &a_id) const =0
virtual void productIDs (std::set< std::string > &a_ids, Transporting::Particles const &a_particles, bool a_transportablesOnly) const =0
virtual int maximumLegendreOrder (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const =0
virtual Styles::TemperatureInfos temperatures () const =0
virtual std::size_t numberOfReactions () const =0
virtual Reaction * reaction (std::size_t a_index)=0
virtual Reaction const * reaction (std::size_t a_index) const =0
virtual Reaction const * reaction (std::size_t a_index, Transporting::MG const &a_settings, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const =0
virtual std::size_t numberOfOrphanProducts () const =0
virtual Reaction * orphanProduct (std::size_t a_index)=0
virtual Reaction const * orphanProduct (std::size_t a_index) const =0
virtual void updateReactionIndices (std::size_t a_offset) const =0
virtual bool hasFission () const =0
virtual bool isDelayedFissionNeutronComplete () const =0
virtual GUPI::Ancestry * findInAncestry3 (std::string const &a_item)=0
virtual GUPI::Ancestry const * findInAncestry3 (std::string const &a_item) const =0
virtual std::vector< double > groupBoundaries (Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, std::string const &a_productID) const =0
virtual Vector multiGroupInverseSpeed (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo) const =0
virtual 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 =0
virtual 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 =0
virtual 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 =0
virtual Vector multiGroupFissionNeutronMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const =0
virtual Vector multiGroupFissionGammaMultiplicity (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const =0
virtual 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 =0
virtual 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 =0
virtual 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 =0
virtual Vector multiGroupAvailableEnergy (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const =0
virtual 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 =0
virtual 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 =0
virtual Vector multiGroupAvailableMomentum (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo, ExcludeReactionsSet const &a_reactionsToExclude=ExcludeReactionsSet {}) const =0
virtual 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 =0
virtual 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 =0
virtual 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 =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)
virtual stringAndDoublePairs muCutoffForCoulombPlusNuclearElastic () const =0
virtual DelayedNeutronProducts delayedNeutronProducts () const =0
virtual void incompleteParticles (Transporting::Settings const &a_settings, std::set< std::string > &a_incompleteParticles) const =0
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
virtual void toXMLList (WriteInfo &a_writeInfo, std::string const &a_indent="") const
void printXML () const

Protected Member Functions

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)

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

Base class for the protare sub-classes.

Definition at line 4526 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ Protare()

GIDI::Protare::Protare ( )

Base Protare constructor.

Definition at line 29 of file GIDI_protare.cc.

29 :
30 GUPI::Ancestry( "" ),
31 m_projectile( "", "", -1.0 ),
32 m_target( "", "", -1.0 ),
33 m_GNDS_target( "", "", -1.0 ) {
34
35}

Referenced by GIDI::ProtareComposite::append(), and GIDI::ProtareSingle::ProtareSingle().

◆ ~Protare()

GIDI::Protare::~Protare ( )

Definition at line 40 of file GIDI_protare.cc.

40 {
41
42}

Member Function Documentation

◆ delayedNeutronProducts()

virtual DelayedNeutronProducts GIDI::Protare::delayedNeutronProducts ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ documentations()

virtual Documentation_1_10::Suite & GIDI::Protare::documentations ( )
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ evaluation()

virtual std::string const & GIDI::Protare::evaluation ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ fileName()

virtual std::string const & GIDI::Protare::fileName ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ findInAncestry3() [1/2]

virtual GUPI::Ancestry const * GIDI::Protare::findInAncestry3 ( std::string const & a_item) const
pure virtual

Implements GUPI::Ancestry.

Implemented in GIDI::ProtareSingle.

◆ findInAncestry3() [2/2]

virtual GUPI::Ancestry * GIDI::Protare::findInAncestry3 ( std::string const & a_item)
pure virtual

Used 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.

Implemented in GIDI::ProtareSingle.

◆ formatVersion()

virtual LUPI::FormatVersion const & GIDI::Protare::formatVersion ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ GNDS_target()

ParticleInfo const & GIDI::Protare::GNDS_target ( ) const
inline

Returns the value of the m_GNDS_target member.

Definition at line 4547 of file GIDI.hpp.

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

◆ groupBoundaries()

virtual std::vector< double > GIDI::Protare::groupBoundaries ( Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
std::string const & a_productID ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ hasFission()

virtual bool GIDI::Protare::hasFission ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ incompleteParticles()

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

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ initialize()

void GIDI::Protare::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 )
protected

Called by the constructs. This method does most of the parsing.

Parameters
a_node[in] The protare (i.e., reactionSuite) node to be parsed and used to construct a Protare.
a_setupInfo[in] Information create my the Protare constructor to help in parsing.
a_pops[in] A PoPs 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.
a_targetRequiredInGlobalPoPs[in] If true, the target is required to be in a_pops.
a_requiredInPoPs[in] If true, particle is required to be in a_pops.

Definition at line 55 of file GIDI_protare.cc.

56 {
57
58 setMoniker( a_node.name( ) );
59
60 std::string projectileID = a_node.attribute_as_string( GIDI_projectileChars );
61 m_projectile = ParticleInfo( projectileID, a_pops, a_internalPoPs, a_requiredInPoPs );
62
63 std::string targetID = a_node.attribute_as_string( GIDI_targetChars );
64 m_GNDS_target = ParticleInfo( targetID, a_pops, a_internalPoPs, a_targetRequiredInGlobalPoPs && a_requiredInPoPs );
65
66 auto iter = a_setupInfo.m_particleSubstitution->find( m_GNDS_target.ID( ) );
67 if( iter != a_setupInfo.m_particleSubstitution->end( ) ) {
68 m_target = iter->second; }
69 else {
70 m_target = m_GNDS_target;
71 }
72}
GIDI_projectileChars
#define GIDI_projectileChars
Definition GIDI.hpp:413
GIDI_targetChars
#define GIDI_targetChars
Definition GIDI.hpp:414
GUPI::Ancestry::setMoniker
void setMoniker(std::string const &a_moniker)
Definition GUPI.hpp:103

◆ intid()

virtual int GIDI::Protare::intid ( std::string const & a_id) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ isDelayedFissionNeutronComplete()

virtual bool GIDI::Protare::isDelayedFissionNeutronComplete ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ isTNSL_ProtareSingle()

virtual bool GIDI::Protare::isTNSL_ProtareSingle ( ) const
inlinevirtual

Returns true if the instance is a ProtareSingle instance with only TNSL data and false otherwise.

Reimplemented in GIDI::ProtareSingle.

Definition at line 4550 of file GIDI.hpp.

◆ libraries()

virtual std::vector< std::string > GIDI::Protare::libraries ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ maximumLegendreOrder()

virtual int GIDI::Protare::maximumLegendreOrder ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
std::string const & a_productID ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ muCutoffForCoulombPlusNuclearElastic()

virtual stringAndDoublePairs GIDI::Protare::muCutoffForCoulombPlusNuclearElastic ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupAvailableEnergy()

virtual Vector GIDI::Protare::multiGroupAvailableEnergy ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
ExcludeReactionsSet const & a_reactionsToExclude = ExcludeReactionsSet {} ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupAvailableMomentum()

virtual Vector GIDI::Protare::multiGroupAvailableMomentum ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
ExcludeReactionsSet const & a_reactionsToExclude = ExcludeReactionsSet {} ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupAverageEnergy()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupAverageMomentum()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupCrossSection()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupDepositionEnergy()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupDepositionMomentum()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupFissionGammaMultiplicity()

virtual Vector GIDI::Protare::multiGroupFissionGammaMultiplicity ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
ExcludeReactionsSet const & a_reactionsToExclude = ExcludeReactionsSet {} ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupFissionMatrix()

virtual Matrix GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupFissionNeutronMultiplicity()

virtual Vector GIDI::Protare::multiGroupFissionNeutronMultiplicity ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo,
ExcludeReactionsSet const & a_reactionsToExclude = ExcludeReactionsSet {} ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupGain()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupInverseSpeed()

virtual Vector GIDI::Protare::multiGroupInverseSpeed ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupMultiplicity()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupProductMatrix()

virtual Matrix GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupQ()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ multiGroupTransportCorrection()

virtual Vector GIDI::Protare::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
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ numberOfLazyParsingHelperForms()

virtual int GIDI::Protare::numberOfLazyParsingHelperForms ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ numberOfLazyParsingHelperFormsReplaced()

virtual int GIDI::Protare::numberOfLazyParsingHelperFormsReplaced ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ numberOfOrphanProducts()

virtual std::size_t GIDI::Protare::numberOfOrphanProducts ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ numberOfProtares()

virtual std::size_t GIDI::Protare::numberOfProtares ( ) const
pure virtual

Returns the number of protares contained in this.

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ numberOfReactions()

virtual std::size_t GIDI::Protare::numberOfReactions ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by GIDI::excludeReactionsSetAdjust(), and reactionIndicesMatchingENDLCValues().

◆ orphanProduct() [1/2]

virtual Reaction const * GIDI::Protare::orphanProduct ( std::size_t a_index) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ orphanProduct() [2/2]

virtual Reaction * GIDI::Protare::orphanProduct ( std::size_t a_index)
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ productIDs()

virtual void GIDI::Protare::productIDs ( std::set< std::string > & a_ids,
Transporting::Particles const & a_particles,
bool a_transportablesOnly ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ projectile()

ParticleInfo const & GIDI::Protare::projectile ( ) const
inline

Returns the value of the m_projectile member.

Definition at line 4541 of file GIDI.hpp.

Referenced by GIDI::Transporting::MG::form(), GIDI::ProtareSingle::multiGroupGain(), MCGIDI::MultiGroupHash::MultiGroupHash(), GIDI::ProtareSingle::multiGroupTransportCorrection(), GIDI::ProtareTNSL::multiGroupTransportCorrection(), GIDI::Product::Product(), GIDI::Map::Map::protare(), GIDI::Reaction::recalculateMultiGroupData(), and GIDI::ProtareSingle::toXMLList().

◆ projectileFrame()

virtual Frame GIDI::Protare::projectileFrame ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ protare() [1/2]

virtual ProtareSingle const * GIDI::Protare::protare ( std::size_t a_index) const
pure virtual

Returns the a_index - 1 Protare contained in this.

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ protare() [2/2]

virtual ProtareSingle * GIDI::Protare::protare ( std::size_t a_index)
pure virtual

Returns the a_index - 1 Protare contained in this.

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by G4GIDI::readTarget().

◆ protareType()

virtual ProtareType GIDI::Protare::protareType ( ) const
pure virtual

Returns the type of the protare.

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by MCGIDI::protareFromGIDIProtare().

◆ reaction() [1/3]

virtual Reaction const * GIDI::Protare::reaction ( std::size_t a_index) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ reaction() [2/3]

virtual Reaction * GIDI::Protare::reaction ( std::size_t a_index)
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by reactionIndicesMatchingENDLCValues().

◆ reaction() [3/3]

virtual Reaction const * GIDI::Protare::reaction ( std::size_t a_index,
Transporting::MG const & a_settings,
ExcludeReactionsSet const & a_reactionsToExclude = ExcludeReactionsSet {} ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ reactionIndicesMatchingENDLCValues()

ExcludeReactionsSet GIDI::Protare::reactionIndicesMatchingENDLCValues ( std::set< int > const & a_CValues,
bool a_checkActiveState = true )

Returns a list of all reaction indices whose ENDL C value is in the set a_CValues.

Parameters
a_CValues[in] A list of ENDL C values.
a_checkActiveState[in] If true, all reactions whose active state is false are not included in the returned set even if their CValue match on in the list.
Returns
The list of reaction indices.

Definition at line 126 of file GIDI_protare.cc.

126 {
127
128 ExcludeReactionsSet indices;
129
130 for( std::size_t i1 = 0; i1 < numberOfReactions( ); ++i1 ) {
131 Reaction *reaction1 = reaction( i1 );
132
133 if( a_checkActiveState && !reaction1->active( ) ) continue;
134 if( a_CValues.find( reaction1->ENDL_C( ) ) != a_CValues.end( ) ) indices.insert( i1 );
135 }
136
137 return( indices );
138}
GIDI::Protare::numberOfReactions
virtual std::size_t numberOfReactions() const =0
GIDI::Protare::reaction
virtual Reaction * reaction(std::size_t a_index)=0
GIDI::ExcludeReactionsSet
std::set< std::size_t > ExcludeReactionsSet
Definition GIDI.hpp:47

◆ realFileName()

virtual std::string const & GIDI::Protare::realFileName ( std::size_t a_index = 0) const
pure virtual

Implemented in GIDI::ProtareComposite, and GIDI::ProtareTNSL.

◆ setProjectile()

void GIDI::Protare::setProjectile ( ParticleInfo const & a_projectile)
inline

Sets m_projectile to a_projectile.

Definition at line 4542 of file GIDI.hpp.

Referenced by GIDI::Map::Map::protare(), and GIDI::ProtareSingle::ProtareSingle().

◆ setTarget()

void GIDI::Protare::setTarget ( ParticleInfo const & a_target)
inline

Sets m_target to a_target and m_GNDS_target if it is an empty string.

Definition at line 4544 of file GIDI.hpp.

Referenced by GIDI::Map::Map::protare(), and GIDI::ProtareSingle::ProtareSingle().

◆ style()

virtual Styles::Base & GIDI::Protare::style ( std::string const & a_label)
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ styles() [1/2]

virtual Styles::Suite const & GIDI::Protare::styles ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

◆ styles() [2/2]

virtual Styles::Suite & GIDI::Protare::styles ( )
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by GIDI::Transporting::Particles::process(), GIDI::Reaction::Reaction(), and G4GIDI::readTarget().

◆ target()

ParticleInfo const & GIDI::Protare::target ( ) const
inline

Returns the value of the m_target member.

Definition at line 4543 of file GIDI.hpp.

Referenced by GIDI::Transporting::MG::form(), GIDI::GRIN::GRIN_continuumGammas::GRIN_continuumGammas(), and GIDI::Map::Map::protare().

◆ temperatures()

virtual Styles::TemperatureInfos GIDI::Protare::temperatures ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by G4GIDI::readTarget().

◆ thresholdFactor()

virtual double GIDI::Protare::thresholdFactor ( ) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

Referenced by GIDI::Reaction::Reaction().

◆ TNSL_crossSectionSumCorrection() [1/3]

virtual void GIDI::Protare::TNSL_crossSectionSumCorrection ( std::string const & a_label,
Functions::XYs1d & a_crossSectionSum )
virtual

Reimplemented in GIDI::ProtareTNSL.

Referenced by GIDI::ProtareTNSL::TNSL_crossSectionSumCorrection().

◆ TNSL_crossSectionSumCorrection() [2/3]

virtual void GIDI::Protare::TNSL_crossSectionSumCorrection ( std::string const & a_label,
Functions::Ys1d & a_crossSectionSum )
virtual

Reimplemented in GIDI::ProtareTNSL.

◆ TNSL_crossSectionSumCorrection() [3/3]

virtual void GIDI::Protare::TNSL_crossSectionSumCorrection ( std::string const & a_label,
Vector & a_crossSectionSum )
virtual

Reimplemented in GIDI::ProtareTNSL.

◆ updateReactionIndices()

virtual void GIDI::Protare::updateReactionIndices ( std::size_t a_offset) const
pure virtual

Implemented in GIDI::ProtareComposite, GIDI::ProtareSingle, and GIDI::ProtareTNSL.

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