openmc.VolumeCalculation¶
- class openmc.VolumeCalculation(domains, samples, lower_left=None, upper_right=None)[source]¶
Stochastic volume calculation specifications and results.
- Parameters
domains (Iterable of openmc.Cell, openmc.Material, or openmc.Universe) – Domains to find volumes of
samples (int) – Number of samples used to generate volume estimates
lower_left (Iterable of float) – Lower-left coordinates of bounding box used to sample points. If this argument is not supplied, an attempt is made to automatically determine a bounding box.
upper_right (Iterable of float) – Upper-right coordinates of bounding box used to sample points. If this argument is not supplied, an attempt is made to automatically determine a bounding box.
- Variables
ids (Iterable of int) – IDs of domains to find volumes of
domain_type ({'cell', 'material', 'universe'}) – Type of each domain
samples (int) – Number of samples used to generate volume estimates
lower_left (Iterable of float) – Lower-left coordinates of bounding box used to sample points
upper_right (Iterable of float) – Upper-right coordinates of bounding box used to sample points
atoms (dict) – Dictionary mapping unique IDs of domains to a mapping of nuclides to total number of atoms for each nuclide present in the domain. For example, {10: {‘U235’: 1.0e22, ‘U238’: 5.0e22, …}}.
atoms_dataframe (pandas.DataFrame) – DataFrame showing the estimated number of atoms for each nuclide present in each domain specified.
volumes (dict) – Dictionary mapping unique IDs of domains to estimated volumes in cm^3.
threshold (float) –
Threshold for the maximum standard deviation of volumes.
New in version 0.12.
trigger_type ({'variance', 'std_dev', 'rel_err'}) –
Value type used to halt volume calculation
New in version 0.12.
iterations (int) –
Number of iterations over samples (for calculations with a trigger).
New in version 0.12.
- classmethod from_hdf5(filename)[source]¶
Load stochastic volume calculation results from HDF5 file.
- Parameters
filename (str) – Path to volume.h5 file
- Returns
Results of the stochastic volume calculation
- Return type
- classmethod from_xml_element(elem)[source]¶
Generate volume calculation object from an XML element
New in version 0.13.0.
- Parameters
elem (lxml.etree._Element) – XML element
- Returns
Volume calculation object
- Return type
- load_results(filename)[source]¶
Load stochastic volume calculation results from an HDF5 file.
- Parameters
filename (str) – Path to volume.h5 file