Geant4 11.4.0
Toolkit for the simulation of the passage of particles through matter
Loading...
Searching...
No Matches
GIDI::Functions::FissionEnergyRelease Class Reference

#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::FissionEnergyRelease:

Public Member Functions

 FissionEnergyRelease (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
 ~FissionEnergyRelease ()
double domainMin () const
double domainMax () const
double evaluate (double a_x1) const
Vector multiGroupQ (LUPI::StatusMessageReporting &a_smr, Transporting::MG const &a_settings, Styles::TemperatureInfo const &a_temperatureInfo) const
Function1dForm const * promptProductKE () const
Function1dFormpromptProductKE ()
Function1dForm const * promptNeutronKE () const
Function1dFormpromptNeutronKE ()
Function1dForm const * delayedNeutronKE () const
Function1dFormdelayedNeutronKE ()
Function1dForm const * promptGammaEnergy () const
Function1dFormpromptGammaEnergy ()
Function1dForm const * delayedGammaEnergy () const
Function1dFormdelayedGammaEnergy ()
Function1dForm const * delayedBetaEnergy () const
Function1dFormdelayedBetaEnergy ()
Function1dForm const * neutrinoEnergy () const
Function1dFormneutrinoEnergy ()
Function1dForm const * nonNeutrinoEnergy () const
Function1dFormnonNeutrinoEnergy ()
Function1dForm const * totalEnergy () const
Function1dFormtotalEnergy ()
void toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent="") const
Public Member Functions inherited from GIDI::Functions::Function1dForm
 Function1dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 Function1dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 Function1dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
 Function1dForm (Function1dForm const &a_form)
 ~Function1dForm ()
Function1dFormoperator= (Function1dForm const &a_rhs)
virtual void mapToXsAndAdd (std::size_t a_offset, std::vector< double > const &a_Xs, std::vector< double > &a_results, double a_scaleFactor) const
virtual XYs1dasXYs1d (bool a_asLinlin, double a_accuray, double a_lowerEps, double a_upperEps) const
virtual void write (FILE *a_file, std::string const &a_format) const
void print (std::string const &a_format) const
Public Member Functions inherited from GIDI::Functions::FunctionForm
 FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 FunctionForm (std::string const &a_moniker, FormType a_type, int a_dimension, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 FunctionForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, int a_dimension, Suite *a_suite=nullptr)
 FunctionForm (FunctionForm const &a_form)
 ~FunctionForm ()
FunctionFormoperator= (FunctionForm const &a_rhs)
int dimension () const
int index () const
double outerDomainValue () const
void setOuterDomainValue (double a_outerDomainValue)
Axes const & axes () const
Axesaxes ()
ptwXY_interpolation interpolation () const
void setInterpolation (ptwXY_interpolation a_interpolation)
std::string interpolationString () const
virtual void toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
void toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Form
 Form (FormType a_type)
 Form (std::string const &a_moniker, FormType a_type, std::string const &a_label)
 Form (HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
 Form (Form const &a_form)
virtual ~Form ()
Formoperator= (Form const &a_rhs)
Suiteparent () const
std::string const & label () const
void setLabel (std::string const &a_label)
virtual std::string actualMoniker () const
std::string const & keyName () const
void setKeyName (std::string const &a_keyName)
std::string const & keyValue () const
virtual void setKeyValue (std::string const &a_keyName) const
FormType type () const
Form const * sibling (std::string a_label) const
GUPI::AncestryfindInAncestry3 (LUPI_maybeUnused std::string const &a_item)
GUPI::Ancestry const * findInAncestry3 (LUPI_maybeUnused std::string const &a_item) const
std::string xlinkItemKey () const
Public Member Functions inherited from GUPI::Ancestry
 Ancestry (std::string const &a_moniker, std::string const &a_attribute="")
virtual ~Ancestry ()
Ancestryoperator= (Ancestry const &a_ancestry)
std::string const & moniker () const
void setMoniker (std::string const &a_moniker)
Ancestryancestor ()
Ancestry const * ancestor () const
void setAncestor (Ancestry *a_ancestor)
std::string attribute () const
Ancestryroot ()
Ancestry const * root () const
bool isChild (Ancestry *a_instance)
bool isParent (Ancestry *a_parent)
bool isRoot () const
AncestryfindInAncestry (std::string const &a_href)
Ancestry const * findInAncestry (std::string const &a_href) const
virtual AncestryfindInAncestry3 (std::string const &a_item)=0
virtual Ancestry const * findInAncestry3 (std::string const &a_item) const =0
virtual LUPI_HOST void serialize (LUPI::DataBuffer &a_buffer, LUPI::DataBuffer::Mode a_mode)
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)

Detailed Description

Class to store GNDS <fissionEnergyRelease> node.

Definition at line 5409 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ FissionEnergyRelease()

GIDI::Functions::FissionEnergyRelease::FissionEnergyRelease ( Construction::Settings const & a_construction,
HAPI::Node const & a_node,
SetupInfo & a_setupInfo,
Suite * a_parent )
Parameters
a_construction[in] Used to pass user options for parsing.
a_node[in] The HAPI::Node to be parsed to construct the instance.
a_setupInfo[in] Information create my the Protare constructor to help in parsing.
a_parent[in] The parent GIDI::Suite.

Definition at line 28 of file GIDI_fissionEnergyReleased.cc.

28 :
29 Function1dForm( a_construction, a_node, a_setupInfo, FormType::fissionEnergyRelease1d, a_parent ) {
30
31 m_promptProductKE = data1dParse( a_construction, a_node.child( GIDI_promptProductKEChars ).first_child( ), a_setupInfo, nullptr );
32 m_promptNeutronKE = data1dParse( a_construction, a_node.child( GIDI_promptNeutronKEChars ).first_child( ), a_setupInfo, nullptr );
33 m_delayedNeutronKE = data1dParse( a_construction, a_node.child( GIDI_delayedNeutronKEChars ).first_child( ), a_setupInfo, nullptr );
34 m_promptGammaEnergy = data1dParse( a_construction, a_node.child( GIDI_promptGammaEnergyChars ).first_child( ), a_setupInfo, nullptr );
35 m_delayedGammaEnergy = data1dParse( a_construction, a_node.child( GIDI_delayedGammaEnergyChars ).first_child( ), a_setupInfo, nullptr );
36 m_delayedBetaEnergy = data1dParse( a_construction, a_node.child( GIDI_delayedBetaEnergyChars ).first_child( ), a_setupInfo, nullptr );
37 m_neutrinoEnergy = data1dParse( a_construction, a_node.child( GIDI_neutrinoEnergyChars ).first_child( ), a_setupInfo, nullptr );
38 m_nonNeutrinoEnergy = data1dParse( a_construction, a_node.child( GIDI_nonNeutrinoEnergyChars ).first_child( ), a_setupInfo, nullptr );
39 m_totalEnergy = data1dParse( a_construction, a_node.child( GIDI_totalEnergyChars ).first_child( ), a_setupInfo, nullptr );
40}
#define GIDI_promptGammaEnergyChars
Definition GIDI.hpp:402
#define GIDI_totalEnergyChars
Definition GIDI.hpp:407
#define GIDI_promptNeutronKEChars
Definition GIDI.hpp:400
#define GIDI_delayedNeutronKEChars
Definition GIDI.hpp:401
#define GIDI_neutrinoEnergyChars
Definition GIDI.hpp:405
#define GIDI_delayedGammaEnergyChars
Definition GIDI.hpp:403
#define GIDI_nonNeutrinoEnergyChars
Definition GIDI.hpp:406
#define GIDI_promptProductKEChars
Definition GIDI.hpp:399
#define GIDI_delayedBetaEnergyChars
Definition GIDI.hpp:404
Function1dForm(std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
Definition GIDI_form.cc:348
Functions::Function1dForm * data1dParse(Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *parent)
@ fissionEnergyRelease1d
Definition GIDI.hpp:125

◆ ~FissionEnergyRelease()

GIDI::Functions::FissionEnergyRelease::~FissionEnergyRelease ( )

Definition at line 45 of file GIDI_fissionEnergyReleased.cc.

45 {
46
47 if( m_promptProductKE != nullptr ) delete m_promptProductKE;
48 if( m_promptNeutronKE != nullptr ) delete m_promptNeutronKE;
49 if( m_delayedNeutronKE != nullptr ) delete m_delayedNeutronKE;
50 if( m_promptGammaEnergy != nullptr ) delete m_promptGammaEnergy;
51 if( m_delayedGammaEnergy != nullptr ) delete m_delayedGammaEnergy;
52 if( m_delayedBetaEnergy != nullptr ) delete m_delayedBetaEnergy;
53 if( m_neutrinoEnergy != nullptr ) delete m_neutrinoEnergy;
54 if( m_nonNeutrinoEnergy != nullptr ) delete m_nonNeutrinoEnergy;
55 if( m_totalEnergy != nullptr ) delete m_totalEnergy;
56}

Member Function Documentation

◆ delayedBetaEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::delayedBetaEnergy ( )
inline

Returns the value of the m_delayedBetaEnergy member.

Definition at line 5445 of file GIDI.hpp.

◆ delayedBetaEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::delayedBetaEnergy ( ) const
inline

Returns the value of the m_delayedBetaEnergy member.

Definition at line 5444 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ delayedGammaEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::delayedGammaEnergy ( )
inline

Returns the value of the m_delayedGammaEnergy member.

Definition at line 5443 of file GIDI.hpp.

◆ delayedGammaEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::delayedGammaEnergy ( ) const
inline

Returns the value of the m_delayedGammaEnergy member.

Definition at line 5442 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ delayedNeutronKE() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::delayedNeutronKE ( )
inline

Returns the value of the m_delayedNeutronKE member.

Definition at line 5439 of file GIDI.hpp.

◆ delayedNeutronKE() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::delayedNeutronKE ( ) const
inline

Returns the value of the m_delayedNeutronKE member.

Definition at line 5438 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ domainMax()

double GIDI::Functions::FissionEnergyRelease::domainMax ( ) const
inlinevirtual

Returns the maximum domain value for the energy released.

Implements GIDI::Functions::FunctionForm.

Definition at line 5429 of file GIDI.hpp.

◆ domainMin()

double GIDI::Functions::FissionEnergyRelease::domainMin ( ) const
inlinevirtual

Returns the minimum domain value for the energy released.

Implements GIDI::Functions::FunctionForm.

Definition at line 5428 of file GIDI.hpp.

◆ evaluate()

double GIDI::Functions::FissionEnergyRelease::evaluate ( double a_x1) const
inlinevirtual

Returns the value of m_nonNeutrinoEnergy evaluated at a_x1.

Implements GIDI::Functions::Function1dForm.

Definition at line 5430 of file GIDI.hpp.

◆ multiGroupQ()

Vector GIDI::Functions::FissionEnergyRelease::multiGroupQ ( LUPI::StatusMessageReporting & a_smr,
Transporting::MG const & a_settings,
Styles::TemperatureInfo const & a_temperatureInfo ) const

Returns the multi-group Q-value.

Parameters
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.
Returns
Multi-group Q-value.

Definition at line 68 of file GIDI_fissionEnergyReleased.cc.

68 {
69
70 Vector vector( 0 );
71
72 if( a_settings.delayedNeutrons( ) == Transporting::DelayedNeutrons::on ) {
73 Gridded1d const *gridded1d = dynamic_cast<Gridded1d const *>( m_delayedNeutronKE );
74
75 if( gridded1d != nullptr ) vector += gridded1d->data( );
76
77 gridded1d = dynamic_cast<Gridded1d const *>( m_delayedGammaEnergy );
78 if( gridded1d != nullptr ) vector += gridded1d->data( );
79
80 gridded1d = dynamic_cast<Gridded1d const *>( m_delayedBetaEnergy );
81 if( gridded1d != nullptr ) vector += gridded1d->data( );
82 }
83
84 return( vector );
85}

Referenced by GIDI::FissionFragmentData::multiGroupQ().

◆ neutrinoEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::neutrinoEnergy ( )
inline

Returns the value of the m_neutrinoEnergy member.

Definition at line 5447 of file GIDI.hpp.

◆ neutrinoEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::neutrinoEnergy ( ) const
inline

Returns the value of the m_neutrinoEnergy member.

Definition at line 5446 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ nonNeutrinoEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::nonNeutrinoEnergy ( )
inline

Returns the value of the m_neutrinoEnergy member.

Definition at line 5449 of file GIDI.hpp.

◆ nonNeutrinoEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::nonNeutrinoEnergy ( ) const
inline

Returns the value of the m_neutrinoEnergy member.

Definition at line 5448 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ promptGammaEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::promptGammaEnergy ( )
inline

Returns the value of the m_promptGammaEnergy member.

Definition at line 5441 of file GIDI.hpp.

◆ promptGammaEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::promptGammaEnergy ( ) const
inline

Returns the value of the m_promptGammaEnergy member.

Definition at line 5440 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ promptNeutronKE() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::promptNeutronKE ( )
inline

Returns the value of the m_promptNeutronKE member.

Definition at line 5437 of file GIDI.hpp.

◆ promptNeutronKE() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::promptNeutronKE ( ) const
inline

Returns the value of the m_promptNeutronKE member.

Definition at line 5436 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ promptProductKE() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::promptProductKE ( )
inline

Returns the value of the m_promptProductKE member.

Definition at line 5435 of file GIDI.hpp.

◆ promptProductKE() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::promptProductKE ( ) const
inline

Returns the value of the m_promptProductKE member.

Definition at line 5434 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ totalEnergy() [1/2]

Function1dForm * GIDI::Functions::FissionEnergyRelease::totalEnergy ( )
inline

Returns the value of the m_totalEnergy member.

Definition at line 5451 of file GIDI.hpp.

◆ totalEnergy() [2/2]

Function1dForm const * GIDI::Functions::FissionEnergyRelease::totalEnergy ( ) const
inline

Returns the value of the m_totalEnergy member.

Definition at line 5450 of file GIDI.hpp.

Referenced by GIDI::FissionFragmentData::calculateMultiGroupData().

◆ toXMLList()

void GIDI::Functions::FissionEnergyRelease::toXMLList ( GUPI::WriteInfo & a_writeInfo,
std::string const & a_indent = "" ) const
virtual

Fills the argument a_writeInfo with the XML lines that represent this. Recursively enters each sub-node.

Parameters
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 94 of file GIDI_fissionEnergyReleased.cc.

94 {
95
96 std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
97
98 a_writeInfo.addNodeStarter( a_indent, moniker( ), a_writeInfo.addAttribute( GIDI_labelChars, label( ) ) );
99
100 energyReleaseToXMLList( a_writeInfo, GIDI_promptProductKEChars, indent2, m_promptProductKE );
101 energyReleaseToXMLList( a_writeInfo, GIDI_promptNeutronKEChars, indent2, m_promptNeutronKE );
102 energyReleaseToXMLList( a_writeInfo, GIDI_delayedNeutronKEChars, indent2, m_delayedNeutronKE );
103 energyReleaseToXMLList( a_writeInfo, GIDI_promptGammaEnergyChars, indent2, m_promptGammaEnergy );
104 energyReleaseToXMLList( a_writeInfo, GIDI_delayedGammaEnergyChars, indent2, m_delayedGammaEnergy );
105 energyReleaseToXMLList( a_writeInfo, GIDI_delayedBetaEnergyChars, indent2, m_delayedBetaEnergy );
106 energyReleaseToXMLList( a_writeInfo, GIDI_neutrinoEnergyChars, indent2, m_neutrinoEnergy );
107 energyReleaseToXMLList( a_writeInfo, GIDI_nonNeutrinoEnergyChars, indent2, m_nonNeutrinoEnergy );
108 energyReleaseToXMLList( a_writeInfo, GIDI_totalEnergyChars, indent2, m_totalEnergy );
109
110 a_writeInfo.addNodeEnder( moniker( ) );
111}
#define GIDI_labelChars
Definition GIDI.hpp:438
std::string const & label() const
Definition GIDI.hpp:658
std::string const & moniker() const
Definition GUPI.hpp:102
void addNodeEnder(std::string const &a_moniker)
Definition GUPI.hpp:59
std::string incrementalIndent(std::string const &indent)
Definition GUPI.hpp:52
void addNodeStarter(std::string const &indent, std::string const &a_moniker, std::string const &a_attributes="")
Definition GUPI.hpp:55
std::string addAttribute(std::string const &a_name, std::string const &a_value) const
Definition GUPI.hpp:60

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