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

The EquivalenceModeratorRegion is a fuel region treated using the heterogenous-homogeneous equivalence theory. More...

#include "pinspec/src/Region.h"

Inheritance diagram for EquivalenceModeratorRegion:
EquivalenceRegion Region

Public Member Functions

 EquivalenceModeratorRegion (const char *region_name=(char *)"")
 EquivalenceModeratorRegion constructor. More...
 
 ~EquivalenceModeratorRegion ()
 Empty destructor allows SWIG to cleanup memory for surfaces.
 
- Public Member Functions inherited from EquivalenceRegion
 EquivalenceRegion (const char *region_name=(char *)"")
 EquivalenceRegion constructor. More...
 
virtual ~EquivalenceRegion ()
 Empty destructor allows SWIG to cleanup memory for surfaces.
 
float getFuelPinRadius ()
 Returns the fuel pin radius. More...
 
float getPinCellPitch ()
 Returns the pin cell pitch. More...
 
int getEnergyGridIndex (float lethargy)
 This method returns the index for a certain lethargy (log10(eV)) into the uniform lethargy grid of the region's first flight collision probabilies. More...
 
bool isFuel ()
 Returns true if this region is the fuel, false otherwise. More...
 
bool isModerator ()
 Returns true if this region is the moderator, false otherwise. More...
 
void setFirstFlightCollProb (float *prob_ff, float *prob_mf, float *prob_energies, int num_prob)
 Sets the first flight collision probabilities. More...
 
void setOtherRegion (EquivalenceRegion *region)
 Sets other region for a homogeneous equivalence region. More...
 
void setFuelPinRadius (float radius)
 Sets the fuel radius if the region. More...
 
void setPinCellPitch (float pitch)
 Sets the pin cell pitch. More...
 
float computeFuelFuelCollsionProb (neutron *neutron)
 Finds the first flight fuel-to-fuel collision probability for a neutron. More...
 
float computeModeratorFuelCollisionProb (neutron *neutron)
 Finds the first flight moderator-to-fuel collision probability for a neutron. More...
 
void collideNeutron (neutron *neutron)
 This method collides a neutron within the region. More...
 
- Public Member Functions inherited from Region
 Region (const char *region_name=(char *)"")
 Region constructor. More...
 
virtual ~Region ()
 Empty destructor allows SWIG to cleanup memory for surfaces. More...
 
char * getName ()
 Return the name of the region. More...
 
int getUid () const
 Returns the unique ID auto-generated for the region. More...
 
MaterialgetMaterial ()
 Returns a pointer to the material filling this region. More...
 
bool containsIsotope (Isotope *isotope)
 Determines whether this region contains a particular isotope. More...
 
regionType getRegionType ()
 Return the type of region. More...
 
float getVolume ()
 returns the volume of this Region $ (cm^3) $. More...
 
float getBucklingSquared ()
 Returns the squared geometric buckling. More...
 
float getTotalMacroXS (float energy)
 Computes and returns the total macroscopic cross-section in the region at some energy (eV). More...
 
float getTotalMacroXS (int energy_index)
 Computes and returns the total macroscopic cross-section in the region at some index into the uniform lethargy grid. More...
 
float getTotalMicroXS (float energy)
 Computes and returns the total microscopic cross-section in the region at some energy (eV). More...
 
float getTotalMicroXS (int energy_index)
 Computes and returns the total microscopic cross-section in the region at some index into the uniform lethargy grid. More...
 
float getElasticMacroXS (float energy)
 Computes and returns the macroscopic elastic scattering cross-section in the region at some energy (eV). More...
 
float getElasticMacroXS (int energy_index)
 Computes and returns the macroscopic elastic scattering cross-section in the region at some index into the uniform lethargy grid. More...
 
float getElasticMicroXS (float energy)
 Computes and returns the microscopic elastic scattering cross-section in the region at some energy (eV). More...
 
float getElasticMicroXS (int energy_index)
 Computes and returns the microscopic elastic scattering cross-section in the region at some index into the uniform lethargy grid. More...
 
float getAbsorptionMacroXS (float energy)
 Computes and returns the macroscopic absorption cross-section in the region at energy (eV). More...
 
float getAbsorptionMacroXS (int energy_index)
 Computes and returns the macroscopic absorption cross-section in the region at some index into the uniform lethargy grid. More...
 
float getAbsorptionMicroXS (float energy)
 Computes and returns the microscopic absorption cross-section in the region at some energy (eV). More...
 
float getAbsorptionMicroXS (int energy_index)
 Computes and returns the microscopic absorption cross-section in the region at some index into the uniform lethargy grid. More...
 
float getCaptureMacroXS (float energy)
 Computes and returns the macroscopic capture cross-section in the region at some energy (eV). More...
 
float getCaptureMacroXS (int energy_index)
 Computes and returns the macroscopic capture cross-section in the region at some index into the uniform lethargy grid. More...
 
float getCaptureMicroXS (float energy)
 Computes and returns the microscopic capture cross-section in the region at some energy (eV). More...
 
float getCaptureMicroXS (int energy_index)
 Computes and returns the microscopic capture cross-section in the region at some index into the uniform lethargy grid. More...
 
float getFissionMacroXS (float energy)
 Computes and returns the macroscopic fission cross-section in the region at some energy (eV). More...
 
float getFissionMacroXS (int energy_index)
 Computes and returns the macroscopic fission cross-section in the region at some index into the uniform lethargy grid. More...
 
float getFissionMicroXS (float energy)
 Computes and returns the microscopic fission cross-section in the region at some energy (eV) More...
 
float getFissionMicroXS (int energy_index)
 Computes and returns the microscopic fission cross-section in the region at some index into the uniform lethargy grid. More...
 
float getTransportMicroXS (float energy)
 Computes and returns the microscopic transport cross-section in the region at some index into the uniform lethargy grid. More...
 
float getTransportMicroXS (int energy_index)
 Computes and returns the microscopic transport cross-section in the region at some index into the uniform lethargy grid. More...
 
float getTransportMacroXS (float energy)
 Computes and returns the macroscopic transport cross-section in the region at some index into the uniform lethargy grid. More...
 
float getTransportMacroXS (int energy_index)
 Computes and returns the macroscopic transport cross-section in the region at some index into the uniform lethargy grid. More...
 
void setMaterial (Material *material)
 Set the material filling this region. More...
 
void setVolume (float volume)
 Sets the volume for this region $ (cm^3) $. More...
 
void setBucklingSquared (float buckling_squared)
 Sets the squared geometric buckling for the geometry. More...
 

Additional Inherited Members

- Protected Attributes inherited from Region
char * _region_name
 
int _uid
 
Material_material
 
regionType _region_type
 
float _buckling_squared
 
float _volume
 
- Static Protected Attributes inherited from Region
static int _n = 1
 

Detailed Description

The EquivalenceModeratorRegion is a fuel region treated using the heterogenous-homogeneous equivalence theory.

In particular, this class uses Carlvik's Rational Approximation for first flight collision probabilities. This heterogeneous - homogeneous approximation allows this class to treat a heterogeneous pin cell simply as a homogeneous fuel and homogeneous moderator regions with probabilities for a particle to travel from one region to another at a given energy. This avoids the need for explicit ray tracing of particle trajectories across the geometry.

Constructor & Destructor Documentation

EquivalenceModeratorRegion::EquivalenceModeratorRegion ( const char *  region_name = (char*)"")

EquivalenceModeratorRegion constructor.

Parameters
region_namethe name of the region

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