crp/OpenMC
1
0
Fork 0
mirror of https://github.com/openmc-dev/openmc.git synced 2026-07-28 22:26:08 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Respond to @wbinventor comments on #626

Browse source
This commit is contained in:
Paul Romano 2016-04-14 15:57:59 -05:00
parent 0339809deb
commit fa1ca34094
8 changed files with 45 additions and 39 deletions
Download patch file Download diff file Expand all files Collapse all files

18
docs/source/pythonapi/index.rst
View file

@ -74,6 +74,7 @@ Building geometry
:nosignatures:
:template: myclass.rst
openmc.Plane
openmc.XPlane
openmc.YPlane
openmc.ZPlane
@ -81,6 +82,11 @@ Building geometry
openmc.YCylinder
openmc.ZCylinder
openmc.Sphere
openmc.Cone
openmc.XCone
openmc.YCone
openmc.ZCone
openmc.Quadric
openmc.Halfspace
openmc.Intersection
openmc.Union
@ -168,12 +174,12 @@ Various classes may be created when performing tally slicing and/or arithmetic:
:nosignatures:
:template: myclass.rst
openmc.CrossScore
openmc.CrossNuclide
openmc.CrossFilter
openmc.AggregateScore
openmc.AggregateNuclide
openmc.AggregateFilter
openmc.arithmetic.CrossScore
openmc.arithmetic.CrossNuclide
openmc.arithmetic.CrossFilter
openmc.arithmetic.AggregateScore
openmc.arithmetic.AggregateNuclide
openmc.arithmetic.AggregateFilter
---------------------------------
:mod:`openmc.stats` -- Statistics

1
openmc/__init__.py
View file

@ -21,7 +21,6 @@ from openmc.summary import *
from openmc.region import *
from openmc.source import *
from openmc.particle_restart import *
from openmc.arithmetic import *
try:
from openmc.opencg_compatible import *

15
openmc/cell.py
View file

@ -13,7 +13,6 @@ if sys.version_info[0] >= 3:
basestring = str
# A static variable for auto-generated Cell IDs
AUTO_CELL_ID = 10000
@ -23,8 +22,6 @@ def reset_auto_cell_id():
AUTO_CELL_ID = 10000
class Cell(object):
"""A region of space defined as the intersection of half-space created by
quadric surfaces.
@ -81,7 +78,7 @@ class Cell(object):
elif self.name != other.name:
return False
elif self.fill != other.fill:
return False
return False
elif self.region != other.region:
return False
elif self.rotation != other.rotation:
@ -335,7 +332,8 @@ class Cell(object):
Returns
-------
cells : dict
Dictionary whose keys are cell IDs and values are Cell instances
Dictionary whose keys are cell IDs and values are :class:`Cell`
instances
"""
@ -352,7 +350,8 @@ class Cell(object):
Returns
-------
materials : dict
Dictionary whose keys are material IDs and values are Material instances
Dictionary whose keys are material IDs and values are
:class:`Material` instances
"""
@ -374,8 +373,8 @@ class Cell(object):
Returns
-------
universes : dict
Dictionary whose keys are universe IDs and values are Universe
instances
Dictionary whose keys are universe IDs and values are
:class:`Universe` instances
"""

2
openmc/filter.py
View file

@ -520,7 +520,7 @@ class Filter(object):
This method constructs a Pandas DataFrame object for the filter with
columns annotated by filter bin information. This is a helper method for
:math:`Tally.get_pandas_dataframe`.
:meth:`Tally.get_pandas_dataframe`.
This capability has been tested for Pandas >=0.13.1. However, it is
recommended to use v0.16 or newer versions of Pandas since this method

22
openmc/lattice.py
View file

@ -126,8 +126,8 @@ class Lattice(object):
Returns
-------
universes : collections.OrderedDict
Dictionary whose keys are universe IDs and values are Universe
instances
Dictionary whose keys are universe IDs and values are
:class:`Universe` instances
"""
@ -176,7 +176,8 @@ class Lattice(object):
Returns
-------
cells : collections.OrderedDict
Dictionary whose keys are cell IDs and values are Cell instances
Dictionary whose keys are cell IDs and values are :class:`Cell`
instances
"""
@ -194,7 +195,8 @@ class Lattice(object):
Returns
-------
materials : collections.OrderedDict
Dictionary whose keys are material IDs and values are Material instances
Dictionary whose keys are material IDs and values are
:class:`Material` instances
"""
@ -213,8 +215,8 @@ class Lattice(object):
Returns
-------
universes : collections.OrderedDict
Dictionary whose keys are universe IDs and values are Universe
instances
Dictionary whose keys are universe IDs and values are
:class:`Universe` instances
"""
@ -252,10 +254,10 @@ class RectLattice(Lattice):
Unique identifier for the lattice
name : str
Name of the lattice
dimension : array-like of int
dimension : Iterable of int
An array of two or three integers representing the number of lattice
cells in the x- and y- (and z-) directions, respectively.
lower_left : array-like of float
lower_left : Iterable of float
The coordinates of the lower-left corner of the lattice. If the lattice
is two-dimensional, only the x- and y-coordinates are specified.
@ -501,7 +503,7 @@ class HexLattice(Lattice):
Number of radial ring positions in the xy-plane
num_axial : int
Number of positions along the z-axis.
center : array-like of float
center : Iterable of float
Coordinates of the center of the lattice. If the lattice does not have
axial sections then only the x- and y-coordinates are specified
@ -777,7 +779,7 @@ class HexLattice(Lattice):
id_form = '{: ^' + str(n_digits) + 'd}'
# Initialize the list for each row.
rows = [ [] for i in range(1 + 4 * (self._num_rings-1)) ]
rows = [[] for i in range(1 + 4 * (self._num_rings-1))]
middle = 2 * (self._num_rings - 1)
# Start with the degenerate first ring.

4
openmc/mgxs/mgxs.py
View file

@ -1349,7 +1349,7 @@ class MGXS(object):
xs_type='macro', summary=None):
"""Build a Pandas DataFrame for the MGXS data.
This method leverages :math:`openmc.Tally.get_pandas_dataframe`, but
This method leverages :meth:`openmc.Tally.get_pandas_dataframe`, but
renames the columns with terminology appropriate for cross section data.
Parameters
@ -2560,7 +2560,7 @@ class Chi(MGXS):
xs_type='macro', summary=None):
"""Build a Pandas DataFrame for the MGXS data.
This method leverages :math:`openmc.Tally.get_pandas_dataframe`, but
This method leverages :meth:`openmc.Tally.get_pandas_dataframe`, but
renames the columns with terminology appropriate for cross section data.
Parameters

9
openmc/surface.py
View file

@ -278,8 +278,7 @@ class Plane(Surface):
class XPlane(Plane):
"""A plane perpendicular to the x axis, i.e. a surface of the form :math:`x -
x_0 = 0`
"""A plane perpendicular to the x axis of the form :math:`x - x_0 = 0`
Parameters
----------
@ -356,8 +355,7 @@ class XPlane(Plane):
class YPlane(Plane):
"""A plane perpendicular to the y axis, i.e. a surface of the form :math:`y -
y_0 = 0`
"""A plane perpendicular to the y axis of the form :math:`y - y_0 = 0`
Parameters
----------
@ -434,8 +432,7 @@ class YPlane(Plane):
class ZPlane(Plane):
"""A plane perpendicular to the z axis, i.e. a surface of the form :math:`z -
z_0 = 0`
"""A plane perpendicular to the z axis of the form :math:`z - z_0 = 0`
Parameters
----------

13
openmc/universe.py
View file

@ -44,7 +44,8 @@ class Universe(object):
name : str
Name of the universe
cells : collections.OrderedDict
Dictionary whose keys are cell IDs and values are Cell instances
Dictionary whose keys are cell IDs and values are :class:`Cell`
instances
"""
@ -229,7 +230,8 @@ class Universe(object):
Returns
-------
cells : collections.OrderedDict
Dictionary whose keys are cell IDs and values are Cell instances
Dictionary whose keys are cell IDs and values are :class:`Cell`
instances
"""
@ -250,7 +252,8 @@ class Universe(object):
Returns
-------
materials : Collections.OrderedDict
Dictionary whose keys are material IDs and values are Material instances
Dictionary whose keys are material IDs and values are
:class:`Material` instances
"""
@ -269,8 +272,8 @@ class Universe(object):
Returns
-------
universes : collections.OrderedDict
Dictionary whose keys are universe IDs and values are Universe
instances
Dictionary whose keys are universe IDs and values are
:class:`Universe` instances
"""