A class for tallying the elastic scattering rate for an isotope. More...

#include "pinspec/src/Tally.h"

Inheritance diagram for IsotopeElasticRateTally:

Public Member Functions
	IsotopeElasticRateTally (Isotope isotope, char tally_name=(char *)"")
	IsotopeElasticRateTally constructor calls the IsotopeTally constructor and Tally constructors and sets the tally type to ELASTIC_RATE. More...

void	tally (neutron *neutron)
	Tally the isotope elastic scattering rate by incrementing the tally by $\frac{\sigma_s}{\Sigma_t}$ at the neutron's energy. More...

Public Member Functions inherited from IsotopeTally
	IsotopeTally (Isotope isotope, char tally_name=(char *)"")
	IsotopeTally constructor calls the Tally constructor and sets the tally domain to ISOTOPE. More...

Isotope *	getIsotope ()
	Returns the isotope for this tally. More...

Public Member Functions inherited from Tally
	Tally (char tally_name=(char )"")
	Tally constructor. More...

virtual	~Tally ()
	Tally destructor deletes memory for tallies, number of tallies, bin centers and bin edges (if they have been created).

char *	getTallyName ()
	Returns the name of the tally. More...

int	getNumBins ()
	Returns the number of tally bins. More...

int	getNumEdges ()
	Returns the number of tally edges. More...

double *	getBinEdges ()
	Returns a double array of bin edge values. More...

double *	getBinCenters ()
	Returns a double array of bin center values. More...

double	getBinDelta ()
	Returns the delta spacing between bins. NOTE: this value is only non-zero for EQUAL and LOGARITHMIC bin types. More...

double	getBinDelta (double sample)
	Returns the delta spacing between the bin edges sandwiching a given sample value. More...

binSpacingType	getBinSpacingType ()
	Returns the bin spacing type (EQUAL, LOGARITHMIC, OTHER). More...

tallyDomainType	getTallyDomainType ()
	Returns the type of tally for these bins (ISOTOPE, MATERIAL, REGION). More...

tallyType	getTallyType ()
	Returns the type of tally for these bins (FLUX, COLLISION_RATE, etc). More...

double **	getTallies ()
	Returns a double array of the tallies within each bin. More...

double	getTally (int bin_index, int batch_num)
	Returns a specific tally for a specific bin and batch. More...

double	getMaxTally ()
	Returns the maximum tally value among all bins and batches. More...

double	getMinTally ()
	Returns the maximum tally value among all bins and batches. More...

int	getBinIndex (double sample)
	Finds the bin index for a sample in a set of bins. If the samples is outside the bounds of all bins, it returns infinity. More...

double	getMaxMu ()
	Returns the maximum average tally over batches. More...

double	getMaxVariance ()
	Returns the maximum tally variance over batches. More...

double	getMaxStdDev ()
	Returns the maximum tally standard deviatoin. More...

double	getMaxRelErr ()
	Returns the maximum tally relative error. More...

float	getTriggerPrecision ()
	Returns the trigger precision for this tally. More...

triggerType	getTriggerType ()
	Returns the precision trigger type (VARIANCE, STANDARD_DEVIATION, RELATIVE_ERROR, or NONE). More...

bool	hasComputedBatchStatistics ()
	Returns whether or not the tally has computed batch statistics. More...

bool	hasExpandedGroupBins ()
	Returns whether or not the tally has expanded it's group bins. More...

void	retrieveTallyEdges (double *data, int num_bins)
	This method fills an array with the tally bin edges. More...

void	retrieveTallyCenters (double *data, int num_bins)
	This method fills an array with the tally bin centers. More...

void	retrieveTallyMu (double *data, int num_bins)
	This method fills an array with the average tally values. More...

void	retrieveTallyVariance (double *data, int num_bins)
	This method fills an array with the tally variances. More...

void	retrieveTallyStdDev (double *data, int num_bins)
	This method fills an array with the tally standard deviations. More...

void	retrieveTallyRelErr (double *data, int num_bins)
	This method fills an array with the tally relative errors. More...

int	getNumBatches ()
	Returns the number of batches for this tally. More...

double *	getBatchMu ()
	Returns a pointer to an array of tally batch averages if they have been computed. More...

double *	getBatchVariance ()
	Returns a pointer to an array of tally batch variances if they have been computed. More...

double *	getBatchStdDev ()
	Returns a pointer to an array of tally batch standard deviations if they have been computed. More...

double *	getBatchRelativeError ()
	Returns a pointer to an array of tally batch relative errors if they have been computed. More...

void	setTallyDomainType (tallyDomainType type)
	Set the tally domain type (MATERIAL, REGION, etc.). More...

void	setTallyType (tallyType type)
	Set the tally type (FLUX, CAPTURE_RATE, etc.). More...

void	setBinSpacingType (binSpacingType type)
	Set the bin spacing type for this Tally (EQUAL, LOGARITHMIC, OTHER). More...

void	setBinEdges (double *edges, int num_edges)
	Set a user-defined double array of bin edge values. More...

void	setGroupExpandBins (bool expand_bins)
	Informs the tally whether or not to expand its group bins. More...

void	setPrecisionTrigger (triggerType trigger_type, float precision)
	Sets a precision trigger for this tally. More...

void	generateBinEdges (double start, double end, int num_bins, binSpacingType type)
	Generate edges between bins defined by a start and end point. More...

void	generateBinCenters ()
	Compute the center points between bin edges for this Tally's bins. More...

void	setNumBatches (int num_batches)
	Set the number of batches for this Tally. More...

void	incrementNumBatches (int num_batches)
	Increments the number of batches for this tally. More...

bool	isPrecisionTriggered ()
	Returns whether or not the tally precision meets the precision trigger threshold, if a trigger exists. More...

void	computeBatchStatistics ()
	Computes average, variance, standard deviation and relative error for each bin over the set of batches. More...

void	computeScaledBatchStatistics (double scale_factor)
	Computes average, variance, standard deviation and relative error for each bin over the set of batches. More...

void	normalizeBatchMu ()
	Divide each tally by the maximum tally value.

void	outputBatchStatistics (const char *filename)
	Outputs the batch statistics (if they have been computed) to an ASCII file. More...

void	printTallies (bool uncertainties=false)
	Print the tally values to the screen. More...

Tally *	clone ()
	Creates a new version of this tally with identical data. More...

void	tally (neutron *neutron, double weight)
	This method tallies a particular weight for a neutron. More...

void	tallyGroup (neutron *neutron, double weight)
	This method tallies a particular weight for a neutron for group-to group scattering. More...

DerivedTally *	tile (const int num_tiles)
	Create a DerivedTally with this tally's data repetively "tiled". More...

DerivedTally *	addIntegers (const int *amt, const int length)
	Tally addition with an array of integers. More...

DerivedTally *	addFloats (const float *amt, const int length)
	Tally addition with an array of floats. More...

DerivedTally *	addDoubles (const double *amt, const int length)
	Tally addition with an array of doubles. More...

DerivedTally *	subtractIntegers (const int *amt, const int length)
	Tally subtraction with an array of integers. More...

DerivedTally *	subtractFloats (const float *amt, const int length)
	Tally subtraction with an array of floats. More...

DerivedTally *	subtractDoubles (const double *amt, const int length)
	Tally subtraction with an array of doubles. More...

DerivedTally *	multiplyIntegers (const int *amt, const int length)
	Tally multiplication with an array of integers. More...

DerivedTally *	multiplyFloats (const float *amt, const int length)
	Tally multiplication with an array of floats. More...

DerivedTally *	multiplyDoubles (const double *amt, const int length)
	Tally multiplication with an array of doubles. More...

DerivedTally *	divideIntegers (const int *amt, const int length)
	Tally division with an array of integers. More...

DerivedTally *	divideFloats (const float *amt, const int length)
	Tally division with an array of floats. More...

DerivedTally *	divideDoubles (const double *amt, const int length)
	Tally division with an array of doubles. More...

DerivedTally *	operator+ (Tally *tally)
	Tally addition operator. More...

DerivedTally *	operator- (Tally *tally)
	Tally subtraction operator. More...

DerivedTally *	operator* (Tally *tally)
	Tally multiplication operator. More...

DerivedTally *	operator/ (Tally *tally)
	Tally division operator. More...

DerivedTally *	operator+ (const int amt)
	Tally addition with a constant operator. More...

DerivedTally *	operator- (const int amt)
	Tally subtraction with a constant operator. More...

DerivedTally *	operator* (const int amt)
	Tally multiplication with a constant operator. More...

DerivedTally *	operator/ (const int amt)
	Tally division with a constant operator. More...

DerivedTally *	operator+ (const float amt)
	Tally addition with a constant operator. More...

DerivedTally *	operator- (const float amt)
	Tally subtraction with a constant operator. More...

DerivedTally *	operator* (const float amt)
	Tally multiplication with a constant operator. More...

DerivedTally *	operator/ (const float amt)
	Tally division with a constant operator. More...

DerivedTally *	operator+ (const double amt)
	Tally addition with a constant operator. More...

DerivedTally *	operator- (const double amt)
	Tally subtraction with a constant operator. More...

DerivedTally *	operator* (const double amt)
	Tally multiplication with a constant operator. More...

DerivedTally *	operator/ (const double amt)
	Tally division with a constant operator. More...

Additional Inherited Members
Protected Attributes inherited from IsotopeTally
Isotope *	_isotope

Protected Attributes inherited from Tally
char *	_tally_name

int	_num_bins

int	_num_edges

double *	_edges

double *	_centers

double **	_tallies

double	_bin_delta

binSpacingType	_bin_spacing

tallyDomainType	_tally_domain

tallyType	_tally_type

triggerType	_trigger_type

float	_trigger_precision

int	_num_batches

double *	_batch_mu

double *	_batch_variance

double *	_batch_std_dev

double *	_batch_rel_err

bool	_computed_statistics

bool	_group_expand_bins

Detailed Description

A class for tallying the elastic scattering rate for an isotope.

Constructor & Destructor Documentation

IsotopeElasticRateTally::IsotopeElasticRateTally	(	Isotope *	isotope,
		char *	tally_name = `(char*)""`
	)

inline

IsotopeElasticRateTally constructor calls the IsotopeTally constructor and Tally constructors and sets the tally type to ELASTIC_RATE.

Parameters

isotope	a pointer to the isotope for which to tally
tally_name	a character array for the tally name (optional)

Member Function Documentation

void IsotopeElasticRateTally::tally ( neutron * neutron )

virtual

Tally the isotope elastic scattering rate by incrementing the tally by $\frac{\sigma_s}{\Sigma_t}$ at the neutron's energy.

Parameters

neutron the neutron of interest

Implements IsotopeTally.

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

pinspec/src/Tally.h
pinspec/src/Tally.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation