The Tally superclass and subclasses. More...

Classes
class	Tally
	A Tally reprsents a set of bins for tallying some quantity. More...

class	IsotopeTally
	An abstract class for tallies with ISOTOPE domain type. More...

class	MaterialTally
	An abstract class for tallies with MATERIAL domain type. More...

class	RegionTally
	An abstract class for tallies with REGION domain type. More...

class	GeometryTally
	An abstract class for tallies with MATERIAL domain type. More...

class	IsotopeCollisionRateTally
	A class for tallying the collision rate for an isotope. More...

class	MaterialCollisionRateTally
	A class for tallying the collision rate within a material. More...

class	RegionCollisionRateTally
	A class for tallying the collision rate within a region. More...

class	GeometryCollisionRateTally
	A class for tallying the collision rate within the geometry. More...

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

class	MaterialElasticRateTally
	A class for tallying the elastic scattering rate within a material. More...

class	RegionElasticRateTally
	A class for tallying the elastic scattering rate within a region. More...

class	GeometryElasticRateTally
	A class for tallying the elastic scattering rate within the geometry. More...

class	IsotopeGroupRateTally
	A class for tallying the group-to-group scattering rate for an isotope. More...

class	MaterialGroupRateTally
	A class for tallying the group-to-group scattering rate within a material. More...

class	RegionGroupRateTally
	A class for tallying the group-to-group scattering rate within a region. More...

class	GeometryGroupRateTally
	A class for tallying the group-to-group scattering rate within the geometry. More...

class	IsotopeOutScatterRateTally
	A class for tallying the outter scattering rate for an isotope. More...

class	MaterialOutScatterRateTally
	A class for tallying the out scattering rate within a material. More...

class	RegionOutScatterRateTally
	A class for tallying the outter scattering rate within a region. More...

class	GeometryOutScatterRateTally
	A class for tallying the outter scattering rate within the geometry. More...

class	IsotopeAbsorptionRateTally
	A class for tallying the absorption rate for an isotope. More...

class	MaterialAbsorptionRateTally
	A class for tallying the absorption rate within a material. More...

class	RegionAbsorptionRateTally
	A class for tallying the absorption rate within a region. More...

class	GeometryAbsorptionRateTally
	A class for tallying the absorption within the geometry. More...

class	IsotopeCaptureRateTally
	A class for tallying the capture rate for an isotope. More...

class	MaterialCaptureRateTally
	A class for tallying the collision rate within a material. More...

class	RegionCaptureRateTally
	A class for tallying the capture rate within a region. More...

class	GeometryCaptureRateTally
	A class for tallying the capture rate within the geometry. More...

class	IsotopeFissionRateTally
	A class for tallying the fission rate for an isotope. More...

class	MaterialFissionRateTally
	A class for tallying the capture rate within a material. More...

class	RegionFissionRateTally
	A class for tallying the fission rate within a region.. More...

class	GeometryFissionRateTally
	A class for tallying the capture rate for an isotope. More...

class	IsotopeTransportRateTally
	A class for tallying the transport rate for an isotope. More...

class	MaterialTransportRateTally
	A class for tallying the transport rate within a material. More...

class	RegionTransportRateTally
	A class for tallying the transport rate within a region. More...

class	GeometryTransportRateTally
	A class for tallying the transport rate within the geometry. More...

class	IsotopeDiffusionRateTally
	A class for tallying the diffusion rate for an isotope. More...

class	MaterialDiffusionRateTally
	A class for tallying the diffusion rate within a material. More...

class	RegionDiffusionRateTally
	A class for tallying the diffusion rate within a region. More...

class	GeometryDiffusionRateTally
	A class for tallying the capture rate for an isotope. More...

class	MaterialLeakageRateTally
	A class for tallying the leakage rate for the regions filled by a material. More...

class	RegionLeakageRateTally
	A class for tallying the leakage rate for a region. More...

class	GeometryLeakageRateTally
	A class for tallying the leakage rate for the geometry. More...

class	MaterialFluxTally
	A class for tallying the flux in all regions filled by a material. More...

class	RegionFluxTally
	A class for tallying the flux for a region. More...

class	GeometryFluxTally
	A class for tallying the flux for the geometry. More...

class	MaterialInterCollisionTimeTally
	A class for tallying the time between collision with a material. More...

class	RegionInterCollisionTimeTally
	A class for tallying the time between collisions for the region. More...

class	GeometryInterCollisionTimeTally
	A class for tallying the time between collisions for the geometry. More...

class	DerivedTally
	A class for tallies resulting from tally arithmetic operations. More...

Macros
#define	NEUTRON_MASS 939565378

#define	LIGHT_SPEED 299792458

Typedefs
typedef enum tallyDomainTypes	tallyDomainType
	A domain type within which a tally may reside.

typedef enum triggerTypes	triggerType
	The type of precision trigger for a tally object. More...

typedef enum tallyTypes	tallyType
	The types of tallies which may be instantiated and used in a PINSPEC simulation.

typedef enum binSpacingTypes	binSpacingType
	The spacing between bin edges for a tally.

Enumerations
enum	tallyDomainTypes { MATERIAL, ISOTOPE, REGION, GEOMETRY, UNDEFINED }
	The types of domains in which tally may reside. More...

enum	triggerTypes { VARIANCE, STANDARD_DEVIATION, RELATIVE_ERROR, NONE }
	The type of precision trigger for a tally object. More...

enum	tallyTypes { FLUX, LEAKAGE_RATE, COLLISION_RATE, INTERCOLLISION_TIME, ELASTIC_RATE, GROUP_TO_GROUP_RATE, OUTSCATTER_RATE, ABSORPTION_RATE, CAPTURE_RATE, FISSION_RATE, TRANSPORT_RATE, DIFFUSION_RATE, DERIVED }
	The types of tallies which may be instantiated and used in a PINSPEC simulation. More...

enum	binSpacingTypes { EQUAL, LOGARITHMIC, OTHER }
	The spacing between bin edges for tallies. More...

Detailed Description

The Tally superclass and subclasses.

Author: William Boyd (wboyd.mit.edu)

Date: March 4, 2013

Macro Definition Documentation

#define LIGHT_SPEED 299792458

The speed of light in meters per second

#define NEUTRON_MASS 939565378

Mass of a neutron in $\frac{eV}{c^2}$

Typedef Documentation

triggerType

The type of precision trigger for a tally object.

Precision triggers represent a threshold on the level of precision the user requires before ending the simulation.

Enumeration Type Documentation

enum binSpacingTypes

The spacing between bin edges for tallies.

Enumerator
EQUAL	Equally spaced bins
LOGARITHMIC	Logarithmically spaced bins
OTHER	Bin edges without a specified pattern

enum tallyDomainTypes

The types of domains in which tally may reside.

Enumerator
MATERIAL	A tally may reside within a material
ISOTOPE	A tally may reside within an isotope
REGION	A tally may reside within a region
GEOMETRY	A tally may reside within the entire geometry
UNDEFINED	A tally may have an undefined domain - only used for DERIVED tally types

enum tallyTypes

The types of tallies which may be instantiated and used in a PINSPEC simulation.

Enumerator
FLUX	A tally of the flux
LEAKAGE_RATE	A tally of the leakage rate
COLLISION_RATE	A tally of the collision rate
INTERCOLLISION_TIME	A tally of the intercollision time
ELASTIC_RATE	A tally of the elastic scattering rate
GROUP_TO_GROUP_RATE	A tally of the group-to-group scattering rate
OUTSCATTER_RATE	A tally of the out-scattering reaction rate
ABSORPTION_RATE	A tally of the absorption rate
CAPTURE_RATE	A tally of the capture rate
FISSION_RATE	A tally of the fission rate
TRANSPORT_RATE	A tally of the transport rate
DIFFUSION_RATE	A tally of the diffusion rate
DERIVED	A derived tally type - used to define the tally returned from tally arithmetic such as would be the case in Python: derived_tally = tally1 + tally2

enum triggerTypes

The type of precision trigger for a tally object.

Precision triggers represent a threshold on the level of precision the user requires before ending the simulation.

Enumerator
VARIANCE	A precision trigger on the maximum variance for a tally
STANDARD_DEVIATION	A precision trigger on the maximum standard deviation for a tally
RELATIVE_ERROR	A precision trigger on the maximum relative error for a tally
NONE	The absence of a precision trigger for a tally

Classes

Macros

Typedefs

Enumerations

Detailed Description

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation