volcor::VCResults Struct Reference

Struct used to collect and output results about a volume correction run. More...

#include <volcor.h>

Public Member Functions
	VCResults (string vcfile)
	VCResults (VCOptions *opts)
void	outputResults () const

Public Attributes
bool	success
EGS_Float	time
double	density
double	npoints
double	ninscribed
double	bounds_volume
double	inscribed_volume
string	vc_file
RegionGeomSetT	regions_with_inscribed
vector< EGS_Float >	uncorrected_volumes
vector< EGS_Float >	corrected_volumes
VCOptions *	options

Detailed Description

Struct used to collect and output results about a volume correction run.

Definition at line 424 of file volcor.h.

Member Function Documentation

void volcor::VCResults::outputResults

(

)

const

print information about the volume correction run

Definition at line 475 of file volcor.h.

References bounds_volume, density, EGS_RandomGenerator::describeRNG(), egsInformation, inscribed_volume, npoints, and time.

Member Data Documentation

bool volcor::VCResults::success

did the volume correction succeeed?

Definition at line 428 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), and volcor::loadFileResults().

EGS_Float volcor::VCResults::time

how long (s) did the volume correction take

Definition at line 429 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), volcor::loadFileResults(), and outputResults().

double volcor::VCResults::density

what was the density of points used for the VC

Definition at line 430 of file volcor.h.

Referenced by outputResults().

double volcor::VCResults::npoints

what was the total number of points used for the VC

Definition at line 431 of file volcor.h.

Referenced by outputResults().

double volcor::VCResults::ninscribed

what was the total number of inscribed geometries

Definition at line 432 of file volcor.h.

double volcor::VCResults::bounds_volume

what was the volume of the bounding shape

Definition at line 433 of file volcor.h.

Referenced by outputResults().

double volcor::VCResults::inscribed_volume

what was the estimated volume of the inscribed geometry

Definition at line 434 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), and outputResults().

RegionGeomSetT volcor::VCResults::regions_with_inscribed

which base regions have inscribed geometries in them

Definition at line 438 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), and volcor::loadFileResults().

vector<EGS_Float> volcor::VCResults::uncorrected_volumes

uncorrected volume of all base regions

Definition at line 439 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), and volcor::loadFileResults().

vector<EGS_Float> volcor::VCResults::corrected_volumes

corrected (value of corrected vol depends on mode)volume of all base regions

Definition at line 440 of file volcor.h.

Referenced by volcor::findRegionsWithInscribed(), and volcor::loadFileResults().

---

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

• /home/rwtownson/EGSnrc/HEN_HOUSE/egs++/geometry/egs_autoenvelope/volcor.h