diff --git a/openmc/material.py b/openmc/material.py index 284e09f8d1..24ffc29222 100644 --- a/openmc/material.py +++ b/openmc/material.py @@ -34,10 +34,12 @@ class Material(object): Parameters ---------- - material_id : int - Unique identifier for the material - name : str - Name of the material + material_id : int, optional + Unique identifier for the material. If not specified, an identifier will + automatically be assigned. + name : str, optional + Name of the material. If not specified, the name will be the empty + string. Attributes ---------- @@ -151,7 +153,8 @@ class Material(object): units : str Physical units of density density : float, optional - Value of the density + Value of the density. Must be specified unless units is given as + 'sum'. """ diff --git a/openmc/surface.py b/openmc/surface.py index 06a4f2cc32..940590173a 100644 --- a/openmc/surface.py +++ b/openmc/surface.py @@ -20,14 +20,16 @@ class Surface(object): Parameters ---------- - surface_id : int - Unique identifier for the surface - boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} + surface_id : int, optional + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. + boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'}, optional Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles freely pass through the surface. - name : str - Name of the surface + name : str, optional + Name of the surface. If not specified, the name will be the empty + string. Attributes ---------- @@ -165,7 +167,8 @@ class Plane(Surface): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -179,7 +182,7 @@ class Plane(Surface): D : float The 'D' parameter for the plane name : str - Name of the plane + Name of the plane. If not specified, the name will be the empty string. Attributes ---------- @@ -274,7 +277,8 @@ class XPlane(Plane): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -282,7 +286,7 @@ class XPlane(Plane): x0 : float Location of the plane name : str - Name of the plane + Name of the plane. If not specified, the name will be the empty string. Attributes ---------- @@ -323,7 +327,8 @@ class YPlane(Plane): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -331,7 +336,7 @@ class YPlane(Plane): y0 : float Location of the plane name : str - Name of the plane + Name of the plane. If not specified, the name will be the empty string. Attributes ---------- @@ -372,7 +377,8 @@ class ZPlane(Plane): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -380,7 +386,7 @@ class ZPlane(Plane): z0 : float Location of the plane name : str - Name of the plane + Name of the plane. If not specified, the name will be the empty string. Attributes ---------- @@ -420,7 +426,8 @@ class Cylinder(Surface): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -428,7 +435,8 @@ class Cylinder(Surface): R : float Radius of the cylinder name : str - Name of the cylinder + Name of the cylinder. If not specified, the name will be the empty + string. Attributes ---------- @@ -470,7 +478,8 @@ class XCylinder(Cylinder): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -482,7 +491,8 @@ class XCylinder(Cylinder): R : float Radius of the cylinder name : str - Name of the cylinder + Name of the cylinder. If not specified, the name will be the empty + string. Attributes ---------- @@ -541,7 +551,8 @@ class YCylinder(Cylinder): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -553,7 +564,8 @@ class YCylinder(Cylinder): R : float Radius of the cylinder name : str - Name of the cylinder + Name of the cylinder. If not specified, the name will be the empty + string. Attributes ---------- @@ -612,7 +624,8 @@ class ZCylinder(Cylinder): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -624,7 +637,8 @@ class ZCylinder(Cylinder): R : float Radius of the cylinder name : str - Name of the cylinder + Name of the cylinder. If not specified, the name will be the empty + string. Attributes ---------- @@ -682,7 +696,8 @@ class Sphere(Surface): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -696,7 +711,7 @@ class Sphere(Surface): R : float Radius of the sphere name : str - Name of the sphere + Name of the sphere. If not specified, the name will be the empty string. Attributes ---------- @@ -790,7 +805,8 @@ class Cone(Surface): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -804,7 +820,7 @@ class Cone(Surface): R2 : float Parameter related to the aperature name : str - Name of the cone + Name of the cone. If not specified, the name will be the empty string. Attributes ---------- @@ -900,7 +916,8 @@ class XCone(Cone): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -914,7 +931,7 @@ class XCone(Cone): R2 : float Parameter related to the aperature name : str - Name of the cone + Name of the cone. If not specified, the name will be the empty string. Attributes ---------- @@ -945,7 +962,8 @@ class YCone(Cone): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -959,7 +977,7 @@ class YCone(Cone): R2 : float Parameter related to the aperature name : str - Name of the cone + Name of the cone. If not specified, the name will be the empty string. Attributes ---------- @@ -990,7 +1008,8 @@ class ZCone(Cone): Parameters ---------- surface_id : int - Unique identifier for the surface + Unique identifier for the surface. If not specified, an identifier will + automatically be assigned. boundary_type : {'transmission, 'vacuum', 'reflective', 'periodic'} Boundary condition that defines the behavior for particles hitting the surface. Defaults to transmissive boundary condition where particles @@ -1004,7 +1023,7 @@ class ZCone(Cone): R2 : float Parameter related to the aperature name : str - Name of the cone + Name of the cone. If not specified, the name will be the empty string. Attributes ---------- diff --git a/openmc/universe.py b/openmc/universe.py index a6226df95d..c410c9f10b 100644 --- a/openmc/universe.py +++ b/openmc/universe.py @@ -25,10 +25,10 @@ class Cell(object): Parameters ---------- - cell_id : int + cell_id : int, optional Unique identifier for the cell. If not specified, an identifier will automatically be assigned. - name : str + name : str, optional Name of the cell. If not specified, the name is the empty string. Attributes @@ -427,10 +427,11 @@ class Universe(object): Parameters ---------- - universe_id : int - Unique identifier of the universe - name : str - Name of the universe + universe_id : int, optional + Unique identifier of the universe. If not specified, an identifier will + automatically be assigned + name : str, optional + Name of the universe. If not specified, the name is the empty string. Attributes ---------- @@ -670,10 +671,11 @@ class Lattice(object): Parameters ---------- - lattice_id : int - Unique identifier for the lattice - name : str - Name of the lattice + lattice_id : int, optional + Unique identifier for the lattice. If not specified, an identifier will + automatically be assigned. + name : str, optional + Name of the lattice. If not specified, the name is the empty string. Attributes ---------- @@ -863,10 +865,11 @@ class RectLattice(Lattice): Parameters ---------- - lattice_id : int - Unique identifier for the lattice - name : str - Name of the lattice + lattice_id : int, optional + Unique identifier for the lattice. If not specified, an identifier will + automatically be assigned. + name : str, optional + Name of the lattice. If not specified, the name is the empty string. Attributes ---------- @@ -1137,10 +1140,11 @@ class HexLattice(Lattice): Parameters ---------- - lattice_id : int - Unique identifier for the lattice - name : str - Name of the lattice + lattice_id : int, optional + Unique identifier for the lattice. If not specified, an identifier will + automatically be assigned. + name : str, optional + Name of the lattice. If not specified, the name is the empty string. Attributes ----------