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_Epcont Struct Reference

A structure corresponding to the EPCONT common block. More...

#include <egs_interface2.h>

Public Attributes

double edep
 
double edep_local
 
EGS_Float tstep
 
EGS_Float tustep
 
EGS_Float ustep
 
EGS_Float tvstep
 
EGS_Float vstep
 
EGS_Float rhof
 
EGS_Float eold
 
EGS_Float enew
 
EGS_Float eke
 
EGS_Float elke
 
EGS_Float gle
 
EGS_Float e_range
 
EGS_Float x_final
 
EGS_Float y_final
 
EGS_Float z_final
 
EGS_Float u_final
 
EGS_Float v_final
 
EGS_Float w_final
 
EGS_I32 idisc
 
EGS_I32 irold
 
EGS_I32 irnew
 
EGS_I32 iausfl [MXAUS]
 

Detailed Description

A structure corresponding to the EPCONT common block.

The EPCONT common block contains various variables of interest for user scoring and for interacting with the user geometry

Definition at line 231 of file egs_interface2.h.

Member Data Documentation

double EGS_Epcont::edep

Energy being deposited locally (may be several depositions)

Examples:
tutor2pp.cpp, and tutor7pp.cpp.

Definition at line 233 of file egs_interface2.h.

double EGS_Epcont::edep_local

A single sub-threshold energy deposition

Definition at line 235 of file egs_interface2.h.

EGS_Float EGS_Epcont::tstep

Step length to an interaction

Definition at line 237 of file egs_interface2.h.

EGS_Float EGS_Epcont::tustep

Step length after step-size restrictions

Definition at line 239 of file egs_interface2.h.

EGS_Float EGS_Epcont::ustep

Straight line distance between initial and final position without geometry constraints

Definition at line 242 of file egs_interface2.h.

Referenced by egsHowfar().

EGS_Float EGS_Epcont::tvstep

Curved transport distance after geometry constraints

Definition at line 244 of file egs_interface2.h.

EGS_Float EGS_Epcont::vstep

Straight line transport distance after geometry constraints

Definition at line 246 of file egs_interface2.h.

EGS_Float EGS_Epcont::rhof

Ratio of mass density in current region to the default mass density of the medium filling the region

Definition at line 249 of file egs_interface2.h.

EGS_Float EGS_Epcont::eold

Old particle energy

Definition at line 251 of file egs_interface2.h.

EGS_Float EGS_Epcont::enew

New particle energy

Definition at line 253 of file egs_interface2.h.

EGS_Float EGS_Epcont::eke

Electron kinetic energy

Definition at line 255 of file egs_interface2.h.

EGS_Float EGS_Epcont::elke

ln(eke)

Definition at line 257 of file egs_interface2.h.

EGS_Float EGS_Epcont::gle

ln(photon energy)

Definition at line 259 of file egs_interface2.h.

EGS_Float EGS_Epcont::e_range

Electron range to AE in the current medium

Definition at line 261 of file egs_interface2.h.

EGS_Float EGS_Epcont::x_final

Position of the particle after the step

Definition at line 263 of file egs_interface2.h.

EGS_Float EGS_Epcont::u_final

Direction of the particle after the step, only set for electrons/positrons

Definition at line 266 of file egs_interface2.h.

EGS_I32 EGS_Epcont::idisc

Should the particle be discarded ?

  • 0 means no discard
  • >0 means discard immediately
  • <0 means discard after the step.

Typically set by the geometry routines.

Definition at line 274 of file egs_interface2.h.

Referenced by egsHowfar(), and egsStartParticle().

EGS_I32 EGS_Epcont::irold

Old geometry region

Definition at line 276 of file egs_interface2.h.

EGS_I32 EGS_Epcont::irnew

New geometry region

Definition at line 278 of file egs_interface2.h.

Referenced by egsHowfar().

EGS_I32 EGS_Epcont::iausfl[MXAUS]

Array of flags for calls to ausgab()

Definition at line 280 of file egs_interface2.h.

Referenced by EGS_AdvancedApplication::setAusgabCall().


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