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

#include <GIDI.hpp>

Inheritance diagram for GIDI::Styles::GriddedCrossSection:

Public Member Functions

 GriddedCrossSection (Construction::Settings const &a_construction, HAPI::Node const &a_node, SetupInfo &a_setupInfo, PoPI::Database const &a_pops, GIDI::Suite *a_parent)
 ~GriddedCrossSection ()
PhysicalQuantity const & temperature () const
Grid const & grid () const
void toXMLList (GUPI::WriteInfo &a_writeInfo, std::string const &a_indent) const
Public Member Functions inherited from GIDI::Styles::Base
 Base (HAPI::Node const &a_node, SetupInfo &a_setupInfo, GIDI::Suite *a_parent)
 ~Base ()
std::string const & date () const
std::string const & label () const
std::string const & derivedStyle () const
bool hasDocumentation ()
GUPI::Documentationdocumentation ()
Base const * getDerivedStyle () const
Base const * getDerivedStyle (std::string const &a_moniker) const
std::vector< Base const * > chain () const
bool isStyleInDerivedForm (Base const *a_style) const
std::string baseXMLAttributes (GUPI::WriteInfo &a_writeInfo) 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

This is the griddedCrossSection style class.

Definition at line 3358 of file GIDI.hpp.

Constructor & Destructor Documentation

◆ GriddedCrossSection()

GIDI::Styles::GriddedCrossSection::GriddedCrossSection ( Construction::Settings const & a_construction,
HAPI::Node const & a_node,
SetupInfo & a_setupInfo,
PoPI::Database const & a_pops,
GIDI::Suite * a_parent )
Parameters
a_construction[in] Used to pass user options to the constructor.
a_node[in] The HAPI::Node to be parsed.
a_setupInfo[in] Information create my the Protare constructor to help in parsing.
a_pops[in] A PoPI::Database instance used to get particle indices and possibly other particle information.
a_parent[in] The parent GIDI::Suite.

Definition at line 911 of file GIDI_styles.cc.

911 :
912 Base( a_node, a_setupInfo, a_parent ),
913 m_grid( a_node.child( GIDI_gridChars ), a_setupInfo, a_construction.useSystem_strtod( ) ) {
914
915}
#define GIDI_gridChars
Definition GIDI.hpp:384
Base(HAPI::Node const &a_node, SetupInfo &a_setupInfo, GIDI::Suite *a_parent)

◆ ~GriddedCrossSection()

GIDI::Styles::GriddedCrossSection::~GriddedCrossSection ( )

Definition at line 920 of file GIDI_styles.cc.

920 {
921
922}

Member Function Documentation

◆ grid()

Grid const & GIDI::Styles::GriddedCrossSection::grid ( ) const
inline

◆ temperature()

PhysicalQuantity const & GIDI::Styles::GriddedCrossSection::temperature ( ) const
virtual

Ascends the derivedFrom styles until a temperature is found.

Returns
Returns the temperature associated with this style.

Implements GIDI::Styles::Base.

Definition at line 930 of file GIDI_styles.cc.

930 {
931
932 Base const *style = getDerivedStyle( );
933
934 if( style == nullptr ) throw Exception( "No style with temperature." );
935 return( style->temperature( ) );
936}
Base const * getDerivedStyle() const

◆ toXMLList()

void GIDI::Styles::GriddedCrossSection::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 945 of file GIDI_styles.cc.

945 {
946
947 std::string indent2 = a_writeInfo.incrementalIndent( a_indent );
948
949 a_writeInfo.addNodeStarter( a_indent, moniker( ), baseXMLAttributes( a_writeInfo ) );
950 m_grid.toXMLList( a_writeInfo, indent2 );
951 a_writeInfo.addNodeEnder( moniker( ) );
952}
std::string baseXMLAttributes(GUPI::WriteInfo &a_writeInfo) const
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

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