EnergyScoringStats Class Reference

a class to use for scoring information about total energy initialzed, escaping sources etc More...

#include <spec_scoring.h>

Inheritance diagram for EnergyScoringStats:

Collaboration diagram for EnergyScoringStats:

Public Member Functions
	EnergyScoringStats (Publisher *publisher)
void	scoreEnergyInitialized (EGS_Float E)
	Needed for loading data from egsdat file.
EGS_Float	escapingSourcesRatio ()
	return the ratio of energy escaping the source to total energy initialized
EGS_Float	escapingGeomRatio ()
	return the ratio of energy escaping the simulation geometry to total energy initialized
EGS_Float	totalEnergyInitialized ()
	returns the total energy initialized
EGS_Float	energyEscapingSources ()
	returns the total paticle energy escaping source geometry
EGS_Float	energyEscapingGeom ()
	returns the total energy of particles escaping simulation geometry
void	update (EB_Message message, void *particle)
	delegate messages to appropriate scoring functions
void	outputResults ()
	write results to console
int	outputData (ostream *ofile)
int	readData (istream *ifile)
void	resetCounter ()
int	addState (istream &data)
Public Member Functions inherited from Subscriber
virtual	~Subscriber ()

Private Member Functions
EGS_Float	getParticleEnergy (const EGS_Particle *p, bool subtractRM=true)
void	scoreParticleInitialized (EGS_Particle *p)
	add energy from initial particle to total
void	scoreParticleEscapingSource (EGS_Particle *p)
	add energy from a particle escaping a source to the total
void	scoreParticleEscapingGeom (EGS_Particle *p)
	add energy from a escaping simulation geometry to the total

Private Attributes
EGS_Float	total_energy_initialized
	total energy of particles initialized so far
EGS_Float	energy_escaping_sources
	total energy of particles escaping the source geometry note: doesn't currently exclude particles reentering the source geometry and then escaping again
EGS_Float	energy_escaping_geom
	total energy of particles escaping the simulation geometry

Detailed Description

a class to use for scoring information about total energy initialzed, escaping sources etc

Definition at line 57 of file spec_scoring.h.

Constructor & Destructor Documentation

EnergyScoringStats()

EnergyScoringStats::EnergyScoringStats ( Publisher *  publisher )

inline

Definition at line 94 of file spec_scoring.h.

Member Function Documentation

addState()

int EnergyScoringStats::addState ( istream &  data )

inline

Definition at line 205 of file spec_scoring.h.

energyEscapingGeom()

EGS_Float EnergyScoringStats::energyEscapingGeom ( )

inline

returns the total energy of particles escaping simulation geometry

Definition at line 141 of file spec_scoring.h.

energyEscapingSources()

EGS_Float EnergyScoringStats::energyEscapingSources ( )

inline

returns the total paticle energy escaping source geometry

Definition at line 136 of file spec_scoring.h.

escapingGeomRatio()

EGS_Float EnergyScoringStats::escapingGeomRatio ( )

inline

return the ratio of energy escaping the simulation geometry to total energy initialized

Definition at line 122 of file spec_scoring.h.

escapingSourcesRatio()

EGS_Float EnergyScoringStats::escapingSourcesRatio ( )

inline

return the ratio of energy escaping the source to total energy initialized

Definition at line 112 of file spec_scoring.h.

getParticleEnergy()

EGS_Float EnergyScoringStats::getParticleEnergy ( const EGS_Particle *  p, bool  subtractRM = true  )

inlineprivate

Definition at line 66 of file spec_scoring.h.

outputData()

int EnergyScoringStats::outputData ( ostream *  ofile )

inline

Definition at line 185 of file spec_scoring.h.

outputResults()

void EnergyScoringStats::outputResults ( )

inline

write results to console

Definition at line 165 of file spec_scoring.h.

readData()

int EnergyScoringStats::readData ( istream *  ifile )

inline

Definition at line 192 of file spec_scoring.h.

resetCounter()

void EnergyScoringStats::resetCounter ( )

inline

Definition at line 199 of file spec_scoring.h.

scoreEnergyInitialized()

void EnergyScoringStats::scoreEnergyInitialized ( EGS_Float  E )

inline

Needed for loading data from egsdat file.

Definition at line 107 of file spec_scoring.h.

scoreParticleEscapingGeom()

void EnergyScoringStats::scoreParticleEscapingGeom ( EGS_Particle *  p )

inlineprivate

add energy from a escaping simulation geometry to the total

Definition at line 88 of file spec_scoring.h.

scoreParticleEscapingSource()

void EnergyScoringStats::scoreParticleEscapingSource ( EGS_Particle *  p )

inlineprivate

add energy from a particle escaping a source to the total

Definition at line 83 of file spec_scoring.h.

scoreParticleInitialized()

void EnergyScoringStats::scoreParticleInitialized ( EGS_Particle *  p )

inlineprivate

add energy from initial particle to total

Definition at line 75 of file spec_scoring.h.

totalEnergyInitialized()

EGS_Float EnergyScoringStats::totalEnergyInitialized ( )

inline

returns the total energy initialized

Definition at line 131 of file spec_scoring.h.

update()

void EnergyScoringStats::update ( EB_Message  message, void *  particle  )

inlinevirtual

delegate messages to appropriate scoring functions

Implements Subscriber.

Definition at line 147 of file spec_scoring.h.

Member Data Documentation

energy_escaping_geom

EGS_Float EnergyScoringStats::energy_escaping_geom

private

total energy of particles escaping the simulation geometry

Definition at line 64 of file spec_scoring.h.

energy_escaping_sources

EGS_Float EnergyScoringStats::energy_escaping_sources

private

total energy of particles escaping the source geometry note: doesn't currently exclude particles reentering the source geometry and then escaping again

Definition at line 60 of file spec_scoring.h.

total_energy_initialized

EGS_Float EnergyScoringStats::total_energy_initialized

private

total energy of particles initialized so far

Definition at line 59 of file spec_scoring.h.

---

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

• /Users/marc/Developer/EGSnrc/HEN_HOUSE/user_codes/egs_brachy/egs_brachy/spec_scoring.h