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

adds additional details to set3Dpower doc strings

parent 3f1c59a7

SubKit/build/SquareLatticeLWR_Nodal.py

+15 −1
Original line number Diff line number Diff line
@@ -1013,7 +1013,19 @@ class SquareLatticeLWR_Nodal(CoreBuilder.Core): 
         coreStart (float): The axial location of the start of the core.  In CTF, the bottom of the

            model is zero.  If the core does not start at the bottom of the model, this must be provided

            so the power tables are correctly defined in CTF. [m]

         interp_type: str. One of "nearest" or "linear"

         interp_type (str): One of "nearest" or "linear".

            case nearest:

               a     bc   de         fg

               |--p--||-p-||----p----||--...

                  1     2       3

               Where the user specifies nodal power at p locations

               and a...g represent upper and lower bounds of each

               axial zone as indicated in z_power_grid. In this case:

               The power given at p1 is copied to 'a' and 'b'.

               The power at p2 is copied to 'c' and 'd'.

            case linear:

               Linear interpolation is used to obtain powers at the

               axial zone boundaries.

      """

      if len(powerDist.shape) == 3:

         me._setCorePowerShapeAsm3D(powerDist, wgts, coreStart, interp_type)
@@ -1044,6 +1056,7 @@ class SquareLatticeLWR_Nodal(CoreBuilder.Core): 
         coreStart (float): The axial location of the start of the core.  In CTF, the bottom of the

            model is zero.  If the core does not start at the bottom of the model, this must be provided

            so the power tables are correctly defined in CTF. [m]

         interp_type (str): One of "nearest" or "linear"

      """

      assert len(powerDist.shape) == 3

      assert len(me.z_power_grid.shape) == 1
@@ -1120,6 +1133,7 @@ class SquareLatticeLWR_Nodal(CoreBuilder.Core): 
         coreStart (float): The axial location of the start of the core.  In CTF, the bottom of the

            model is zero.  If the core does not start at the bottom of the model, this must be provided

            so the power tables are correctly defined in CTF. [m]

         interp_type (str): One of "nearest" or "linear"

      """

      assert len(powerDist.shape) == 4

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