Commit 1cf7bf8d authored by Wysocki, Aaron's avatar Wysocki, Aaron
Browse files

Updating docstring for Model and SqLatNodal routines 

Gitlab Ticket # - 4648
parent db28817e

SubKit/build/Model.py

+6 −6
Original line number Diff line number Diff line
@@ -1360,14 +1360,14 @@ class Model: 
        """Set the code output options.



        Args:

            chanVTK (bool): Set to True to write the channel VTK file (default True).

            rodVTK (bool): Set to True to write the rod VTK file (default False).

            ctfHDF5 (bool): Set to True to write the native CTF HDF5 file (default True).

            veracsHDF5 (bool): Set to True to write the VERA-CS HDF5 file (requires that core map be specified and will only work for square rod lattices) (default False).

            chanVTK (bool): Set to True to write the channel VTK file.

            rodVTK (bool): Set to True to write the rod VTK file.

            ctfHDF5 (bool): Set to True to write the native CTF HDF5 file.

            veracsHDF5 (bool): Set to True to write the VERA-CS HDF5 file (requires that core map be specified and will only work for square rod lattices).

            chanASCII (bool): Set to True to write the ASCII channel output file.

            rodEdits (bool): Set to True to write rod edit information to the standard CTF .out file (Note the rod information in the .out file is limited in scope and it is better to get rod data from the native HDF5 file).

            dnbEdits (bool): Set  to True to produce the CTF .dnb file, which contains information about DNB (default False).

            mainTextOutput (bool): Set to True to produce the standard CTF .out file (default True).

            dnbEdits (bool): Set  to True to produce the CTF .dnb file, which contains information about DNB.

            mainTextOutput (bool): Set to True to produce the standard CTF .out file.



        """

        if chanVTK is not None:

SubKit/build/SquareLatticeLWR_Nodal.py

+8 −6
Original line number Diff line number Diff line
@@ -662,6 +662,8 @@ class SquareLatticeLWR_Nodal(CoreBuilder.Core): 
          them.  Note that whether they are modeled or not, their effect on gap size and wall friction are

          always captured in the model.  Not modeling them will save some computational time.

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

       gapWidthMult (float): Global multiplier that will be applied to all gap width values in the model.

       gapLengthMult (float): Global multiplier that will be applied to all gap lengths in the model.

    """

    def __init__(me, model, coreMap, assemMaps, pitch, dz, solidGeoms, startChanIndex=1, assemPitch=None,

                 baffleGap=0.0, sectionID=1, symOpt=1, assemLosses=None, assemLossLevels=None,
@@ -995,17 +997,17 @@ class SquareLatticeLWR_Nodal(CoreBuilder.Core): 
        Delegates setting edits to the Model instance contained in this builder.



        Args:

            chanVTK (bool): Set to True to write the channel VTK file (default True).

            rodVTK (bool): Set to True to write the rod VTK file (default False).

            ctfHDF5 (bool): Set to True to write the native CTF HDF5 file (default True).

            chanVTK (bool): Set to True to write the channel VTK file.

            rodVTK (bool): Set to True to write the rod VTK file.

            ctfHDF5 (bool): Set to True to write the native CTF HDF5 file.

            veracsHDF5 (bool): Set to True to write the VERA-CS HDF5 file

              (requires that core map be specified and will only work for square rod lattices) (default False).

              (requires that core map be specified and will only work for square rod lattices).

            chanASCII (bool): Set to True to write the ASCII channel output file.

            rodEdits (bool): Set to True to write rod edit information to the standard CTF .out file

              (Note the rod information in the .out file is limited in scope and it is better to

               get rod data from the native HDF5 file).

            dnbEdits (bool): Set  to True to produce the CTF .dnb file, which contains information about DNB (default False).

            mainTextOutput (bool): Set to True to produce the standard CTF .out file (default True).

            dnbEdits (bool): Set  to True to produce the CTF .dnb file, which contains information about DNB.

            mainTextOutput (bool): Set to True to produce the standard CTF .out file.

        """

        if veracsHDF5 == True:

            rodMap, chanMap, assemMap, symOpt = me.getChannelAndRodMaps()