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

The InfiniteMediumRegion is a homogenized region treated without geometric effects. More...

#include "pinspec/src/Region.h"

Inheritance diagram for InfiniteMediumRegion:
Region

Public Member Functions

 InfiniteMediumRegion (const char *region_name=(char *)"")
 InfiniteMediumRegion constructor. More...
 
virtual ~InfiniteMediumRegion ()
 Empty destructor allows SWIG to cleanup memory for surfaces.
 
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 InfiniteMediumRegion is a homogenized region treated without geometric effects.

Only a single InfiniteMedium Region should be defined for a given PINSPEC simulation. An infinite medium spectral calculation in in PINSPEC neglects the location of particles and only treats neutron elastic and thermal capture, scattering and fission events.

Constructor & Destructor Documentation

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

InfiniteMediumRegion constructor.

Sets defaults for the geometric parameters to 0.

Parameters
region_namethe name of the region

Member Function Documentation

void InfiniteMediumRegion::collideNeutron ( neutron neutron)
virtual

This method collides a neutron within the region.

This method encapsulates all of the neutron scattering physics which is further encapsulated by the material and isotope classes.

Parameters
neutronthe neutron of interest

Implements Region.


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