EGSnrc C++ class library  Report PIRS-898 (2021)
Iwan Kawrakow, Ernesto Mainegra-Hing, Frederic Tessier, Reid Townson and Blake Walters
Public Attributes | List of all members
EGS_Stack Struct Reference

A structure corresponding to the EGSnrc particle stack common block STACK. More...

#include <egs_interface2.h>

Public Attributes

double E [MXSTACK]
 
EGS_Float x [MXSTACK]
 
EGS_Float y [MXSTACK]
 
EGS_Float z [MXSTACK]
 
EGS_Float u [MXSTACK]
 
EGS_Float v [MXSTACK]
 
EGS_Float w [MXSTACK]
 
EGS_Float dnear [MXSTACK]
 
EGS_Float wt [MXSTACK]
 
EGS_I32 iq [MXSTACK]
 
EGS_I32 ir [MXSTACK]
 
EGS_I32 latch [MXSTACK]
 
EGS_I32 latchi
 
EGS_I32 np
 
EGS_I32 npold
 

Detailed Description

A structure corresponding to the EGSnrc particle stack common block STACK.

Note that the stack size MXSTACK is defined in a file array_sizes.h that must be present in the user code directory. The mortran common block can be accessed via the_stack.

Definition at line 108 of file egs_interface2.h.

Member Data Documentation

◆ E

double EGS_Stack::E[MXSTACK]

Array with particle energies in MeV including rest energy

Examples
tutor7pp.cpp.

Definition at line 110 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ x

EGS_Float EGS_Stack::x[MXSTACK]

Arrays with particle x-positions in cartesian coordinates

Examples
tutor7pp.cpp.

Definition at line 112 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ y

EGS_Float EGS_Stack::y[MXSTACK]

Arrays with particle y-positions in cartesian coordinates

Examples
tutor7pp.cpp.

Definition at line 114 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ z

EGS_Float EGS_Stack::z[MXSTACK]

Arrays with particle z-positions in cartesian coordinates

Definition at line 116 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ u

EGS_Float EGS_Stack::u[MXSTACK]

Arrays with particle x- direction cosines

Examples
tutor7pp.cpp.

Definition at line 118 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ v

EGS_Float EGS_Stack::v[MXSTACK]

Arrays with particle y- direction cosines

Examples
tutor7pp.cpp.

Definition at line 120 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ w

EGS_Float EGS_Stack::w[MXSTACK]

Arrays with particle z- direction cosines

Examples
tutor2pp.cpp, and tutor7pp.cpp.

Definition at line 122 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ dnear

EGS_Float EGS_Stack::dnear[MXSTACK]

Array with nearest distances to a boundary

Definition at line 124 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ wt

EGS_Float EGS_Stack::wt[MXSTACK]

Array with statistical weights

Examples
tutor2pp.cpp, and tutor7pp.cpp.

Definition at line 126 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ iq

EGS_I32 EGS_Stack::iq[MXSTACK]

Particle charges

Examples
tutor7pp.cpp.

Definition at line 128 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ ir

EGS_I32 EGS_Stack::ir[MXSTACK]

◆ latch

EGS_I32 EGS_Stack::latch[MXSTACK]

Latch variables. Can be used to store some additional information about the particles used at run time

Examples
tutor7pp.cpp.

Definition at line 134 of file egs_interface2.h.

Referenced by EGS_SimpleApplication::run(), and EGS_AdvancedApplication::shower().

◆ latchi

EGS_I32 EGS_Stack::latchi

The initial particle latch variable

Definition at line 136 of file egs_interface2.h.

◆ np

EGS_I32 EGS_Stack::np

Number of particles currently on the stack

Examples
tutor2pp.cpp, and tutor7pp.cpp.

Definition at line 138 of file egs_interface2.h.

Referenced by egsHownear(), EGS_SimpleApplication::run(), EGS_AdvancedApplication::shower(), and EGS_AdvancedApplication::startNewParticle().

◆ npold

EGS_I32 EGS_Stack::npold

Number of particles on the stack before the last interaction occured

Examples
tutor7pp.cpp.

Definition at line 140 of file egs_interface2.h.


The documentation for this struct was generated from the following file: