A monte carlo pin cell spectral code for nuclear engineering applications.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
neutron Struct Reference

Represents a neutron in a PINSPEC simulation. More...

#include <Neutron.h>

Public Attributes

int _batch_num
 
float _energy
 
float _old_energy
 
bool _collided
 
float _path_length
 
bool _alive
 
Region_region
 
Material_material
 
Isotope_isotope
 
Surface_surface
 
float _x
 
float _y
 
float _z
 
float _u
 
float _v
 
float _w
 

Detailed Description

Represents a neutron in a PINSPEC simulation.

The neutron struct is the fundamental unit of data needed to represent a neutron in a PINSPEC simulation. This struct is useful for passing a neutron from object to object, such as from the Geometry to a Region to a Material and to an Isotope to update the neutron's energy from a collision.

Member Data Documentation

bool neutron::_alive

A boolean representing whether this neutron has been absorbed or not

int neutron::_batch_num

This neutron's batch number in the simulation

bool neutron::_collided

Whether or not the neutron collided (true) or crossed surface (false)

float neutron::_energy

The neutron's energy in eV following its most recent collision

Isotope* neutron::_isotope

A pointer to the Isotope with which the neutron most recently collided

Material* neutron::_material

A pointer to the Material with which the neutron most recently collided

float neutron::_old_energy

The neutron's energy in eV prior to its most recent collision

float neutron::_path_length

The total macroscopic cross-section in $cm^{-1}$ of the material in which the neutron collided at its collision energy The distance traveled to most recent collision (cm)

Region* neutron::_region

A pointer to the Regon in which the neutron most recently collided

Surface* neutron::_surface

A pointer to the nearest surface in a heterogeneous case

float neutron::_u

The component of this neutron's velocity unit vector along the x-axis

float neutron::_v

The component of this neutron's velocity unit vector along the y-axis

float neutron::_w

The component of this neutron's velocity unit vector along the z-axis

float neutron::_x

The x-coordinate of this neutron's location

float neutron::_y

The y-coordinate of this neutron's location

float neutron::_z

The z-coordinate of this neutron's location


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