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

#include <GIDI.hpp>

Inheritance diagram for GIDI::Functions::MadlandNix2d:

Public Member Functions

 MadlandNix2d (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *a_parent)
 ~MadlandNix2d ()
double EFL () const
double EFH () const
Function1dForm const * T_M () const
double domainMin () const
double domainMax () const
double evaluate (double a_x2, double a_x1) const
void toXMLList_func (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent, bool a_embedded, bool a_inRegions) const
Public Member Functions inherited from GIDI::Functions::Function2dForm
 Function2dForm (std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 Function2dForm (std::string const &a_moniker, FormType a_type, Axes const &a_axes, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
 Function2dForm (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, FormType a_type, Suite *a_suite=nullptr)
 Function2dForm (Function2dForm const &a_form)
 ~Function2dForm ()
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
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 for the GNDS <MadlandNix> node.

Definition at line 1768 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ MadlandNix2d()

GIDI::Functions::MadlandNix2d::MadlandNix2d ( 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 a MadlandNix2d instance.
a_setupInfo[in] Information create my the Protare constructor to help in parsing.
a_parent[in] The parent GIDI::Suite.

Definition at line 372 of file GIDI_energyFunctions2d.cc.

372 :
373 Function2dForm( a_construction, a_node, a_setupInfo, FormType::MadlandNix2d, a_parent ),
374 m_EFL( a_node.child( GIDI_EFL_Chars ), a_setupInfo ),
375 m_EFH( a_node.child( GIDI_EFH_Chars ), a_setupInfo ),
376 m_T_M( data1dParse( a_construction, a_node.child( GIDI_T_M_Chars ).first_child( ), a_setupInfo, nullptr ) ) {
377
378}
#define GIDI_EFL_Chars
Definition GIDI.hpp:394
#define GIDI_T_M_Chars
Definition GIDI.hpp:396
#define GIDI_EFH_Chars
Definition GIDI.hpp:395
Function2dForm(std::string const &a_moniker, FormType a_type, ptwXY_interpolation a_interpolation, int a_index, double a_outerDomainValue)
Definition GIDI_form.cc:476
Functions::Function1dForm * data1dParse(Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, Suite *parent)

Referenced by MadlandNix2d().

◆ ~MadlandNix2d()

GIDI::Functions::MadlandNix2d::~MadlandNix2d ( )

Definition at line 383 of file GIDI_energyFunctions2d.cc.

383 {
384
385 delete m_T_M;
386}

Member Function Documentation

◆ domainMax()

double GIDI::Functions::MadlandNix2d::domainMax ( ) const
virtual

Returns the domain maximum for the instance.

Returns
The domain maximum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 405 of file GIDI_energyFunctions2d.cc.

405 {
406
407 return( m_T_M->domainMax( ) );
408}

◆ domainMin()

double GIDI::Functions::MadlandNix2d::domainMin ( ) const
virtual

Returns the domain minimum for the instance.

Returns
The domain minimum for the instance.

Implements GIDI::Functions::FunctionForm.

Definition at line 394 of file GIDI_energyFunctions2d.cc.

394 {
395
396 return( m_T_M->domainMin( ) );
397}

◆ EFH()

double GIDI::Functions::MadlandNix2d::EFH ( ) const
inline

Returns the GNDS EFH value for this.

Definition at line 1780 of file GIDI.hpp.

◆ EFL()

double GIDI::Functions::MadlandNix2d::EFL ( ) const
inline

Returns the GNDS EFL value for this.

Definition at line 1779 of file GIDI.hpp.

◆ evaluate()

double GIDI::Functions::MadlandNix2d::evaluate ( double a_x2,
double a_x1 ) const
virtual

Returns the value of the function evaluated at the specified projectile's energy and product's energy. Currently not implemented.

Parameters
a_x2[in] The projectile's energy.
a_x1[in] The product's energy.
Returns
The value of the function evaluated at a_x2, and a_x1.

Implements GIDI::Functions::Function2dForm.

Definition at line 419 of file GIDI_energyFunctions2d.cc.

419 {
420
421 throw Exception( "MadlandNix2d::evaluate: not implemented." );
422}

◆ T_M()

Function1dForm const * GIDI::Functions::MadlandNix2d::T_M ( ) const
inline

Returns the value of the m_T_M member.

Definition at line 1781 of file GIDI.hpp.

◆ toXMLList_func()

void GIDI::Functions::MadlandNix2d::toXMLList_func ( GUPI::WriteInfo & a_writeInfo,
std::string const & a_indent,
bool a_embedded,
bool a_inRegions ) 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.
a_embedded[in] If true, this function is embedded in a higher dimensional function.
a_inRegions[in] This is not used in this method.

Reimplemented from GIDI::Functions::FunctionForm.

Definition at line 433 of file GIDI_energyFunctions2d.cc.

433 {
434
435 std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
436 std::string attributes;
437
438 a_writeInfo.addNodeStarter( a_indent, moniker( ), attributes );
439
440 m_EFL.toXMLList( a_writeInfo, indent2 );
441 m_EFH.toXMLList( a_writeInfo, indent2 );
442 energy2dToXMLList( a_writeInfo, GIDI_T_M_Chars, indent2, m_T_M );
443 a_writeInfo.addNodeEnder( moniker( ) );
444}
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
void energy2dToXMLList(GUPI::WriteInfo &a_writeInfo, std::string const &a_moniker, std::string const &a_indent, Functions::Function1dForm *a_function)
Definition GIDI_misc.cc:442

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