A monte carlo pin cell spectral code for nuclear engineering applications.
|
The BoundedGeneralRegion is a the space defined by the intersection of some number surface halfspaces. More...
#include "pinspec/src/Region.h"
Public Member Functions | |
BoundedGeneralRegion (const char *region_name=(char *)"") | |
BoundedGeneralRegion constructor. More... | |
~BoundedGeneralRegion () | |
Empty destructor allows SWIG to cleanup memory for surfaces. | |
![]() | |
BoundedRegion (const char *region_name=(char *)"") | |
BoundedRegion constructor. More... | |
virtual | ~BoundedRegion () |
Empty destructor allows SWIG to cleanup memory for surfaces. | |
void | addBoundingSurface (int halfspace, Surface *surface) |
Adds a new halfspace of a bounding surface to a region. More... | |
void | removeBoundingSurface (int halfspace, Surface *surface) |
Removes a halfspace of a bounding surface for a region. More... | |
bool | contains (neutron *neutron) |
Check if this region contains a neutron at some location in space. More... | |
bool | contains (float x, float y, float z) |
Check if this region contains some location in space. More... | |
bool | onBoundary (neutron *neutron) |
Checks if a neutron at some 2D location is on the region boundary. More... | |
float | computeParametrizedDistance (neutron *neutron) |
This method computes the parametrized distance along a neutron's unit trajectory vector to the nearest bounding surface for this Region. More... | |
void | collideNeutron (neutron *neutron) |
This method collides a neutron within the region. More... | |
![]() | |
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... | |
Material * | getMaterial () |
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 ![]() | |
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 ![]() | |
void | setBucklingSquared (float buckling_squared) |
Sets the squared geometric buckling for the geometry. More... | |
Additional Inherited Members | |
![]() | |
char * | _region_name |
int | _uid |
Material * | _material |
regionType | _region_type |
float | _buckling_squared |
float | _volume |
![]() | |
static int | _n = 1 |
The BoundedGeneralRegion is a the space defined by the intersection of some number surface halfspaces.
This type of region is useful for a region that is more complicated than the basic fuel or moderator pin cell, and allows the user to apply their own discretion to create a the bounded region.
BoundedGeneralRegion::BoundedGeneralRegion | ( | const char * | region_name = (char*)"" | ) |
BoundedGeneralRegion constructor.
region_name | the name of the region |