EB_UniformRunControl Class Reference

#include <egs_brachy.h>

Inheritance diagram for EB_UniformRunControl:

Collaboration diagram for EB_UniformRunControl:

Public Member Functions
	EB_UniformRunControl (EB_Application *app, string egsdat_format)
	~EB_UniformRunControl ()
void	describeRCO ()
int	startSimulation ()
int	finishSimulation ()
	Uses 'watcher' jobs to determine if the simulation has finished.

Protected Attributes
EB_Application *	app
string	output_egsdat_format
	text or gzip
int	milliseconds
int	check_intervals
int	njob
int	npar
int	ipar
int	ifirst
bool	check_egsdat
bool	watcher_job

Detailed Description

Definition at line 520 of file egs_brachy.h.

Constructor & Destructor Documentation

EB_UniformRunControl()

EB_UniformRunControl::EB_UniformRunControl	(	EB_Application *	app,
		string	egsdat_format
	)

Definition at line 2636 of file egs_brachy.cpp.

~EB_UniformRunControl()

EB_UniformRunControl::~EB_UniformRunControl ( )

inline

Definition at line 525 of file egs_brachy.h.

Member Function Documentation

describeRCO()

void EB_UniformRunControl::describeRCO

(

)

Definition at line 2720 of file egs_brachy.cpp.

finishSimulation()

int EB_UniformRunControl::finishSimulation

(

)

Uses 'watcher' jobs to determine if the simulation has finished.

If the current job is a 'watcher' job, it waits for some time before issuing the signal to recombine all available parallel jobs. These 'watcher' jobs can also produce intermediate results while waiting. If all jobs complete while waiting, the 'watcher' job combines all results and exits.

Definition at line 2747 of file egs_brachy.cpp.

startSimulation()

int EB_UniformRunControl::startSimulation

(

)

Definition at line 2697 of file egs_brachy.cpp.

Member Data Documentation

app

EB_Application* EB_UniformRunControl::app

protected

Definition at line 543 of file egs_brachy.h.

check_egsdat

bool EB_UniformRunControl::check_egsdat

protected

Definition at line 557 of file egs_brachy.h.

check_intervals

int EB_UniformRunControl::check_intervals

protected

Definition at line 550 of file egs_brachy.h.

ifirst

int EB_UniformRunControl::ifirst

protected

Definition at line 556 of file egs_brachy.h.

ipar

int EB_UniformRunControl::ipar

protected

Definition at line 555 of file egs_brachy.h.

milliseconds

int EB_UniformRunControl::milliseconds

protected

Definition at line 547 of file egs_brachy.h.

njob

int EB_UniformRunControl::njob

protected

Definition at line 553 of file egs_brachy.h.

npar

int EB_UniformRunControl::npar

protected

Definition at line 554 of file egs_brachy.h.

output_egsdat_format

string EB_UniformRunControl::output_egsdat_format

protected

text or gzip

Definition at line 545 of file egs_brachy.h.

watcher_job

bool EB_UniformRunControl::watcher_job

protected

Definition at line 558 of file egs_brachy.h.

---

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

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