Commit a3cbffc5 authored by Gurecky, William's avatar Gurecky, William
Browse files

add docstrings to axial mesh getter and setter

parent 068a023e

SubKit/build/CoreBuilder.py

+8 −1
Original line number Diff line number Diff line
@@ -62,10 +62,17 @@ class Core(object): 
  ### Core Attributes ###

   @property

   def dz(me):

      """ Mesh partition heights """

      return me._dz



   @dz.setter

   def dz(me, dz_in):

      """

      Set mesh partition heights.



      Args:

         dz_in (list of float): A list of the heights of each axial level in the core.

      """

      me._dz = np.asarray(dz_in)

      assert len(me._dz.shape) == 1

      assert np.min(me._dz) >= 0.0
@@ -113,7 +120,7 @@ class MSRE(Core): 
         a blank spot in the map.  Must be square in shape.   Provide the full symmetry map.

      sym_opt (int): Enter either 1 for full core geometry or 4 for quarter symmetry geometry.

      grBlockWidth (float): The width of a graphite block.

      dz (float): A list of the heights of each axial level in the core.

      dz (list of float): A list of the heights of each axial level in the core.

      startChanIndex (int): The channels must have an integer index when using this map builder.  This is the

         index of the first channel in the core region.

      chLen (float): The channels in the MSRE are football shaped.  This is the length of that shape [m].